Javassist: Java Bytecode Engineering Made Simple

 翻譯：ithuriel xiao

Summary

Javassist是一個執行位元組碼操作的強而有力的驅動代碼庫。它允許開發者自由的在一個已經編譯好的類中添加新的方法，或者是修改已有的方法。但是，和其他的類似庫不同的是，Javassist并不要求開發者對位元組碼方面具有多麼深入的了解，同樣的，它也允許開發者忽略被修改的類本身的細節和結構。

位元組碼驅動通常被用來執行對于已經編譯好的類的修改，或者由程式自動建立執行類等等等等相關方面的操作。這就要求位元組碼引擎具備無論是在運作時或是編譯時都能修改程式的能力。當下有些技術便是使用位元組碼來強化已經存在的Java類的，也有的則是使用它來使用或者産生一些由系統在運作時動态建立的類。舉例而言，JDO1.0規範就使用了位元組碼技術對資料庫中的表進行處理和預編譯，并進而包裝成Java類。特别是在面向對象驅動的系統開發中，相當多的架構體系使用位元組碼以使我們更好的獲得程式的範型性和動态性。而某些EJB容器，比如JBOSS項目，則通過在運作中動态的建立和加載EJB，進而戲劇性的縮短了部署EJB的周期。這項技術是如此的引人入勝，以至于在JDK中也有了标準的java.lang.reflect.Proxy類來執行相關的操作。

但是，盡管如此，編寫位元組碼對于架構程式開發者們而言，卻是一個相當不受歡迎的繁重任務。學習和使用位元組碼在某種程度上就如同使用彙編語言。這使得于大多數開發者而言，盡管在程式上可以獲得相當多的好處，可攀登它所需要的難度則足以冷卻這份熱情。不僅如此，在程式中使用位元組碼操作也大大的降低了程式的可讀性和可維護性。

這是一塊很好的奶油面包，但是我們卻隻能隔着櫥窗流口水…難道我們隻能如此了嗎？

所幸的是，我們還有Javassist。Javassist是一個可以執行位元組碼操作的函數庫，可是盡管如此，它卻是簡單而便與了解的。他允許開發者對自己的程式自由的執行位元組碼層的操作，當然了，你并不需要對位元組碼有多深的了解，或者，你根本就不需要了解。

API Parallel to the Reflection API

Javassist的最外層的API和JAVA的反射包中的API頗為類似。它使你可以在裝入ClassLoder之前，友善的檢視類的結構。它主要由CtClass,，CtMethod,，以及CtField幾個類組成。用以執行和JDK反射API中java.lang.Class,，java.lang.reflect.Method,， java.lang.reflect.Method .Field相同的操作。這些類可以使你在目标類被加載前，輕松的獲得它的結構，函數，以及屬性。此外，不僅僅是在功能上，甚至在結構上，這些類的執行函數也和反射的API大體相同。比如getName，getSuperclass，getMethods,，getSignature，等等。如果你對JAVA的反射機制有所了解的話，使用Javassist的這一層将會是輕松而快樂的。

接下來我們将給出一個使用Javassist來讀取org.geometry.Point.class的相關資訊的例子（當然了，千萬不要忘記引入javassist.*包）：

1. ClassPool pool = ClassPool.getDefault();

2. CtClass pt = pool.get("org.geometry.Point");

3. System.out.println(pt.getSuperclass().getName());

其中，ClassPool是CtClass 的建立工廠。它在class path中查找CtClass的位置，并為每一個分析請求建立一個CtClass執行個體。而“getSuperclass().getName()”則展示出org.geometry.Point.class所繼承的父類的名字。

但是，和反射的API不盡相同的是，Javassist并不提供構造的能力，換句話說，我們并不能就此得到一個org.geometry.Point.class類的執行個體。另一方面，在該類沒有執行個體化前，Javassist也不提供對目标類的函數的調用接口和擷取屬性的值的方法。在分析階段，它僅僅提供對目标類的類定義修改，而這點，卻是反射API所無法做到的。

舉例如下：

4. pt.setSuperclass(pool.get("Figure"));

這樣做将修改目标類和其父類之間的關系。我們将使org.geometry.Point.clas改繼承自Figure類。當然了，就一緻性而言，必須確定Figure類和原始的父類之間的相容性。

而往目标類中新增一個新的方法則更加的簡單了。首先我們來看位元組碼是如何形成的：

5. CtMethod m = CtNewMethod.make("public int xmove(int dx) { x += dx; }", pt);

6. pt.addMethod(m);

CtMethod類的讓我們要新增一個方法隻需要寫一段小小的函數。這可是一個天大的好消息，開發者們再也不用為了實作這麼一個小小的操作而寫一大段的虛拟機指令序列了。Javassist将使用一個它自帶的編譯器來幫我們完成這一切。

最後，千萬别忘了訓示Javassist把已經寫好的位元組碼存入到你的目标類裡：

7. pt.writeFile();

writeFile方法可以幫我們把修改好了的定義寫到目标類的.class檔案裡。當然了，我們甚至可以在該目标類加載的時候完成這一切，Javassist可以很好的和ClassLoader協同工作，我們不久就将看到這一點。

Javassist并不是第一套用以完成從代碼到位元組碼的翻譯的函數庫。Jakarta的BCEL也是一個比較知名的位元組碼引擎工具。但是，你卻無法使用BCEL來完成代碼級别的字元碼操作。如果你需要在一個已經編譯好的類中添加一個新的方法，假如你用的是BCEL的話，你隻能定義一段由那麼一大串字元碼所構成的指令序列。正如上文所說，這并不是我們所希望看到的。是以，就此方面而言，Javassis使用代碼的形式來插入新的方法實在是一大福音。

