前提概要

• Java調(diào)式、熱部署、JVM背后的支持者Java Agent：

  • 各個 Java IDE 的調(diào)試功能，例如 eclipse、IntelliJ ；

  • 熱部署功能，例如 JRebel、XRebel、spring-loaded；

  • 各種線上診斷工具，例如 Btrace、Greys，還有阿里的 Arthas；

  • 各種性能分析工具，例如 Visual VM、JConsole 等；

Agent的介紹

Java Agent 直譯過來叫做 Java 代理，還有另一種稱呼叫做 Java 探針。首先說 Java Agent 是一個 jar 包，只不過這個 jar 包不能獨立運行，它需要依附到我們的目標(biāo) JVM 進程中。我們來理解一下這兩種叫法。

• 代理：比方說我們需要了解目標(biāo) JVM 的一些運行指標(biāo)，我們可以通過 Java Agent 來實現(xiàn)，這樣看來它就是一個代理的效果，我們最后拿到的指標(biāo)是目標(biāo) JVM ,但是我們是通過 Java Agent 來獲取的，對于目標(biāo) JVM 來說，它就像是一個代理；

• 探針：這個說法我感覺非常形象，JVM 一旦跑起來，對于外界來說，它就是一個黑盒。而 Java Agent 可以像一支針一樣插到 JVM 內(nèi)部，探到我們想要的東西，并且可以注入東西進去。

  • 拿IDEA調(diào)試器來說吧，當(dāng)開啟調(diào)試功能后，在debugger面板中可以看到當(dāng)前上下文變量的結(jié)構(gòu)和內(nèi)容，還可以在watches面板中運行一些簡單的代碼，比如取值賦值等操作。

  • 還有Btrace、Arthas這些線上排查問題的工具，比方說有接口沒有按預(yù)期的返回結(jié)果，但日志又沒有錯誤。這時，我們只要清楚方法的所在包名、類名、方法名等，不用修改部署服務(wù)，就能查到調(diào)用的參數(shù)、返回值、異常等信息。

  • 上面只是說到了探測的功能，而熱部署功能那就不僅僅是探測這么簡單了。熱部署的意思就是說再不重啟服務(wù)的情況下，保證最新的代碼邏輯在服務(wù)生效。當(dāng)我們修改某個類后，通過 Java Agent 的 instrument 機制，把之前的字節(jié)碼替換為新代碼所對應(yīng)的字節(jié)碼。

Java Agent 結(jié)構(gòu)

Java Agent 最終以 jar 包的形式存在。主要包含兩個部分，一部分是實現(xiàn)代碼，一部分是配置文件。配置文件放在 META-INF 目錄下，文件名為 MANIFEST.MF 。

包括以下配置項：

Manifest-Version: 版本號
Created-By: 創(chuàng)作者
Agent-Class: agentmain方法所在類
Can-Redefine-Classes: 是否可以實現(xiàn)類的重定義
Can-Retransform-Classes: 是否可以實現(xiàn)字節(jié)碼替換
Premain-Class: premain 方法所在類

入口類實現(xiàn) agentmain 和 premain 兩個方法即可，方法要實現(xiàn)什么功能就由你的需求決定了。

Java Agent 實現(xiàn)和使用

接下來就來實現(xiàn)一個簡單的 Java Agent，基于 Java 1.8，主要實現(xiàn)兩點簡單的功能：

1. 打印當(dāng)前加載的所有類的名稱；

2. 監(jiān)控一個特定的方法，在方法中動態(tài)插入簡單的代碼并獲取方法返回值；

3. 在方法中插入代碼主要是用到了字節(jié)碼修改技術(shù)，字節(jié)碼修改技術(shù)主要有 javassist、ASM，已經(jīng) ASM 的高級封裝可擴展 cglib，這個例子中用的是 javassist。所以需要引入相關(guān)的 maven 包。

<dependency>
    <groupId>javassist</groupId>
    <artifactId>javassist</artifactId>
    <version>3.12.1.GA</version>
</dependency>

實現(xiàn)入口類和功能邏輯

入口類上面也說了，要實現(xiàn) agentmain 和 premain 兩個方法。

• 這兩個方法的運行時機不一樣。這要從 Java Agent 的使用方式來說了，Java Agent 有兩種啟動方式，一種是以 JVM 啟動參數(shù) -javaagent:xxx.jar 的形式隨著 JVM 一起啟動，這種情況下，會調(diào)用 premain方法，并且是在主進程的 main方法之前執(zhí)行。

