Java動态追蹤技術

• • 背景
  • 從JSP說起
  • Java對象行為
  • 直接操作位元組碼
  • BTrace
  • 尾聲：三生萬物

背景

在繁華的希艾斯星球爪哇國塞沃城中，兩名年輕的程式員正在為一件事情苦惱，程式出問題了，一時看不出問題出在哪裡，于是有了以下對話：

“Debug一下吧。”

“線上機器，沒開Debug端口。”

“看日志，看看請求值和傳回值分别是什麼？”

“那段代碼沒列印日志。”

“改代碼，加日志，重新釋出一次。”

“懷疑是線程池的問題，重新開機會破壞現場。”

長達幾十秒的沉默之後：“據說，排查問題的最高境界，就是隻通過Review代碼來發現問題。”

比幾十秒長幾十倍的沉默之後：“我輪詢了那段代碼一十七遍之後，終于得出一個結論。”

“結論是？”

“我還沒到達隻通過Review代碼就能發現問題的至高境界。”
           

從JSP說起

對于大多數Java程式員來說，早期的時候，都會接觸到一個叫做JSP（Java Server Pages）的技術。雖然這種技術，在前後端代碼分離、前後端邏輯分離、前後端組織架構分離的今天來看，已經過時了，但是其中還是有一些有意思的東西，值得拿出來說一說。

當時剛剛處于Java入門時期的我們，大多數精力似乎都放在了JSP的頁面展示效果上了：

“這個表格顯示的行數不對”

“原來是for循環寫的有問題，改一下，重新整理頁面再試一遍”

“嗯，好了，表格顯示沒問題了，但是，登入人的姓名沒取到啊，是不是Sesstion擷取有問題？”

“有可能，我再改一下，一會兒再重新整理試試”

……

在一遍一遍修改代碼重新整理浏覽器頁面重試的時候，我們自己也許并沒有注意到一件很酷的事情：我們修改完代碼，居然隻是簡單地重新整理一遍浏覽器頁面，修改就生效了，整個過程并沒有重新開機JVM。按照我們的常識，Java程式一般都是在啟動時加載類檔案，如果都像JSP這樣修改完代碼，不用重新開機就生效的話，那文章開頭的問題就可以解決了啊：Java檔案中加一段日志列印的代碼，不重新開機就生效，既不破壞現場，又可以定位問題。忍不住試一試：修改、編譯、替換class檔案。額，不行，新改的代碼并沒有生效。那為什麼偏偏JSP可以呢？讓我們先來看看JSP的運作原理。

當我們打開浏覽器，請求通路一個JSP檔案的時候，整個過程是這樣的:

JSP檔案修改過後，之是以能及時生效，是因為Web容器（Tomcat）會檢查請求的JSP檔案是否被更改過。如果發生過更改，那麼就将JSP檔案重新解析翻譯成一個新的Sevlet類，并加載到JVM中。之後的請求，都會由這個新的Servet來處理。這裡有個問題，根據Java的類加載機制，在同一個ClassLoader中，類是不允許重複的。為了繞開這個限制，Web容器每次都會建立一個新的ClassLoader執行個體，來加載新編譯的Servlet類。之後的請求都會由這個新的Servlet來處理，這樣就實作了新舊JSP的切換。

HTTP服務是無狀态的，是以JSP的場景基本上都是一次性消費，這種通過建立新的ClassLoader來“替換”class的做法行得通，但是對于其他應用，比如Spring架構，即便這樣做了，對象多數是單例，對于記憶體中已經建立好的對象，我們無法通過這種建立新的ClassLoader執行個體的方法來修改對象行為。

我就是想不重新開機應用加個日志列印，就這麼難嗎？

Java對象行為

既然JSP的辦法行不通，那我們來看看還有沒有其他的辦法。仔細想想，我們會發現，文章開頭的問題本質上是動态改變記憶體中已存在對象的行為的問題。是以，我們得先弄清楚JVM中和對象行為有關的地方在哪裡，有沒有更改的可能性。

我們都知道，對象使用兩種東西來描述事物：行為和屬性。舉個例子：

public class Person{

  private int age;

  private String name;

  public void speak(String str) {

    System.out.println(str);

 }

 public Person(int age, String name) {

    this.age = age;

    this.name = name;

 }

}
           

上面Person類中age和name是屬性，speak是行為。對象是類的事例，每個對象的屬性都屬于對象本身，但是每個對象的行為卻是公共的。舉個例子，比如我們現在基于Person類建立了兩個對象，personA和personB：

