Java Agent概述
Java Agent是一种特殊类型的软件组件，它允许在Java虚拟机（JVM）运行时修改应用程序的字节码。这种技术通常用于性能监控、日志记录、系统调试等。Java Agent主要分为两类：
1. 启动时加载的Agent（Pre-Main Agent）
这种类型的Agent在应用程序的主方法（main）执行之前加载。它们通常用于在应用程序启动时进行一些预处理，例如初始化日志框架、植入一些监控代码等。
如何实现：
- 在Agent代码中，你需要实现一个带有特定签名的
premain方法。这个方法是由JVM在启动时自动调用的。 premain方法的签名必须是：public static void premain(String agentArgs, Instrumentation inst)。agentArgs是传递给Agent的任何参数。inst是一个java.lang.instrument.Instrumentation实例，它提供了操作字节码的接口。
代码示例：
java 复制代码import java.lang.instrument.Instrumentation;
public class MyAgent {
public static void premain(String agentArgs, Instrumentation inst) {
System.out.println("Executing premain.........");
// 这里可以进行字节码操纵或其他初始化任务
}
}
如何使用：
- 将上述Agent编译成JAR文件，并在JAR的
MANIFEST.MF文件中指定Premain-Class属性。 - 使用
-javaagent标志启动你的Java应用程序，指定Agent JAR文件。
例如，在MANIFEST.MF中：
Premain-Class: MyAgent
启动Java应用时的命令行：
bash 复制代码java -javaagent:path/to/agent.jar -jar myapp.jar
2. 运行时加载的Agent（Agent-On-Load）
这种Agent可以在JVM运行时动态加载和附加，通常用于对正在运行的应用程序进行监控和修改。
如何实现：
- 在Agent代码中，你需要实现一个带有特定签名的
agentmain方法。这个方法在Agent被动态加载到JVM时由JVM调用。 agentmain方法的签名必须是：public static void agentmain(String agentArgs, Instrumentation inst)。
代码示例：
java 复制代码import java.lang.instrument.Instrumentation;
public class MyRuntimeAgent {
public static void agentmain(String agentArgs, Instrumentation inst) {
System.out.println("Executing agentmain.........");
// 这里可以进行字节码操纵或其他任务
}
}
如何使用：
- 编译Agent代码并打包成JAR文件，指定
Agent-Class属性在MANIFEST.MF文件。 - 使用特定的工具（如
attach API）在运行时将Agent加载到目标JVM。
在MANIFEST.MF中：
Agent-Class: MyRuntimeAgent
动态加载Agent（使用attach API的示例）：
import com.sun.tools.attach.VirtualMachine;
public class AttachExample {
public static void main(String[] args) throws Exception {
VirtualMachine vm = VirtualMachine.attach("targetJvmPid");
vm.loadAgent("path/to/agent.jar", "optionalAgentArgs");
vm.detach();
}
}
在上述代码中，targetJvmPid是你想要附加的JVM的进程ID。
path/to/agent.jar : 这是Java Agent的JAR文件的路径。在实际使用中，你需要将其替换为实际的Agent JAR文件的路径。例如，如果你的Agent JAR文件名为myagent.jar并且位于当前目录下，那么这部分应该替换为myagent.jar。
optionalAgentArgs:这是传递给Agent的可选参数。这个字符串将作为参数传递给Agent的agentmain方法。如果你的Agent不需要任何参数，这部分可以为空字符串或者完全省略。
这些示例提供了如何实现和使用这两种类型的Java Agent的基本方法。实际应用中，你可能会根据需求在Agent中进行更复杂的操作，例如使用ASM或Javassist库进行字节码操作。
使用ASM进行字节码操作
在一个Java Agent中使用ASM进行字节码操作通常涉及以下步骤：
- 实现一个ClassFileTransformer：这个类将用来修改类的字节码。
- 注册这个Transformer到Instrumentation对象：在
premain或agentmain方法中。
代码示例：
java 复制代码import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;
public class MyAgent {
public static void premain(String agentArgs, Instrumentation inst) {
inst.addTransformer(new MyClassFileTransformer());
}
static class MyClassFileTransformer implements ClassFileTransformer {
@Override
public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {
// 使用ASM API修改类字节码
// 返回新的字节码数组，或者如果没有修改，则返回null
return null;
}
}
}
在上面的代码中，你需要使用ASM的API来修改classfileBuffer（类的字节码数组）。
使用Javassist进行字节码操作
使用Javassist进行字节码操作通常更加简单，因为它允许以接近Java源代码的形式修改类。
代码示例：
java 复制代码import java.lang.instrument.ClassFileTransformer;
import java.lang.instrument.Instrumentation;
import java.security.ProtectionDomain;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
public class MyAgent {
public static void premain(String agentArgs, Instrumentation inst) {
inst.addTransformer(new MyClassFileTransformer());
}
static class MyClassFileTransformer implements ClassFileTransformer {
@Override
public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) {
if (className.equals("my/target/ClassName")) {
try {
ClassPool cp = ClassPool.getDefault();
CtClass cc = cp.get("my.target.ClassName");
CtMethod m = cc.getDeclaredMethod("myMethod");
m.insertBefore("{ System.out.println(\"Method called\"); }");
byte[] byteCode = cc.toBytecode();
cc.detach();
return byteCode;
} catch (Exception e) {
e.printStackTrace();
}
}
return null;
}
}
}
在上面的示例中，我们修改了名为my.target.ClassName的类，并在其myMethod方法开始前插入了一行打印语句。Javassist使得修改字节码更接近于编写普通的Java代码。
总结
Java Agent提供了一种强大的机制来在运行时修改和增强Java应用程序。ASM和Javassist是两个常用的库，用于实现Java Agent中的字节码操作。ASM提供了更低层次的控制，而Javassist则提供了更简单、更直观的方式来处理字节码。选择使用哪个库取决于具体的需求和对字节码操作的熟悉程度。通过这些工具，可以实现诸如性能监控、日志记录、动态代码修改等高级功能。
https://juejin.cn/post/7309775437942669322
标签：java,字节,代码,Agent,Java,public,作用 From： https://www.cnblogs.com/softidea/p/17887023.html