Java Agent 开发初探

FunTester

发布于 2025-01-23 07:53:27

10100

代码可运行

文章被收录于专栏：FunTesterFunTester

运行总次数：0

代码可运行

Java Agent 概况

简介和功能

Java Agent是一种特殊的Java程序，允许开发者在 Java 应用程序运行时对其进行动态修改和监控的机制。它利用了 Java 虚拟机（JVM）的 java.lang.instrument 包提供的功能，可以在类加载时或运行时对字节码进行修改。这种技术通常用于性能监控、安全检测、调试和诊断等场景。

Java Agent 主要功能如下：

字节码增强：在类加载时或运行时动态修改类的字节码，以添加新的功能或改变现有行为。
性能监控：收集应用程序运行时的性能数据，如方法调用频率、执行时间等。
安全检查：在类加载时对类进行安全检查，确保其符合特定的安全策略。
调试和诊断：在不修改应用程序源代码的情况下，插入调试和诊断代码，以帮助开发和排查问题。

应用场景

Java Agent的应用场景非常广泛，以下是一些常见的使用案例：

性能监控：通过插入监控代码来收集应用程序的性能数据，例如方法调用时间、内存使用情况等。
安全性检查：在运行时动态地检查和加固应用程序，防止安全漏洞。
调试与诊断：在不修改源代码的情况下，为应用程序添加日志输出或调试信息。
动态AOP（面向切面编程）：实现在运行时动态地插入切面逻辑，而无需在编译时进行代码修改。

那么，我们如何开发一个 Java Agent 呢，下面我们来仔细说说。

开发 Java Agent

Java Agent 通过实现 java.lang.instrument.ClassFileTransformer 接口，并将其注册到 Instrumentation 对象中，可以在类加载时对类的字节码进行修改。Instrumentation 对象是在 JVM 启动时由 Java Agent 提供的，可以通过 premain 方法获取。开发 Java Agent 需要遵循一下规范，下面是几个必备的部分：

实现 `premain` 方法

premain 方法是 Java Agent 的入口点，类似于主程序的 main 方法。它在 JVM 启动时被调用，并传递 Instrumentation 对象。

 import java.lang.instrument.Instrumentation;

 public class MyAgent {
  public static void premain(String agentArgs, Instrumentation inst) {
// 注册 ClassFileTransformer
inst.addTransformer(new MyClassFileTransformer());
  }
 }

实现 `ClassFileTransformer` 接口

ClassFileTransformer 接口的 transform 方法在每个类加载时被调用，可以在这里对类的字节码进行修改。我们也可以创建一个 Java Agent 而不实现 ClassFileTransformer 接口，而是只实现两个方法：premain 和（可选的）agentmain。这样，你仍然可以使用 Java Agent 的一些基本功能，例如在 JVM 启动时执行某些初始化代码或在运行时加载 Agent。

 import java.lang.instrument.ClassFileTransformer;
 import java.lang.instrument.IllegalClassFormatException;
 import java.security.ProtectionDomain;

 public class MyClassFileTransformer implements ClassFileTransformer {
  @Override
  public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
  ProtectionDomain protectionDomain, byte[] classfileBuffer)
  throws IllegalClassFormatException {
// 这里可以对 classfileBuffer 进行修改
System.out.println("Loading class: " + className);
return classfileBuffer;
  }
 }

打包 Java Agent

Java Agent 要求 JAR 包的 MANIFEST.MF 文件中要有 Premain-Class 属性，不切指定 Agent 类。通常我们使用 Maven 打包工具来完成，下面是个例子（篇幅限制，只展示了 build 不分）：

    <build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-jar-plugin</artifactId>
                <version>3.2.0</version>
                <configuration>
                    <archive>
                        <manifestEntries>
                            <Premain-Class>com.example.MyAgent</Premain-Class>
                            <Agent-Class>com.example.MyAgent</Agent-Class>
                            <Can-Redefine-Classes>true</Can-Redefine-Classes>
                            <Can-Retransform-Classes>true</Can-Retransform-Classes>
                        </manifestEntries>
                    </archive>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

使用 Java Agent

使用 -javaagent 参数来加载 Java Agent。

 java -javaagent:MyAgent.jar -jar YourApp.jar

还有一种动态加载的方式，使用 attack API 来完成。

String pid = ...; // 获取目标JVM的进程ID
VirtualMachine vm = VirtualMachine.attach(pid);
vm.loadAgent("/path/to/MyAgent.jar");
vm.detach();

代码解释：

获取目标 JVM 的进程 ID：首先，需要获取目标 JVM 进程的 PID（进程 ID）。可以通过 JMX、jps 命令或其他方法获取。
附加到目标 JVM：使用 VirtualMachine.attach(pid) 方法附加到目标 JVM 进程。这个方法返回一个 VirtualMachine 对象，该对象代表目标 JVM。
加载 Java Agent：使用 VirtualMachine 对象的 loadAgent 方法加载 Java Agent。传递 Java Agent JAR 文件的路径，这会在目标 JVM 中执行该 Agent。
分离：加载完 Agent 后，通过 VirtualMachine 对象的 detach 方法分离当前 JVM 与目标 JVM 的连接，确保操作完成并释放资源。