java agent 学习

Java Agent 介绍

Java Agent 是一种特殊的 Java 程序，它能够在运行时修改或监视其他 Java 程序的行为。Java Agent 通过使用 Java Instrumentation API 实现，可以在 Java 应用程序的生命周期中，动态地对字节码进行插桩（Instrumentation）或修改，从而影响或增强应用程序的行为。Java Agent 主要用于 字节码增强、监控、性能分析、调试 等场景。

Java Agent 有两种运行模式：

启动Java程序时添加 -javaagent (Instrumentation API实现方式) 或 -agentpath/-agentlib (JVMTI的实现方式) 参数，如 java -javaagent:/data/XXX.jar LingXeTest

JDK1.6新增了attach(附加方式)方式，可以对运行中的Java进程附加Agent

其实简单来说就是一种在 JVM 启动前加载的 premain-Agent，另一种是 JVM 启动之后加载的 agentmain-Agent，不过无论是哪种 agent 都需要将其打包为 jar 包才能使用，同时还强制要求了所有的jar文件中必须包含 /META-INF/MANIFEST.MF 文件，且该文件中必须定义好Premain-Class（Agent模式）或Agent-Class（Agent模式）配置。

premain-Agent

premain 方法顾名思义，会在我们运行 main 方法之前进行调用，即在运行 main 方法之前会先去调用我们 jar 包中 Premain-Class 类中的 premain 方法

我们首先来实现一个简单的 premain-Agent，创建一个 Maven 项目，编写一个简单的 premain-Agent，创建的类需要实现 premain 方法，

import java.lang.instrument.Instrumentation;

public class permain_agent {
    public static void premain(String args, Instrumentation inst) {
            System.out.println("调用了premain-Agent");
    }
}

接着创建 MANIFEST.MF 清单文件用以指定 premain-Agent 的启动类，

Manifest-Version: 1.0  
Premain-Class: permain_agent

接着需要将其打包为 jar 包，可以使用 assembly 插件来打包，先添加 pom.xml 配置，

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <version>2.6</version>
            <configuration>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
                <archive>
                    <manifestFile>
                        src/main/resources/META-INF/MANIFEST.MF
                    </manifestFile>
                </archive>
            </configuration>
        </plugin>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-compiler-plugin</artifactId>
            <configuration>
                <source>6</source>
                <target>6</target>
            </configuration>
        </plugin>
    </plugins>
</build>

然后运行 mvn:assembly 命令

第二个就是我们需要的 permain_agent 的 jar 包。然后再创建一个目标类

public class hello {  
    public static void main(String[] args) {  
        System.out.println("Hello World!");  
    }  
}

目标类的编译同样可以用上面方法，修改 MANIFEST.MF 清单文件

Manifest-Version: 1.0  
Main-Class: hello

当然也可以直接用 idea 进行打包，最后执行

java -javaagent:agenttest-1.0-SNAPSHOT-jar-with-dependencies.jar -jar agenttest.jar

看到再 main 函数前调用了 permain 函数。

agentmain-Agent

相较于 premain-Agent 只能在 JVM 启动前加载，agentmain-Agent 能够在 JVM 启动之后加载并实现相应的修改字节码功能。下面我们来了解一下和 JVM 有关的两个类。

VirtualMachine 类

VirtualMachine 类是 Java 虚拟机工具接口（Java Virtual Machine Tool Interface，简称 JVM TI）的一部分，属于 Java 平台的一种机制，用于与正在运行的 JVM 进行交互、控制和分析。VirtualMachine 类本身并不是直接从 JVM 或 Java API 中可见的类，而是一个在 JVM 调试工具（如 jcmd、jconsole、jvisualvm）或开发工具（如某些代理和诊断工具）中用于交互的接口

该类允许我们通过给 attach 方法传入一个 JVM 的 PID，来远程连接到该 JVM 上，之后我们就可以对连接的 JVM 进行各种操作，如注入 Agent。下面是该类的主要方法

//允许我们传入一个JVM的PID，然后远程连接到该JVM上
VirtualMachine.attach()

//向JVM注册一个代理程序agent，在该agent的代理程序中会得到一个Instrumentation实例，该实例可以 在class加载前改变class的字节码，也可以在class加载后重新加载。在调用Instrumentation实例的方法时，这些方法会使用ClassFileTransformer接口中提供的方法进行处理
VirtualMachine.loadAgent()

//获得当前所有的JVM列表
VirtualMachine.list()

//解除与特定JVM的连接
VirtualMachine.detach()

VirtualMachineDescriptor 类

VirtualMachineDescriptor 是 Java 中用于表示正在运行的 Java 虚拟机（JVM）实例的类。它属于 com.sun.tools.attach 包的一部分，通常与 VirtualMachine 类一起使用。VirtualMachineDescriptor 类提供了有关虚拟机的信息，比如进程 ID (PID)、JVM 的启动类名、是否为附加到的 JVM 等。

demo，

import com.sun.tools.attach.VirtualMachine;  
import com.sun.tools.attach.VirtualMachineDescriptor;  

import java.util.List;  

pu