javassist 介绍和使用

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是CtClas 的创建工厂。它在classpath中查找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以获得相关的信息。

官方主页：http://www.csg.is.titech.ac.jp/~chiba/javassist/

Javassist，Cglib等是一些代码增强工具，在运行时刻进行Java字节码增强，虽然速度上稍微慢一点点，但是带来的是代码的简洁，今天用Javassist进行代码增强。

代码：

TestBean.java

1. package javassist.sample;
3. public abstract class TestBean {
5.     public String field;
7.     public abstract String getM();
9.     public abstract void setF(String f);
11.     public String getF() {
12.         return this.field;
13.     }
14. }

TestByteCode.java

1. package javassist.sample;
3. import javassist.ClassPool;
4. import javassist.CtClass;
5. import javassist.CtConstructor;
6. import javassist.CtMethod;
8. public class TestByteCode {
10.     public static void main(String[] args) throws Exception {
11.         
12.         ClassPool pool = ClassPool.getDefault();
13.         CtClass pt = pool.makeClass("asdf", pool.get("javassist.sample.TestBean"));
15.         CtMethod method1 = new CtMethod(pool.get("java.lang.String"), "getM", null, pt);
16.         method1.setBody("{return /"你好/";}");
17.         pt.addMethod(method1);
19.         CtConstructor cc = new CtConstructor(null, pt);
20.         cc.setBody("this.field=/"why?/";");
21.         pt.addConstructor(cc);
23.         CtMethod method2 = new CtMethod(CtClass.voidType, "setF",
24.                 new CtClass[] { pool.get("java.lang.String") }, pt);
25.         method2.setBody("{this.field=$1;}");
26.         pt.addMethod(method2);
28.         Class c = pt.toClass();
29.         TestBean bean = (TestBean) c.newInstance();
31.         System.out.println(bean.getM());
32.         System.out.println(bean.getF());
33.         bean.setF("setf");
34.         System.out.println(bean.getF());
35.     }
36. }

输出为：

你好

why?

setf

可以看到实现了动态的构造，动态实现抽象函数。在进行代码自动化项目中，能够使用字节码增强将大大提高代码的质量，和减少代码的数量。

 

再看一个例子：

A.java

1. package javassist.demo;
3. public class A {
5.     public void method() {
6.         for (int i = 0; i < 1000000; i++) {
7.         }
8.         System.out.println("method1");
9.     }
10. }

JavassistTest.java

1. package javassist.demo;
2. import javassist.ClassPool;
3. import javassist.CtClass;
4. import javassist.CtMethod;
5. import javassist.CtNewMethod;
7. public class JavassistTest {
9.     public static void main(String[] args) throws Exception {
11.         // 用于取得字节码类，必须在当前的classpath中，使用全称
12.         CtClass ctClass = ClassPool.getDefault().get("javassist.demo.A");
13.         // 需要修改的方法名称
14.         String mname = "method";
15.         CtMethod mold = ctClass.getDeclaredMethod(mname);
16.         // 修改原有的方法名称
17.         String nname = mname + "$impl";
18.         mold.setName(nname);
19.         // 创建新的方法，复制原来的方法
20.         CtMethod mnew = CtNewMethod.copy(mold, mname, ctClass, null);
21.         // 主要的注入代码
22.         StringBuffer body = new StringBuffer();
23.         body.append("{/nlong start = System.currentTimeMillis();/n");
24.         // 调用原有代码，类似于method();($$)表示所有的参数
25.         body.append(nname + "($$);/n");
26.         body.append("System.out.println(/"Call to method " + mname
27.                 + " took /" +/n (System.currentTimeMillis()-start) + "
28.                 + "/" ms./");/n");
30.         body.append("}");
31.         // 替换新方法
32.         mnew.setBody(body.toString());
33.         // 增加新方法
34.         ctClass.addMethod(mnew);
35.         // 类已经更改，注意不能使用A a=new A();，因为在同一个classloader中，不允许装载同一个类两次
36.         A a = (A) ctClass.toClass().newInstance();
37.         a.method();
38.     }
39. }

资料：

http://www.blogjava.net/zyl/archive/2007/02/10/99171.html

http://www.ibm.com/developerworks/cn/java/j-dyn0916/