Person personA = new Person(43, "lixunhuan");

personA.speak("我是李尋歡");

Person personB = new Person(23, "ading");

personB.speak("我是阿丁");
           

personA和personB有各自的姓名和年齡，但是有共同的行為：speak。想象一下，如果我們是Java語言的設計者，我們會怎麼存儲對象的行為和屬性呢？

“很簡單，屬性跟着對象走，每個對象都存一份。行為是公共的東西，抽離出來，單獨放到一個地方。”

“咦？抽離出公共的部分，跟代碼複用好像啊。”

“大道至簡，很多東西本來都是殊途同歸。”

也就是說，第一步我們首先得找到存儲對象行為的這個公共的地方。一番搜尋之後，我們發現這樣一段描述：

(來自深入了解jvm)

Method area is created on virtual machine startup, shared among all Java virtual machine threads and it is logically part of heap area. It stores per-class structures such as the run-time constant pool, field and method data, and the code for methods and constructors.

Java的對象行為（方法、函數）是存儲在方法區的。

“方法區中的資料從哪來？”

“方法區中的資料是類加載時從class檔案中提取出來的。”

“class檔案從哪來？”

“從Java或者其他符合JVM規範的源代碼中編譯而來。”

“源代碼從哪來？”

“廢話，當然是手寫！”

“倒着推，手寫沒問題，編譯沒問題，至于加載……有沒有辦法加載一個已經加載過的類呢？如果有的話，我們就能修改位元組碼中目标方法所在的區域，然後重新加載這個類，這樣方法區中的對象行為（方法）就被改變了，而且不改變對象的屬性，也不影響已經存在對象的狀态，那麼就可以搞定這個問題了。可是，這豈不是違背了JVM的類加載原理？畢竟我們不想改變ClassLoader。”

“少年，可以去看看

java.lang.instrument.Instrumentation。

”

java.lang.instrument.Instrumentation

看完文檔之後，我們發現這麼兩個接口：redefineClasses和retransformClasses。一個是重新定義class，一個是修改class。這兩個大同小異，看reDefineClasses的說明：

This method is used to replace the definition of a class without reference to the existing class file bytes, as one might do when recompiling from source for fix-and-continue debugging. Where the existing class file bytes are to be transformed (for example in bytecode instrumentation) retransformClasses should be used.
           

都是替換已經存在的class檔案，redefineClasses是自己提供位元組碼檔案替換掉已存在的class檔案，retransformClasses是在已存在的位元組碼檔案上修改後再替換之。

當然，運作時直接替換類很不安全。比如新的class檔案引用了一個不存在的類，或者把某個類的一個field給删除了等等，這些情況都會引發異常。是以如文檔中所言，instrument存在諸多的限制：

The redefinition may change method bodies, the constant pool and attributes. The redefinition must not add, remove or rename fields or methods, change the signatures of methods, or change inheritance. These restrictions maybe be lifted in future versions. The class file bytes are not checked, verified and installed until after the transformations have been applied, if the resultant bytes are in error this method will throw an exception.
           

我們能做的基本上也就是簡單修改方法内的一些行為，這對于我們開頭的問題，列印一段日志來說，已經足夠了。當然，我們除了通過reTransform來列印日志，還能做很多其他非常有用的事情，這個下文會進行介紹。

那怎麼得到我們需要的class檔案呢？一個最簡單的方法，是把修改後的Java檔案重新編譯一遍得到class檔案，然後調用redefineClasses替換。但是對于沒有（或者拿不到，或者不友善修改）源碼的檔案我們應該怎麼辦呢？其實對于JVM來說，不管是Java也好，Scala也好，任何一種符合JVM規範的語言的源代碼，都可以編譯成class檔案。JVM的操作對象是class檔案，而不是源碼。是以，從這種意義上來講，我們可以說“JVM跟語言無關”。既然如此，不管有沒有源碼，其實我們隻需要修改class檔案就行了。

直接操作位元組碼

Java是軟體開發人員能讀懂的語言，class位元組碼是JVM能讀懂的語言，class位元組碼最終會被JVM解釋成機器能讀懂的語言。無論哪種語言，都是人創造的。是以，理論上（實際上也确實如此）人能讀懂上述任何一種語言，既然能讀懂，自然能修改。隻要我們願意，我們完全可以跳過Java編譯器，直接寫位元組碼檔案，隻不過這并不符合時代的發展罷了，畢竟進階語言設計之始就是為我們人類所服務，其開發效率也比機器語言高很多。