• 另外一種是以 loadAgent 方法動態(tài) attach 到目標(biāo) JVM 上，這種情況下，會執(zhí)行 agentmain方法。

public static void premain(String agentArgs, Instrumentation inst)
public static void premain(String agentArgs)

JVM 會優(yōu)先加載 帶 Instrumentation 簽名的方法，加載成功忽略第二種，如果第一種沒有，則加載第二種方法。Instrumentation是一個重要的參數(shù)。

在 Java SE 6 的 Instrumentation 當(dāng)中，提供了一個新的代理操作方法：agentmain，可以在 main 函數(shù)開始運行之后再運行，跟premain函數(shù)一樣， 開發(fā)者可以編寫一個含有agentmain函數(shù)的 Java 類。

• 采用attach機制，被代理的目標(biāo)程序VM有可能很早之前已經(jīng)啟動，當(dāng)然其所有類已經(jīng)被加載完成，這個時候需要借助Instrumentation#retransformClasses(Class<?>... classes)

讓對應(yīng)的類可以重新轉(zhuǎn)換，從而激活重新轉(zhuǎn)換的類執(zhí)行ClassFileTransformer列表中的回調(diào)

public static void agentmain (String agentArgs, Instrumentation inst)
public static void agentmain (String agentArgs)

agentMain 主要用于對java程序的監(jiān)控，調(diào)用java進程，將自己編寫的agentMain 注入目標(biāo)完成對程序的監(jiān)控，修改。

代碼實現(xiàn)如下：

import java.lang.instrument.Instrumentation;

public class MyCustomAgent {
    /**
     * jvm 參數(shù)形式啟動，運行此方法
     * @param agentArgs
     * @param inst
     */
    public static void premain(String agentArgs, Instrumentation inst){
        System.out.println("premain");
        customLogic(inst);
    }

    /**
     * 動態(tài) attach 方式啟動，運行此方法
     * @param agentArgs
     * @param inst
     */
    public static void agentmain(String agentArgs, Instrumentation inst){
        System.out.println("agentmain");
        customLogic(inst);
    }

    /**
     * 打印所有已加載的類名稱
     * 修改字節(jié)碼
     * @param inst
     */
    private static void customLogic(Instrumentation inst){
        inst.addTransformer(new MyTransformer(), true);
        Class[] classes = inst.getAllLoadedClasses();
        for(Class cls :classes){
            System.out.println(cls.getName());
        }
    }
}

• 我們看到這兩個方法都有參數(shù)agentArgs和inst，其中 agentArgs 是我們啟動 Java Agent 時帶進來的參數(shù)，比如-javaagent:xxx.jar agentArgs。

• Instrumentation Java開放出來的專門用于字節(jié)碼修改和程序監(jiān)控的實現(xiàn)。我們要實現(xiàn)的打印已加載類和修改字節(jié)碼也就是基于它來實現(xiàn)的。其中 inst.getAllLoadedClasses()一個方法就實現(xiàn)了獲取所以已加載類的功能。

inst.addTransformer方法則是實現(xiàn)字節(jié)碼修改的關(guān)鍵，后面的參數(shù)就是實現(xiàn)字節(jié)碼修改的實現(xiàn)類，代碼如下：

public class MyTransformer implements ClassFileTransformer {
    @Override
    public byte[] transform(ClassLoader loader, String className, Class<?> classBeingRedefined, ProtectionDomain protectionDomain, byte[] classfileBuffer) throws IllegalClassFormatException {
        System.out.println("正在加載類："+ className);
        if (!"kite/attachapi/Person".equals(className)){
            return classfileBuffer;
        }
        CtClass cl = null;
        try {
            ClassPool classPool = ClassPool.getDefault();
            cl = classPool.makeClass(new ByteArrayInputStream(classfileBuffer));
            CtMethod ctMethod = cl.getDeclaredMethod("test");
            System.out.println("獲取方法名稱："+ ctMethod.getName());
            ctMethod.insertBefore("System.out.println(\" 動態(tài)插入的打印語句 \");");
            ctMethod.insertAfter("System.out.println($_);");
            byte[] transformed = cl.toBytecode();
            return transformed;
        }catch (Exception e){
            e.printStackTrace();
        }
        return classfileBuffer;
    }
}

