Sealyu

javassist 是一個執(zhí)行字節(jié)碼操作的強(qiáng)而有力的驅(qū)動代碼庫。它允許開發(fā)者自由的在一個已經(jīng)編譯好的類中添加新的方法，或者是修改已有的方法。但是，和其他的類似庫不同 的是，Javassist并不要求開發(fā)者對字節(jié)碼方面具有多么深入的了解，同樣的，它也允許開發(fā)者忽略被修改的類本身的細(xì)節(jié)和結(jié)構(gòu)。

字節(jié)碼驅(qū)動通常被用來執(zhí)行對于已經(jīng)編譯好的類的修改，或者由程序自動創(chuàng)建執(zhí)行類等等等等相關(guān)方面的操作。這就要求字節(jié)碼引擎具備無論是在運行時或是編譯時都能修改程序的能力。當(dāng)下有些技術(shù)便是使用字節(jié)碼來強(qiáng)化已經(jīng)存在的Java類的，也有的則是使用它來使用或者產(chǎn)生一些由系統(tǒng)在運行時動態(tài)創(chuàng)建的類。舉例而言，JDO1.0規(guī)范就使用了字節(jié)碼技術(shù)對數(shù)據(jù)庫中 的表進(jìn)行處理和預(yù)編譯，并進(jìn)而包裝成Java類。特別是在面向?qū)ο篁?qū)動的系統(tǒng)開發(fā)中，相當(dāng)多的框架體系使用字節(jié)碼以使我們更好的獲得程序的范型性和動態(tài) 性。而某些EJB容器，比如JBOSS項目，則通過在運行中動態(tài)的創(chuàng)建和加載EJB，從而戲劇性的縮短了部署EJB的周期。這項技術(shù)是如此的引人入勝，以至于在JDK中也有了標(biāo)準(zhǔn)的java.lang.reflect.Proxy類來執(zhí)行相關(guān)的操作。

但 是，盡管如此，編寫字節(jié)碼對于框架程序開發(fā)者們而言，卻是一個相當(dāng)不受歡迎的繁重任務(wù)。學(xué)習(xí)和使用字節(jié)碼在某種程度上就如同使用匯編語言。這使得于大多數(shù) 開發(fā)者而言，盡管在程序上可以獲得相當(dāng)多的好處，可攀登它所需要的難度則足以冷卻這份熱情。不僅如此，在程序中使用字節(jié)碼操作也大大的降低了程序的可讀性 和可維護(hù)性。

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

所幸的是，我們還有Javassist。Javassist是一個可以執(zhí)行字節(jié)碼操作的函數(shù)庫，可是盡管如此，它卻是簡單而便與理解的。他允許開發(fā)者對自己的程序自由的執(zhí)行字節(jié)碼層的操作，當(dāng)然了，你并不需要對字節(jié)碼有多深的了解，或者，你根本就不需要了解。

API Parallel to the Reflection API

Javassist 的最外層的API和JAVA的反射包中的API頗為類似。它使你可以在裝入ClassLoder之前，方便的查看類的結(jié)構(gòu)。它主要由 CtClass,，CtMethod,，以及CtField幾個類組成。用以執(zhí)行和JDK反射API中java.lang.Class,， java.lang.reflect.Method,， java.lang.reflect.Method .Field相同的操作。這些類可以使你在目標(biāo)類被加載前，輕松的獲得它的結(jié)構(gòu)，函數(shù)，以及屬性。此外，不僅僅是在功能上，甚至在結(jié)構(gòu)上，這些類的執(zhí)行函 數(shù)也和反射的API大體相同。比如getName，getSuperclass，getMethods,，getSignature，等等。如果你對 JAVA的反射機(jī)制有所了解的話，使用Javassist的這一層將會是輕松而快樂的。

接下來我們將給出一個使用Javassist來讀取org.geometry.Point.class的相關(guān)信息的例子（當(dāng)然了，千萬不要忘記引入javassist.*包）：

1. ClassPool pool = ClassPool.getDefault();

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

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

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

但是，和反射的API不盡相同的是，Javassist 并不提供構(gòu)造的能力，換句話說，我們并不能就此得到一個 org.geometry.Point.class類的實例。另一方面，在該類沒有實例化前，Javassist也不提供對目標(biāo)類的函數(shù)的調(diào)用接口和獲取 屬性的值的方法。在分析階段，它僅僅提供對目標(biāo)類的類定義修改，而這點，卻是反射API所無法做到的。

舉例如下：

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

