一文帶你瞭解Java Agent
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的類
- 解除安裝自定義類載入器遇到的一些坑