不重啟JVM動態添加日志（阿里Arthas）

一、背景

如果生產環境臨時出現故障，但是現運行代碼未列印定位問題所需要的日志，我們通常的做法是添加日志->重新發布->重現故障，但是這樣麻煩不說，最重要的是重啟節點會丟失現場，也不一定能重現問題，所以我們希望找到一個不重啟應用，能夠動態增加日志的方法，

二、目的與實作

物件是以類為模板創建的，每個類的普通非靜態屬性都是私有的，但是行為(方法)是共有的，類加載之后，類的行為存盤在方法區，我們首先修改原始碼(比如增加日志)，然后重新編譯生成位元組碼檔案，再讓jvm重新加載該位元組碼，這樣該類創建的所有物件的對應行為也就改變了，并且已經創建的物件本身的屬性和狀態不會改變，

重新編譯位元組碼很簡單，我們主要需要考慮的是如何讓jvm在不重啟的前提下重新加載位元組碼檔案，

2.1 Agent和Instrumentation

JDK在1.5之后新增了用instrument 做動態 Instrumentation的特性，開發者能利用Instrumentation構建一個獨立于應用程式的代理程式，可以監測虛擬機、在位元組碼檔案加載之前添加自定義代理實作AOP或者注冊ClassFileTransformer以修改原位元組碼內容等，我們可以在一個普通 Java 程式運行時，通過-javaagent引數指定一個的 jar 檔案（Agent）來啟動代理程式（或者配置JVM啟動引數），簡單說來分為以下幾個步驟：

2.1.1 撰寫Agent程式

Agent主程式就是撰寫一個 Java 類，需要包含以下兩個方法中的任何一個：

[1].public static void premain(String agentArgs, Instrumentation inst);
[2].public static void premain(String agentArgs);

如果[1]和[2]同時存在，那么[2]將不會生效，該方法會在主程式main方法運行之前運行，通過Instrumentation，可以重新定義位元組碼內容，

2.1.2 生成jar包

將這個Agent程式打包成一個 jar 檔案，并在MANIFEST.MF當中加入"Premain-Class"來指定上一步驟當中包含premain方法的Java 類，

2.1.3 運行主程式時添加Agent代理

在java命令列或者JVM啟動引數配置-javaagent，比如：-javaagent:Agent.jar=param1=1&param2=2，其中param1和param2為傳入premain方法的引數，需要自己決議，

關于Agent premain，可以做很多有意義的事，比如在位元組碼加載之前重定義內容（依賴Instrumentation），這篇文章Java專案安全發布--Jar包（class）加解密實踐就是利用的此特性，感興趣的朋友可以研究一下，

2.2 Attach機制

前面內容介紹了premain，我們可以在主程式運行之前添加代理程式，而且只能在主程式運行之前設定，這就存在一定的局限性，如果我們啟動主程式時沒有指定代理程式，那么就無法使用Instrumentation，

不過好在JDK1.6之后，這種情況得到了改善，我們可以在主程式開始執行以后，再啟動自己的代理程式，這就依賴于Sun提供的一套擴展 API：Attach，

Attach是sun提供的一個擴展API，可以通過它向一個JVM“附著”一個代理程式，步驟如下：

1> 獲取JVM行程id

可通過JPS查看或者呼叫VirtualMachine.list()列舉出運行的所有JVM

2> 附著到指定pid的JVM

通過VirtualMachine.attach(pid)實作（靜態方法）

3> 注冊代理程式

通過VirtualMachine.loadAgent(jar)實作，其中VirtualMachine代表目標JVM行程，jar即我們的代理程式

4> 解除附著

通過VirtualMachine.detach()實作，其中VirtualMachine代表目標VM行程

借助Attach機制，在運行程序中動態地設定加載代理的步驟如下：

1> 撰寫Agent程式

相對于前文提到的premain方法，現在有一個與之類似的agentmain方法，可以在主程式開始運行之后再運行，同樣的，需要包含以下兩個方法中的任何一個：

[1].public static void agentmain (String agentArgs, Instrumentation inst);
[2].public static void agentmain (String agentArgs);

如果[1]和[2]同時存在，那么[2]將不會生效，agentArgs和inst都和premain中的使用一樣，

2> 生成jar包

將這個Agent程式打包成一個 jar 檔案，并在MANIFEST.MF當中加入"Agent-Class"來指定上一步驟當中包含premain方法的Java 類，

3> 使用Attach api將agent附著到目標JVM(代碼片段)：