這樣做將修改目標(biāo)類和其父類之間的關(guān)系。我們將使org.geometry.Point.clas改繼承自Figure類。當(dāng)然了，就一致性而言，必須確保Figure類和原始的父類之間的兼容性。

而往目標(biāo)類中新增一個新的方法則更加的簡單了。首先我們來看字節(jié)碼是如何形成的：

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

6. pt.addMethod(m);

CtMethod類的讓我們要新增一個方法只需要寫一段小小的函數(shù)。這可是一個天大的好消息，開發(fā)者們再也不用為了實現(xiàn)這么一個小小的操作而寫一大段的虛擬機(jī)指令序列了。Javassist將使用一個它自帶的編譯器來幫我們完成這一切。

最后，千萬別忘了指示Javassist把已經(jīng)寫好的字節(jié)碼存入到你的目標(biāo)類里：

7. pt.writeFile();

writeFile方法可以幫我們把修改好了的定義寫到目標(biāo)類的.class文件里。當(dāng)然了，我們甚至可以在該目標(biāo)類加載的時候完成這一切，Javassist可以很好的和ClassLoader協(xié)同工作，我們不久就將看到這一點。

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

Instrumenting a Method Body

和 方法的新增一樣，對于一個類的方法的其他操作也是定義在代碼層上的。換而言之，盡管這些步驟是必須的，開發(fā)者們也同樣無須直接對虛擬機(jī)的指令序列進(jìn)行操作 和修改，Javassis將自動的完成這些操作。當(dāng)然了，如果開發(fā)者認(rèn)為自己有必要對這些步驟進(jìn)行管理和監(jiān)控，或者希望由自己來管理這些操作的 話，Javassist同樣提供了更加底層的API來實現(xiàn)，不過我們在這篇文章中將不會就此話題再做深入探討。恩，盡管從結(jié)構(gòu)而言，它和BCEL的字節(jié)碼 層API差不多。

設(shè)計Javassist對目標(biāo)類的子函數(shù)體的操作API的設(shè)想立足與Aspect-Oriented Programming（AOP）思想。Javassist允許把具有耦合關(guān)系的語句作為一個整體，它允許在一個插入語句中調(diào)用或獲取其他函數(shù)或者及屬性 值。它將自動的對這些語句進(jìn)行優(yōu)先級分解并執(zhí)行嵌套操作。

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

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

這樣，在執(zhí)行move之前，我們就可以打印出它的位置了。請注意這里的調(diào)用語句，它是如下格式的：

$_ = $proceed($$);

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

基 與如上情況，CtMethod的關(guān)于methord的操作其實被劃分成了如下步驟，首先，CtMethod的methord將掃描插入語句（代碼）本身。 一旦發(fā)現(xiàn)了子函數(shù)，則創(chuàng)建一個ExprEditor實例來分析并執(zhí)行這個子函數(shù)的操作。這個操作將在整個插入語句執(zhí)行之前完成。而假如這個實例存在某個 static的屬性，那么methord將率先檢測對插入語句進(jìn)行檢測。然后，在執(zhí)行插入到目標(biāo)類---如上例的point類---之前，該 static屬性將自動的替換插入語句（代碼）中所有的相關(guān)的部分。不過，值得注意的是，以上的替換操作，將在Javassist把插入語句（代碼）轉(zhuǎn)變 為字節(jié)碼之后完成。

Special Variables

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

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

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

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

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

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函數(shù)調(diào)用之前執(zhí)行打印操作---把傳遞給draw的兩個參數(shù)打印出來。

同樣的，我們也可以使用關(guān)鍵字$對某一個函數(shù)進(jìn)行修改或者是包裝，下面就

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方法做了個拷貝，并創(chuàng)建了一個新的函數(shù)。然后，它把存在與Point類中的原 move方法更名為“_orig”。接下來，讓我們關(guān)注一下程序第五行中的幾個參數(shù)：第一個參數(shù)指示該函數(shù)的在執(zhí)行的最初部分需要先打印一段信息，然后執(zhí) 行子函數(shù)proceed()并返回結(jié)果，這個和move方法差不多，很好理解。第二個參數(shù)則只是申明該子函數(shù)所在的類的位置。這里為this即為 Point類本身。第三個參數(shù)，也就是“m1.getName()”則定義了這個新函數(shù)的名字。

Javassist也同樣具有其他的操作和類來幫助你實現(xiàn)諸如修改某一個屬性的值，改變函數(shù)的回值，并在某個函數(shù)的執(zhí)行后補上其他操作的功能。您可以瀏覽www.javassist.org以獲得相關(guān)的信息