以上代碼的邏輯就是當(dāng)碰到加載的類是 kite.attachapi.Person的時候，在其中的 test 方法開始時插入一條打印語句，打印內(nèi)容是"動態(tài)插入的打印語句"，在test方法結(jié)尾處，打印返回值，其中$_ 就是返回值，這是 javassist 里特定的標(biāo)示符。

MANIFEST.MF 配置文件

在目錄 resources/META-INF/ 下創(chuàng)建文件名為 MANIFEST.MF 的文件，在其中加入如下的配置內(nèi)容：

Manifest-Version: 1.0
Created-By: fengzheng
Agent-Class: kite.lab.custom.agent.MyCustomAgent
Can-Redefine-Classes: true
Can-Retransform-Classes: true
Premain-Class: kite.lab.custom.agent.MyCustomAgent

配置打包所需的 pom 設(shè)置

最后 Java Agent 是以 jar 包的形式存在，所以最后一步就是將上面的內(nèi)容打到一個 jar 包里。

在 pom 文件中加入以下配置

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <configuration>
                <archive>
                    <manifestFile>src/main/resources/META-INF/MANIFEST.MF</manifestFile>
                </archive>
                <descriptorRefs>
                    <descriptorRef>jar-with-dependencies</descriptorRef>
                </descriptorRefs>
            </configuration>
        </plugin>
    </plugins>
</build>

• 用的是 maven 的 maven-assembly-plugin 插件，注意其中要用 manifestFile 指定 MANIFEST.MF 所在路徑，然后指定 jar-with-dependencies ，將依賴包打進去。

• 上面這是一種打包方式，需要單獨的 MANIFEST.MF 配合，還有一種方式，不需要在項目中單獨的添加 MANIFEST.MF 配置文件，完全在 pom 文件中配置上即可。

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-assembly-plugin</artifactId>
            <executions>
                <execution>
                    <goals>
                        <goal>attached</goal>
                    </goals>
                    <phase>package</phase>
                    <configuration>
                        <descriptorRefs>
                            <descriptorRef>jar-with-dependencies</descriptorRef>
                        </descriptorRefs>
                        <archive>
                            <manifestEntries>
                                <Premain-Class>kite.agent.vmargsmethod.MyAgent</Premain-Class>
                                <Agent-Class>kite.agent.vmargsmethod.MyAgent</Agent-Class>
                                <Can-Redefine-Classes>true</Can-Redefine-Classes>
                                <Can-Retransform-Classes>true</Can-Retransform-Classes>
                            </manifestEntries>
                        </archive>
                    </configuration>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

這種方式是將 MANIFEST.MF 的內(nèi)容全部寫作 pom 配置中，打包的時候就會自動將配置信息生成 MANIFEST.MF 配置文件打進包里。

添加maven插件指定javaagent類，maven自動完成manifest配置，不用自己再去配置推薦

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-jar-plugin</artifactId>
        <version>3.1.0</version>
        <configuration>
            <archive>
            <!--自動添加META-INF/MANIFEST.MF -->
            <manifest>
                <addClasspath>true</addClasspath>
            </manifest>
            <manifestEntries>
                <Premain-Class>com.rickiyang.learn.PreMainTraceAgent</Premain-Class>
                <Agent-Class>com.rickiyang.learn.PreMainTraceAgent</Agent-Class>
                <Can-Redefine-Classes>true</Can-Redefine-Classes>
                <Can-Retransform-Classes>true</Can-Retransform-Classes>
            </manifestEntries>
            </archive>
        </configuration>
</plugin>

MANIFEST.MF參數(shù)說明

• Premain-Class ：包含 premain 方法的類（類的全路徑名）main方法運行前代理
• Agent-Class ：包含 agentmain 方法的類（類的全路徑名）另一種代理main開始后可以修改類結(jié)構(gòu)
• Boot-Class-Path ：設(shè)置引導(dǎo)類加載器搜索的路徑列表。查找類的特定于平臺的機制失敗后，引導(dǎo)類加載器會搜索這些路徑。按列出的順序搜索路徑。列表中的路徑由一個或多個空格分開。路徑使用分層 URI 的路徑組件語法。如果該路徑以斜杠字符（“/”）開頭，則為絕對路徑，否則為相對路徑。相對路徑根據(jù)代理 JAR 文件的絕對路徑解析。忽略格式不正確的路徑和不存在的路徑。如果代理是在 VM 啟動之后某一時刻啟動的，則忽略不表示 JAR 文件的路徑。（可選）說白就是agent依賴的類
• Can-Redefine-Classes ：true表示能重定義此代理所需的類，默認(rèn)值為 false（可選）
• Can-Retransform-Classes ：true 表示能重轉(zhuǎn)換此代理所需的類，默認(rèn)值為 false （可選）
• Can-Set-Native-Method-Prefix： true表示能設(shè)置此代理所需的本機方法前綴，默認(rèn)值為 false（可選）