Instrumenting a Method Body

和方法的新增一樣，對于一個類的方法的其他操作也是定義在代碼層上的。換而言之，盡管這些步驟是必須的，開發者們也同樣無須直接對虛拟機的指令序列進行操作和修改，Javassis将自動的完成這些操作。當然了，如果開發者認為自己有必要對這些步驟進行管理和監控，或者希望由自己來管理這些操作的話，Javassist同樣提供了更加底層的API來實作，不過我們在這篇文章中将不會就此話題再做深入探讨。恩，盡管從結構而言，它和BCEL的位元組碼層API差不多。

設計Javassist對目标類的子函數體的操作API的設想立足與Aspect-Oriented Programming（AOP）思想。Javassist允許把具有耦合關系的語句作為一個整體，它允許在一個插入語句中調用或擷取其他函數或者及屬性值。它将自動的對這些語句進行優先級分解并執行嵌套操作。

如下例所示，清單1首先包含了一個CtMethod，它主要針對Screen類的draw方法。然後，我們定義一個Point類，該類有一個move操作，用來實作該Point的移動。當然了，在移動前，我們希望可以通過draw方法得到該point目前的位置，那麼，我們需要對該move方法加增如下的定義：

{ System.out.println("move"); $_ = $proceed($$); }

這樣，在執行move之前，我們就可以列印出它的位置了。請注意這裡的調用語句，它是如下格式的：

$_ = $proceed($$);

這樣我們就将使用原CtMethod類中的process()對該point的位置進行追蹤了。

基與如上情況，CtMethod的關于methord的操作其實被劃分成了如下步驟，首先，CtMethod的methord将掃描插入語句（代碼）本身。一旦發現了子函數，則建立一個ExprEditor執行個體來分析并執行這個子函數的操作。這個操作将在整個插入語句執行之前完成。而假如這個執行個體存在某個static的屬性，那麼methord将率先檢測對插入語句進行檢測。然後，在執行插入到目标類---如上例的point類---之前，該static屬性将自動的替換插入語句（代碼）中所有的相關的部分。不過，值得注意的是，以上的替換操作，将在Javassist把插入語句（代碼）轉變為位元組碼之後完成。

Special Variables

在替換的語句（代碼）中，我們也有可能需要用到一些特殊變量來完成對某個子函數的調用，而這個時候我們就需要使用關鍵字“$”了。在Javassist中，“$”用來申明此後的某個詞為特殊參數，而“$_”則用來申明此後的某個詞為函數的回傳值。每一個特殊參數在被調用時應該是這個樣子的“$1,$2,$3…”但是，特别的，目标類本身在被調用時，則被表示為“$0”。這種使用格式讓開發者在填寫使用子函數的參數時輕松了許多。比如如下的例子：

{ System.out.println("move"); $_ = $proceed($1, 0); }

請注意，該子函數的第2個參數為0。

另外一個特殊類型則是$arg，它實際上是一個容納了函數所有調用參數的Object隊列。當Javassist在掃描該$arg時，如果發現某一個參數為JAVA的基本類型，則它将自動的對該參數進行包裝，并放入隊列。比如，當它發現某一個參數為int類型時，它将使用java.lang.integer 類來包裝這個int參數，并存入參數隊列。和Java的反射包：java.lang.reflect.Methord類中的invoke方法相比，$args明顯要省事的多。

Javassist也同樣允許開發者在某個函數的頭，或者某個函數的尾上插入某段語句（代碼）。比如，它有一個insertBefore方法用以在某函數的調用前執行某個操作，它的使用大緻是這個樣子的：

1. ClassPool pool = ClassPool.getDefault();

2. CtClass cc = pool.get("Screen");

3. CtMethod cm = cc.getDeclaredMethod("draw", new CtClass[0]);

4. cm.insertBefore("{ System.out.println($1); System.out.println($2); }");

5. cc.writeFile();

以上例子允許我們在draw函數調用之前執行列印操作---把傳遞給draw的兩個參數列印出來。

同樣的，我們也可以使用關鍵字$對某一個函數進行修改或者是包裝，下面就

1. CtClass cc = sloader.get("Point");

2. CtMethod m1 = cc.getDeclaredMethod("move");

3. CtMethod m2 = CtNewMethod.copy(m1, cc, null);

4. m1.setName(m1.getName() + "_orig");

5. m2.setBody("{ System.out.println("call"); return $proceed($$);

}", "this", m1.getName());

6. cc.addMethod(m2);

7. cc.writeFile();

以上代碼的前四行不難了解，Javassist首先對Point中的move方法做了個拷貝，并建立了一個新的函數。然後，它把存在與Point類中的原move方法更名為“_orig”。接下來，讓我們關注一下程式第五行中的幾個參數：第一個參數訓示該函數的在執行的最初部分需要先列印一段資訊，然後執行子函數proceed()并傳回結果，這個和move方法差不多，很好了解。第二個參數則隻是申明該子函數所在的類的位置。這裡為this即為Point類本身。第三個參數，也就是“m1.getName()”則定義了這個新函數的名字。

Javassist也同樣具有其他的操作和類來幫助你實作諸如修改某一個屬性的值，改變函數的回值，并在某個函數的執行後補上其他操作的功能。您可以浏覽www.javassist.org以獲得相關的資訊。

呼呼，趕了兩小時的說~~~英語太糟糕了，不過這個東西真不錯，特别是結合反射一起用，超級靈啊，可能有很多的錯誤，我的正式工作經驗還不到一年，請大家指教咯。