Java Agent是依附于java應(yīng)用程序并能對其字節(jié)碼做相關(guān)更改的一項技術(shù)，它也是一個Jar包，但并不能獨立運行，有點像寄生蟲的感覺。當(dāng)今的許多開源工具尤其是監(jiān)控和診斷工具，很多都是基于Java Agent來實現(xiàn)的，如最近阿里剛開源的Arthas。一個Java Agent既可以在程序運行前加載(premain方式), 又可以在程序運行后加載(attach方式)。本文通過實現(xiàn)一個對Java方法耗時監(jiān)控的Agent來讓大家了解一下Java Agent的premain方式具體應(yīng)用。
首先給出測試類，如下所示，該類的代碼很簡單，最終要達到的目的就是在不修改這段代碼的情況下，能夠知道運行這段程序時每個方法的具體耗時，也就是實現(xiàn)一個Java方法耗時監(jiān)控的Agent。
MyAgentTest.java
public class MyAgentTest {
public static void main(String[] args) throws InterruptedException {
MyAgentTest mat = new MyAgentTest();
mat.test();
Thread.sleep((long)(Math.random() * 10));//隨機暫停0-10ms
}
public void test() throws InterruptedException {
System.out.println("I'm TestAgent");
Thread.sleep((long)(Math.random() * 100));//隨機暫停0-100ms
}
}
接下來就是要創(chuàng)建一個名為myagent的工程，項目結(jié)構(gòu)如下:
myagent
├── pom.xml
├── src
│ └── main
│ ├── java
│ │ └── test
│ │ ├── MyAgent.java
│ │ └── MyTransformer.java
│ └── resources
│ └── META-INF
│ └── MANIFEST.MF
從上面可以看到，項目中主要文件只有兩個java類和一個MANIFEST.MF，所以Java Agent其實也并沒有那么神秘。
先看看pom.xml這個文件，因為字節(jié)碼的相關(guān)操作要依賴于javassist這個包，所以要添加相關(guān)依賴。在默認(rèn)情況下，用maven進行打包時會覆蓋掉我們自己的MANIFEST.MF，以及不會引進依賴的jar包，所以在build中要引進maven-assembly-plugin插件并添加相關(guān)配置。
pom.xml
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.hebh.me</groupId>
<artifactId>demo-myagent</artifactId>
<version>1.0-SNAPSHOT</version>
<packaging>jar</packaging>
<name>demo-myagent Maven Webapp</name>
<url>http://www.example.com</url>
<dependencies>
<dependency>
<groupId>javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.12.1.GA</version>
</dependency>
</dependencies>
<build>
<finalName>myagent</finalName>
<plugins>
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<!--避免MANIFEST.MF被覆蓋-->
<manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
</archive>
<descriptorRefs>
<!--打包時加入依賴-->
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
</plugin>
</plugins>
</build>
</project>
接下來就是最重要MyAgent類，而premain(String args, Instrumentation inst)這個方法是關(guān)鍵，也是Agent的入口, 在方法里我們直接打印"Hi, I'm agent!"文本并添加一個自己實現(xiàn)的字節(jié)碼轉(zhuǎn)換器。
MyAgent.java
package test;
import java.lang.instrument.Instrumentation;
public class MyAgent {
public static void premain(String args, Instrumentation inst){
System.out.println("Hi, I'm agent!");
inst.addTransformer(new MyTransformer());
}
}
然后看看這個字節(jié)碼轉(zhuǎn)換器的具體實現(xiàn)，首先是要實現(xiàn)ClassFileTransformer接口，然后實現(xiàn)接口中的transform方法，jdk中源碼對該接口的說明如下
An agent provides an implementation of this interface in order to transform class files. The transformation occurs before the class is defined by the JVM
翻譯過來也就是我們可以通過實現(xiàn)該接口來在虛擬機加載類之前對字節(jié)碼進行相關(guān)更改。
對于該方法的說明文字比較多，在這里我們只需要知道該方法傳入類的所有相關(guān)信息，然后返回一個修改后的類的字節(jié)碼。要達到對方法耗時的監(jiān)控最核心的代碼在在這個方法里面，如下，首先過濾我們不關(guān)注的類，復(fù)制關(guān)注類的原方法并在執(zhí)行之前獲取時間戳，執(zhí)行后再次獲取時間戳，兩者取差值即為方法耗時，為一直觀顯示我們直接添加相關(guān)打印代碼。
MyTransformer.java
package test;
import java.lang.instrument.ClassFileTransformer;
import java.security.ProtectionDomain;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.CtNewMethod;
/**
* 檢測方法的執(zhí)行時間
*/
public class MyTransformer implements ClassFileTransformer {
final static String prefix = "\nlong startTime = System.currentTimeMillis();\n";
final static String postfix = "\nlong endTime = System.currentTimeMillis();\n";
@Override
public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined,
ProtectionDomain protectionDomain, byte[] classfileBuffer){
//java自帶的方法不進行處理
if(className.startsWith("java") || className.startsWith("sun")){
return null;
}
className = className.replace("/", ".");
CtClass ctclass = null;
try {
ctclass = ClassPool.getDefault().get(className);// 使用全稱,用于取得字節(jié)碼類<使用javassist>
for(CtMethod ctMethod : ctclass.getDeclaredMethods()){
String methodName = ctMethod.getName();
String newMethodName = methodName + "$old";// 新定義一個方法叫做比如sayHello$old
ctMethod.setName(newMethodName);// 將原來的方法名字修改
// 創(chuàng)建新的方法，復(fù)制原來的方法，名字為原來的名字
CtMethod newMethod = CtNewMethod.copy(ctMethod, methodName, ctclass, null);
// 構(gòu)建新的方法體
StringBuilder bodyStr = new StringBuilder();
bodyStr.append("{");
bodyStr.append("System.out.println(\"==============Enter Method: " + className + "." + methodName + " ==============\");");
bodyStr.append(prefix);
bodyStr.append(newMethodName + "($$);\n");// 調(diào)用原有代碼，類似于method();($$)表示所有的參數(shù)
bodyStr.append(postfix);
bodyStr.append("System.out.println(\"==============Exit Method: " + className + "." + methodName + " Cost:\" +(endTime - startTime) +\"ms " + "===\");");
bodyStr.append("}");
newMethod.setBody(bodyStr.toString());// 替換新方法
ctclass.addMethod(newMethod);// 增加新方法
}
return ctclass.toBytecode();
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
}
最后也是非常重要并且容易出錯的地方就是在resources文件夾下面創(chuàng)建META-INF文件夾，然后定義MANIFEST.MF文件，通過Premain-Class屬性來指定Agent的入口，需要注意的是冒號后面必須要有一個空格，并且最后要空出一行。
MANIFEST.MF
Manifest-Version: 1.0
Created-By: 0.0.1 (Demo Inc.)
Premain-Class: test.MyAgent
到此為止我們就已經(jīng)完成了myagent工程的所有代碼，為了使用它就必須將其打包為jar文件，用如下命令:
mvn assembly:assembly
執(zhí)行mvn命令后就可以在項目的target目錄下看到生成的myagent-jar-with-dependencies.jar文件。
然后編譯在最開始用來測試的類:
javac MyAgentTest.java
編譯后就生成了.class文件，為了方便，我們把.class文件放到和myagent-jar-with-dependencies.jar同一個目錄。
如果不使用我們的agent直接執(zhí)行java命令，效果如下:
如果在javaagent參數(shù)中加上agent，效果如下:
首先在執(zhí)行所有方法前，會執(zhí)行MyAgent的premain方法。并且可以直觀看到，MyAgentTest在運行時首先是進入main方法，然后再是test方法，執(zhí)行完test方法邏輯后退出test方法，最后退出main方法，不僅能看到每個方法的最終耗時也能看到方法執(zhí)行的軌跡。
目標(biāo)達成，完。。。