注：要使用Attach api，需要參考com.sun.tools，該工具包在%JAVA_HOME%/lib/tools.jar

List<VirtualMachineDescriptor> vms = VirtualMachine.list();
VirtualMachine vm = VirtualMachine.attach(vms.get(0));
vm.loadAgent("agent.jar");
vm.detach();

2.3 實作不重啟JVM動態添加日志

有了前面的介紹，我們知道可以通過Attach機制向一個正在運行的JVM附著一個agent程式，在agent的agentmain方法里就可以借助Instrumentation提供的介面（redefineClasses和retransformClasses）替換已有位元組碼：

public static void agentmain(String agentArgs, Instrumentation inst) 
           throws ClassNotFoundException, UnmodifiableClassException, 
           InterruptedException { 
       //MyTransformer負責重定義位元組碼
       inst.addTransformer(new MyTransformer(), true); 
       //TargetClass為目標類
       inst.retransformClasses(TargetClass.class); 
   } 

需要注意的是，替換位元組碼本身是一個不安全的動作，位元組碼內容不一定是由java檔案編譯而成，也可以是其它語言，只要符合位元組碼規范即可，當然也可以"手寫創造"（asm、javassist等框架也比較好用），我們重制位元組碼可能就沒有了IDE的語法檢查，如果新的位元組碼參考了一個不存在的類，或者呼叫不存在的方法，或者把一個field給洗掉了等等，這都會引發例外，當然，即使這帶有諸多限制，但我們只做日志添加，或者做一些其他改變方法行為的操作是沒有什么問題的，

三、Arthas

實際上，不論是agent的使用，還是位元組碼的處理，當超脫了demo練習，真正運用到生產環境中的時候，一切都會變得相對復雜，我們通常都會考慮將其整合為一個工具，對外提供更加簡潔、方便、人性化的操作入口，好在如今我們不用重復造輪子，阿里開源的Arthas就是這樣一個工具，

關于Arthas，實際上是一個java診斷工具，它以命令列的方式對外提供服務，功能強大，具備監控JVM運行狀態、定位應用的熱點生成火焰圖、修改多載位元組碼等等功能，現在我們以Arthas為工具，實作動態修改位元組碼內容，

3.1 構建demo程式

首先我們需要構建一個demo程式，該程式代碼很簡單，一個主類，一個Print類，

1) Print類包含一個print方法，輸出"hello world."

2) 主類死回圈睡眠一秒呼叫Print#print方法

Print.java:

public class Print {
    public void print(){
        System.out.println("hello world.");
    }
}

Main.java:

public class Main {

    public static void main(String[] args) throws Exception {
        Print print = new Print();
        for (; ; ) {
            print.print();
            Thread.sleep(1000L);
        }
    }
}

將上述代碼打包成jar包運行，可以看到控制臺會間隔1秒列印"hello world."：

3.2 安裝Arthas

實際上就是一個jar包，直接下載即可(https://arthas.aliyun.com/arthas-boot.jar)，linux/MACOS等下可使用curl下載：

curl -O https://arthas.aliyun.com/arthas-boot.jar

3.3 連接到指定JVM

啟動我們的demo程式之后，再運行arthas-boot.jar（運行arthas-boot.jar的用戶要和啟動demo程式的用戶保持一致）：

java -jar arthas-boot.jar

在本機運行arthas-boot，會列出本機正在運行的Java行程，然后等待用戶輸入：

可以看到我們運行的demo是第二個，pid為4073，輸入2，回車，就會連接到4073行程上，進入控制臺：

輸入help指令可以列出當前支持的指令串列和介紹：

使用jad指令反編譯位元組碼：

Arthas支持很多指令，我們接下來只演示使用redefine指令動態修改位元組碼，

redefine -- 加載外部的.class檔案，redefine到JVM里

3.4 動態修改位元組碼

修改Print#print方法，輸出修改為"hello world.modified"：

public class Print {
    public Print() {
    }

    public void print() {
        System.out.println("hello world.modified");
    }
}

然后使用新的Print.java重新編譯，生成新的class（IDE或者命令列javac編譯都可），回到Arthas，使用redefine修改位元組碼，指令格式為：redefine [class]

提示redefine success表示redefine成功了，這時候回到demo控制臺，發現輸出已經變了：

關于Arthas，官網檔案介紹非常詳細，要了解更加深入的用法，請移步官方檔案.

Arthas官網：https://arthas.aliyun.com/

github:https://github.com/alibaba/arthas