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