運行打包命令

接下來就簡單了，執(zhí)行一條 maven 命令即可。

mvn assembly:assembly

最后打出來的 jar 包默認(rèn)是以「項目名稱-版本號-jar-with-dependencies.jar」這樣的格式生成到 target 目錄下。

運行打包好的 Java Agent

寫個的測試項目，用來作為目標(biāo) JVM，稍后會以兩種方式將 Java Agent 掛到這個測試項目上。

import java.util.Scanner;

public class RunJvm {

    public static void main(String[] args){
        System.out.println("按數(shù)字鍵 1 調(diào)用測試方法");
        while (true) {
            Scanner reader = new Scanner(System.in);
            int number = reader.nextInt();
            if(number==1){
                Person person = new Person();
                person.test();
            }
        }
    }
}

以上只有一個簡單的 main 方法，用 while 的方式保證線程不退出，并且在輸入數(shù)字 1 的時候，調(diào)用 person.test()方法。

以下是 Person 類

public class Person {
    public String test(){
        System.out.println("執(zhí)行測試方法");
        return "I'm ok";
    }
}

以命令行的方式運行

java -javaagent:agent1.jar -javaagent:agent2.jar -jar MyProgram.jar

-javaagent:/java-agent路徑/lab-custom-agent-1.0-SNAPSHOT-jar-with-dependencies.jar

然后直接運行就可以看到效果了，會看到加載的類名稱。然后輸入數(shù)字鍵 "1"，會看到字節(jié)碼修改后的內(nèi)容。

以動態(tài) attach 的方式運行

測試之前先要把這個測試項目跑起來，并把之前的參數(shù)去掉。運行后，找到這個它的進程id，一般利用jps -l即可。

動態(tài) attach 的方式是需要代碼實現(xiàn)的，實現(xiàn)代碼如下：

public class AttachAgent {
    public static void main(String[] args) throws Exception{
        VirtualMachine vm = VirtualMachine.attach("pid(進程號)");
        vm.loadAgent("java-agent路徑/lab-custom-agent-1.0-SNAPSHOT-jar-with-dependencies.jar");
    }
}

運行上面的 main 方法 并在測試程序中輸入“1”，會得到上圖同樣的結(jié)果。

發(fā)現(xiàn)了沒，我們到這里實現(xiàn)的簡單的功能是不是和 BTrace 和 Arthas 有點像呢。我們攔截了指定的一個方法，并在這個方法里插入了代碼而且拿到了返回結(jié)果。如果把方法名稱變成可配置項，并且把返回結(jié)果保存到一個公共位置，例如一個內(nèi)存數(shù)據(jù)庫，是不是我們就可以像 Arthas 那樣輕松的檢測線上問題了呢。當(dāng)然了，Arthas 要復(fù)雜的多，但原理是一樣的。

sun.management.Agent 的實現(xiàn)

不知道你平時有沒有用過 visualVM 或者 JConsole 之類的工具，其實，它們就是用了 management-agent.jar 這個Java Agent 來實現(xiàn)的。如果我們希望 Java 服務(wù)允許遠程查看 JVM 信息，往往會配置上一下這些參數(shù)：

-Dcom.sun.management.jmxremote
-Djava.rmi.server.hostname=192.168.1.1
-Dcom.sun.management.jmxremote.port=9999
-Dcom.sun.management.jmxremote.rmi.port=9999
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false

這些參數(shù)都是 management-agent.jar 定義的。

我們進到 management-agent.jar 包下，看到只有一個 MANIFEST.MF 配置文件，配置內(nèi)容為：

Manifest-Version: 1.0
Created-By: 1.7.0_07 (Oracle Corporation)
Agent-Class: sun.management.Agent
Premain-Class: sun.management.Agent

可以看到入口 class 為 sun.management.Agent，進到這個類里面可以找到 agentmain 和 premain，并可以看到它們的邏輯。在這個類的開始，能看到我們前面對服務(wù)開啟遠程 JVM 監(jiān)控需要開啟的那些參數(shù)定義。