Java Agent這個技術,對于大多數同學來說都比較陌生,但是多多少少又接觸過,實際上,我們平時用的很多工具,都是基于Java Agent實現的,例如常見的熱部署JRebel,各種線上診斷工具(btrace, greys),還有阿里最近開源的arthas。
其實Java Agent一點都不神秘,也是一個Jar包,只是啟動方式和普通Jar包有所不同,對于普通的Jar包,通過指定類的main函數進行啟動,但是Java Agent并不能單獨啟動,必須依附在一個Java應用程序運行,有點像寄生蟲的感覺。
如何動手寫一個Java Agent
因為Java Agent的特殊性,需要一些特殊的配置,在META-INF目錄下創建MANIFEST文件.
并在MANIFEST文件中指定Agent的啟動類
這里需要解釋下為什么要指定Agent-Class
和Premain-Class
,在加載Java Agent之后,會找到Agent-Class
或者Premain-Class
指定的類,并運行對應的agentmain
或者premain
方法。
/**
* 以vm參數的方式載入,在Java程序的main方法執行之前執行
*/
public static void premain(String agentArgs, Instrumentation inst);
/**
* 以Attach的方式載入,在Java程序啟動后執行
*/
public static void agentmain(String agentArgs, Instrumentation inst);
如果不想手動創建MANIFEST文件,也可以通過Maven配置,在打包的時候自動生成,具體配置可以參數下面。
<plugin>
<artifactId>maven-assembly-plugin</artifactId>
<configuration>
<archive>
<manifestEntries>
<Premain-Class>com.dianping.rhino.agent.AgentBoot</Premain-Class>
<Agent-Class>com.dianping.rhino.agent.AgentBoot</Agent-Class>
<Can-Redefine-Classes>true</Can-Redefine-Classes>
<Can-Retransform-Classes>true</Can-Retransform-Classes>
</manifestEntries>
</archive>
</configuration>
</plugin>
所以,我們需要在agentmain
或者premain
方法中實現具體的Agent邏輯,這里是你大顯身手的地方,讀取JVM的各種數據,修改類的字節碼,只要你能想到的,一般都可以實現。
如何加載 Java Agent
前面說了,一個Java Agent既可以在程序運行前加載,也可以在程序運行后加載,兩者有什么區別呢?
程序運行前加載
通過JVM參數-javaagent:**.jar
啟動,程序啟動的時候,會優先加載Java Agent,并執行其premain
方法,這個時候,其實大部分的類都還沒有被加載,這個時候可以實現對新加載的類進行字節碼修改,但是如果premain
方法執行失敗或拋出異常,那么JVM會被中止,這是很致命的問題。
程序運行后加載
程序啟動之后,通過某種特定的手段加載Java Agent,這個特定的手段就是VirtualMachine
的attach api
,這個api其實是JVM進程之間的的溝通橋梁,底層通過socket進行通信,JVM A可以發送一些指令給JVM B,B收到指令之后,可以執行對應的邏輯,比如在命令行中經常使用的jstack、jcmd、jps等,很多都是基于這種機制實現的。
因為是進程間通信,所以使用attach api
的也是一個獨立的Java進程,下面是一個簡單的實現。
// 15186表示目標進程的PID
VirtualMachine vm = VirtualMachine.attach("15186");
try {
// 指定Java Agent的jar包路徑
vm.loadAgent(".../agent.jar");
} finally {
vm.detach();
}
首先,我們得知道目標進程的PID,這個可以通過jps指令方便得到,也可以通過VirtualMachine
的list方法拿到本機所有Java進程的PID。通過attach
連接上目標PID之后,可以獲得表示目標進程的vm對象,執行loadAgent
方法,對應的Java Agent會被加載,然后會找到指定的入口類,并執行agentmain方法,如果執行出現普通異常(除了oom和其它致命異常),目標JVM并不會受到影響。
通過這種方式,可以實現動態的加載Java Agent,而不需要修改JVM啟動參數。
Java Agent 后續內容
- attach api 的實現原理
-
agentmain
和premain
方法中的Instrumentation參數是什么? - 如何自定義類加載器,避免污染目前進程
- 如何實現字節碼的修改
- 如何實現字節碼的多次修改
- 如何恢復被修改過的字節碼
- 如何卸載Java Agent的類
- 卸載自定義類加載器遇到的一些坑