對于人類來說，位元組碼檔案的可讀性遠遠沒有Java代碼高。盡管如此，還是有一些傑出的程式員們創造出了可以用來直接編輯位元組碼的架構，提供接口可以讓我們友善地操作位元組碼檔案，進行注入修改類的方法，動态創造一個新的類等等操作。其中最著名的架構應該就是ASM了，cglib、Spring等架構中對于位元組碼的操作就建立在ASM之上。

我們都知道，Spring的AOP是基于動态代理實作的，Spring會在運作時動态建立代理類，代理類中引用被代理類，在被代理的方法執行前後進行一些神秘的操作。那麼，Spring是怎麼在運作時建立代理類的呢？動态代理的美妙之處，就在于我們不必手動為每個需要被代理的類寫代理類代碼，Spring在運作時會根據需要動态地創造出一個類，這裡創造的過程并非通過字元串寫Java檔案，然後編譯成class檔案，然後加載。Spring會直接“創造”一個class檔案，然後加載，創造class檔案的工具，就是ASM了。

到這裡，我們知道了用ASM架構直接操作class檔案，在類中加一段列印日志的代碼，然後調用retransformClasses就可以了。

BTrace

截止到目前，我們都是停留在理論描述的層面。那麼如何進行實作呢？先來看幾個問題：

在我們的工程中，誰來做這個尋找位元組碼，修改位元組碼，然後reTransform的動作呢？我們并非先知，不可能知道未來有沒有可能遇到文章開頭的這種問題。考慮到成本效益，我們也不可能在每個工程中都開發一段專門做這些修改位元組碼、重新加載位元組碼的代碼。
如果JVM不在本地，在遠端呢？
如果連ASM都不會用呢？能不能更通用一些，更“傻瓜”一些。
           

幸運的是，因為有BTrace的存在，我們不必自己寫一套這樣的工具了。什麼是BTrace呢？BTrace已經開源，項目描述極其簡短：

A safe, dynamic tracing tool for the Java platform.
           

BTrace是基于Java語言的一個安全的、可提供動态追蹤服務的工具。BTrace基于ASM、Java Attach Api、Instruments開發，為使用者提供了很多注解。依靠這些注解，我們可以編寫BTrace腳本（簡單的Java代碼）達到我們想要的效果，而不必深陷于ASM對位元組碼的操作中不可自拔。

看BTrace官方提供的一個簡單例子：攔截所有java.io包中所有類中以read開頭的方法，列印類名、方法名和參數名。當程式IO負載比較高的時候，就可以從輸出的資訊中看到是哪些類所引起，是不是很友善？

package com.sun.btrace.samples;

import com.sun.btrace.annotations.*;
import com.sun.btrace.AnyType;
import static com.sun.btrace.BTraceUtils.*;

/**
 * This sample demonstrates regular expression
 * probe matching and getting input arguments
 * as an array - so that any overload variant
 * can be traced in "one place". This example
 * traces any "readXX" method on any class in
 * java.io package. Probed class, method and arg
 * array is printed in the action.
 */
@BTrace public class ArgArray {
    @OnMethod(
        clazz="/java\\.io\\..*/",
        method="/read.*/"
    )
    public static void anyRead(@ProbeClassName String pcn, @ProbeMethodName String pmn, AnyType[] args) {
        println(pcn);
        println(pmn);
        printArray(args);
    }
}
           

再來看另一個例子：每隔2秒列印截止到目前建立過的線程數。

package com.sun.btrace.samples;

import com.sun.btrace.annotations.*;
import static com.sun.btrace.BTraceUtils.*;
import com.sun.btrace.annotations.Export;

/**
 * This sample creates a jvmstat counter and
 * increments it everytime Thread.start() is
 * called. This thread count may be accessed
 * from outside the process. The @Export annotated
 * fields are mapped to jvmstat counters. The counter
 * name is "btrace." + <className> + "." + <fieldName>
 */ 
@BTrace public class ThreadCounter {

    // create a jvmstat counter using @Export
    @Export private static long count;

    @OnMethod(
        clazz="java.lang.Thread",
        method="start"
    ) 
    public static void onnewThread(@Self Thread t) {
        // updating counter is easy. Just assign to
        // the static field!
        count++;
    }

