一、Java Agent简介
Java Agent 是从 JDK1.5 开始引入的，算是一个比较老的技术了。作为 Java 的开发工程师，我们常用的命令之一就是 java 命令，而 Java Agent 本身就是 java 命令的一个参数（即 -javaagent）。正如上一课时接入 SkyWalking Agent 那样，-javaagent 参数之后需要指定一个 jar 包，这个 jar 包需要同时满足下面两个条件：
- 在 META-INF 目录下的 MANIFEST.MF 文件中必须指定 premain-class 配置项。
- premain-class 配置项指定的类必须提供了 premain() 方法
执行main方法之前的拦截器
在 Java 虚拟机启动时，执行 main() 函数之前，虚拟机会先找到 -javaagent 命令指定 jar 包，然后执行 premain-class 中的 premain() 方法。
启动时修改
启动时修改主要是在jvm启动时，执行native函数的Agent_OnLoad方法，在方法执行时，执行如下步骤：
- 创建InstrumentationImpl对象
- 监听ClassFileLoadHook事件
- 调用InstrumentationImpl的loadClassAndCallPremain方法，在这个方法里会去调用javaagent里MANIFEST.MF里指定的Premain-Class类的premain方法
运行时修改
![]()
image
运行时修改主要是通过jvm的attach机制来请求目标jvm加载对应的agent，执行native函数的Agent_OnAttach方法，在方法执行时，执行如下步骤：
- 创建InstrumentationImpl对象
- 监听ClassFileLoadHook事件
- 调用InstrumentationImpl的loadClassAndCallAgentmain方法，在这个方法里会去调用javaagent里MANIFEST.MF里指定的Agentmain-Class类的agentmain方法
ClassFileLoadHook和TransFormClassFile
ClassFileLoadHook是一个jvmti事件，该事件是instrument agent的一个核心事件，主要是在读取字节码文件回调时调用，内部调用了TransFormClassFile函数。
TransFormClassFile的主要作用是调用java.lang.instrument.ClassFileTransformer的tranform方法，该方法由开发者实现，通过instrument的addTransformer方法进行注册。
通过以上描述可以看出在字节码文件加载的时候，会触发ClassFileLoadHook事件，该事件调用TransFormClassFile，通过经由instrument的addTransformer注册的方法完成整体的字节码修改。
对于已加载的类，需要调用retransformClass函数，然后经由redefineClasses函数，在读取已加载的字节码文件后，若该字节码文件对应的类关注了ClassFileLoadHook事件，则调用ClassFileLoadHook事件。后续流程与类加载时字节码替换一致。
综上所述实现Java Agent的步骤：
定义一个 MANIFEST.MF 文件，在其中添加 premain-class 配置项。
创建 premain-class 配置项指定的类，并在其中实现 premain() 方法，方法签名如下：
public static void premain(String agentArgs, Instrumentation inst){
...
}
将 MANIFEST.MF 文件和 premain-class 指定的类一起打包成一个 jar 包。
使用 -javaagent 指定该 jar 包的路径即可执行其中的 premain() 方法。
二、一个小栗子
需求： 基于Java Agent 的premain方法，实现动态替换或是修改某个类的定义。
Java Agent 项目
- 生成一个TestClass.class将其更名为TestClass.class.2,用于替换TestMain项目中的TestClass.class
TestClass.class.2中
public class TestClass {
public int getNumber() { return 24008; }
}
- 编写premain方法,重点是premain(String agentArgs, Instrumentation inst)
public class TestAgent {
public static void premain(String agentArgs,
Instrumentation inst) throws Exception {
System.out.println("this is a java agent with two args");
System.out.println("参数:" + agentArgs + "\n");
// 注册一个 Transformer，该 Transformer在类加载时被调用
inst.addTransformer(new org.example.Transformer(), true);
inst.retransformClasses(TestClass.class);
System.out.println("premain done");
}
public static void premain(String agentArgs) {
System.out.println("this is a java agent only one args");
System.out.println("参数:" + agentArgs + "\n");
}
}
Instrumentation 中的核心 API 方法：
addTransformer()/removeTransformer() 方法：注册/注销一个 ClassFileTransformer 类的实例，该 Transformer 会在类加载的时候被调用，可用于修改类定义。
redefineClasses() 方法：该方法针对的是已经加载的类，它会对传入的类进行重新定义。
getAllLoadedClasses()方法：返回当前 JVM 已加载的所有类。
getInitiatedClasses() 方法：返回当前 JVM 已经初始化的类。
getObjectSize()方法：获取参数指定的对象的大小。
- 编写Transformer方法，实现具体的解析替换类的逻辑
Transformer 实现了 ClassFileTransformer，其中的 transform() 方法实现可以修改加载到的类的定义
class Transformer implements ClassFileTransformer {
public byte[] transform(ClassLoader l, String className,
Class<?> c, ProtectionDomain pd, byte[] b) {
if (!c.getSimpleName().equals("TestClass")) {
return null; // 只修改TestClass的定义
}
// 读取 TestClass.class这个 class文件，作为 TestClass类的新定义
return getBytesFromFile("/Users/izaodao/Documents/IdeaProject/TestAgentNew/src/main/java/org/example/class/TestClass.class.2");
}
public static byte[] getBytesFromFile(String fileName) {
try {
// precondition
File file = new File(fileName);
InputStream is = new FileInputStream(file);
long length = file.length();
byte[] bytes = new byte[(int) length];
// Read in the bytes
int offset = 0;
int numRead = 0;
while (offset < bytes.length
&& (numRead = is.read(bytes, offset, bytes.length - offset)) >= 0) {
offset += numRead;
}
if (offset < bytes.length) {
throw new IOException("Could not completely read file "
+ file.getName());
}
is.close();
return bytes;
} catch (Exception e) {
System.out.println("error occurs in _ClassTransformer!"
+ e.getClass().getName());
return null;
}
}
}
- 添加打包maven插件及依赖
<dependency>
<groupId>org.example</groupId>
<artifactId>TestMain</artifactId>
<version>2.1-SNAPSHOT</version>
<scope>compile</scope>
</dependency>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>2.3.1</version>
<configuration>
<archive>
<manifest>
<addClasspath>true</addClasspath>
</manifest>
<manifestEntries>
<Premain-Class>
org.example.TestAgent
</Premain-Class>
<Agent-Class>org.example.TestAgent</Agent-Class>
<Can-Redefine-Classes>true</Can-Redefine-Classes>
<Can-Retransform-Classes>true</Can-Retransform-Classes>
</manifestEntries>
</archive>
</configuration>
</plugin>
- 目录结构如下
- maven 编译打包
mvn package -Dcheckstyle.skip -DskipTests
TestMain 项目
- 编写一个main方法,调用getNumber
public static void main( String[] args )
{
System.out.println("main start");
System.out.println( "Hello World!" );
System.out.println(new TestClass().getNumber());
System.out.println("main end");
}
- 配置jvm参数
-javaagent:/Users/izaodao/Documents/IdeaProject/TestAgentNew/target/TestAgentNew-1.0-SNAPSHOT.jar
- 运行结果
参考文献：
https://www.cnblogs.com/kokov/p/12120033.html
Attach API
https://www.cnblogs.com/yunfubysohu/archive/2013/05/05/3061867.html