    @OnTimer(2000) 
    public static void ontimer() {
        // we can access counter as "count" as well
        // as from jvmstat counter directly.
        println(count);
        // or equivalently ...
        println(Counters.perfLong("btrace.com.sun.btrace.samples.ThreadCounter.count"));
    }
}
           

看了上面的用法是不是有所啟發？忍不住冒出來許多想法。比如檢視HashMap什麼時候會觸發rehash，以及此時容器中有多少元素等等。

有了BTrace，文章開頭的問題可以得到完美的解決。至于BTrace具體有哪些功能，腳本怎麼寫，這些Git上BTrace工程中有大量的說明和舉例，網上介紹BTrace用法的文章更是恒河沙數，這裡就不再贅述了。

我們明白了原理，又有好用的工具支援，剩下的就是發揮我們的創造力了，隻需在合适的場景下合理地進行使用即可。

既然BTrace能解決上面我們提到的所有問題，那麼BTrace的架構是怎樣的呢？

BTrace主要有下面幾個子產品：

BTrace腳本：利用BTrace定義的注解，我們可以很友善地根據需要進行腳本的開發。
Compiler：将BTrace腳本編譯成BTrace class檔案。
Client：将class檔案發送到Agent。
Agent：基于Java的Attach Api，Agent可以動态附着到一個運作的JVM上，然後開啟一個BTrace Server，接收client發過來的BTrace腳本；解析腳本，然後根據腳本中的規則找到要修改的類；修改位元組碼後，調用Java Instrument的reTransform接口，完成對對象行為的修改并使之生效。
           

整個BTrace的架構大緻如下：

BTrace最終借Instruments實作class的替換。如上文所說，出于安全考慮，Instruments在使用上存在諸多的限制，BTrace也不例外。BTrace對JVM來說是“隻讀的”，是以BTrace腳本的限制如下：

不允許建立對象
不允許建立數組
不允許抛異常
不允許catch異常
不允許随意調用其他對象或者類的方法，隻允許調用com.sun.btrace.BTraceUtils中提供的靜态方法（一些資料處理和資訊輸出工具）
不允許改變類的屬性
不允許有成員變量和方法，隻允許存在static public void方法
不允許有内部類、嵌套類
不允許有同步方法和同步塊
不允許有循環
不允許随意繼承其他類（當然，java.lang.Object除外）
不允許實作接口
不允許使用assert
不允許使用Class對象
           

Arthas

如此多的限制，其實可以了解。BTrace要做的是，雖然修改了位元組碼，但是除了輸出需要的資訊外，對整個程式的正常運作并沒有影響。

BTrace腳本在使用上有一定的學習成本，如果能把一些常用的功能封裝起來，對外直接提供簡單的指令即可操作的話，那就再好不過了。阿裡的工程師們早已想到這一點，就在去年（2018年9月份），阿裡巴巴開源了自己的Java診斷工具——Arthas.。Arthas提供簡單的指令行操作，功能強大。究其背後的技術原理，和本文中提到的大緻無二。Arthas的文檔很全面，想詳細了解的話可以戳這裡。

本文旨在說明Java動态追蹤技術的來龍去脈，掌握技術背後的原理之後，隻要願意，各位讀者也可以開發出自己的“冰封王座”出來。

尾聲：三生萬物

現在，讓我們試着站在更高的地方“俯瞰”這些問題。

Java的Instruments給運作時的動态追蹤留下了希望，Attach API則給運作時動态追蹤提供了“出入口”，ASM則大大友善了“人類”操作Java位元組碼的操作。

基于Instruments和Attach API前輩們創造出了諸如JProfiler、Jvisualvm、BTrace、Arthas這樣的工具。以ASM為基礎發展出了cglib、動态代理，繼而是應用廣泛的Spring AOP。

Java是靜态語言，運作時不允許改變資料結構。然而，Java 5引入Instruments，Java 6引入Attach API之後，事情開始變得不一樣了。雖然存在諸多限制，然而，在前輩們的努力下，僅僅是利用預留的近似于“隻讀”的這一點點狹小的空間，仍然創造出了各種大放異彩的技術，極大地提高了軟體開發人員定位問題的效率。

計算機應該是人類有史以來最偉大的發明之一，從電磁感應磁生電，到高低電壓模拟0和1的比特，再到二進制表示出幾種基本類型，再到基本類型表示出無窮的對象，最後無窮的對象組合互動模拟現實生活乃至整個宇宙。

兩千五百年前，《道德經》有言：“道生一，一生二，二生三，三生萬物。”

兩千五百年後，計算機的發展過程也大抵如此吧。