CtClass提供了内省的方法。Javassist的内省机制兼容Java的反射API。CtClass提供了getName(),getSuperclass(),getMethods()等等方法。CtClass也提供了修改类定义的方法。它允许添加新的成员变量,构造函数,以及方法。操作方法体也是可以的。
方法由CtMethod对象表示。CtMethod提供了一些修改方法定义的方法。注意,如果方法是从父类继承的,CtMethod对象既表示了继承而来的方法,也表示了在父类声明的方法。CtMethod对象与每一个声明的方法一致。
例如,如果类Point声明了move()方法,同时Point的子类ColorPoint没有覆盖move(),在Point类声明的move()和ColorPoint继承的move()被同一个CtMethod对象表示。如果表示这两个move()方法定义的CtMethod对象被改变,那么两个方法都会被修改。如果你只想要修改ColorPoint的move(),你应该先添加一个表示Point的move()的CtMethod对象的副本给ColorPoint。可以通过CtNewMethod.copy()获取CtMethod对象副本。
Javassist不允许移除方法或属性,但是它允许修改其名称。所以如果一个方法不在被需要,应该调用CtMethod的setName()和setModifiers()修改它的名称并修改成私有方法。Javassist也不允许添加一个额外的参数到现有的方法。反之,应该添加一个新的接受额外参数或者其它参数的方法。例如,如果你想要添加一个额外的int参数newZ到方法:
void move(int newX, int newY) { x = newX; y = newY; }
在Point类,你应该添加下面的方法:
void move(int newX, int newY, int newZ) {
// do what you want with newZ.
move(newX, newY);
}
Javassist也提供底层API来直接编写二进制类文件。例如,CtClass的getClassFile()返回一个ClassFile对象,它表示了一个二进制类文件。CtMethod的getMethodInfo()返回一个MethodInfo对象,表示类文件包含的method_info结构。底层的API使用了Java虚拟机规范的词汇。用户必须有类文件和字节码相关的知识。更详细的了解,用户应该查看javassist.bytecode包。
Javassist修改类文件只有在使用了以$开头的标识时才需要javassist.runtime包来获取运行时的支持。这些特殊的标识在下文展示。没有使用特殊标识的类文件修改不需要javassist.runtime包或者任何其它的Javassist包。更详细的信息,请查看javassist.runtime包的API文档。
在方法体的开头或结尾插入源文本
CtMethod和CtConstructor提供了insertBefore(),insertAfter()和addCatch()。它们被用来添加代码片段到已经存在的方法的方法体中。这些代码片段可以是用户指定的使用Java编写的源代码文本。Javassist包含了一个简单的Java编译器来处理源代码文本。它接受Java源代码文本同时编译成字节码,它将会被集成到方法体中。
根据行号插入代码片段到指定位置是可以的(如果行号表被包含在类文件中)。CtMethod和CtConstructor的insertAt()把源文本和行号带入原始类定义的源文件中。它编译源文本同时插入编译后的代码到指定的行号。
方法insertBefore(),insertAfter(),addCatch()和insertAt()接收一个字符对象,它表示语句或代码块。语句是一个单一的控制结构,例如if和while之类的以标识符(;)结尾的表达式。一个代码块是一系列使用{}包含的语句。因此下面的每一行是都是错误的语句或代码块实例:
System.out.println("Hello");
{ System.out.println("Hello"); }
if (i < 0) { i = -i; }
语句和代码块可以引用属性和方法。如果方法是用-g选项编译的(也可以在类文件中包含局部变量属性),它们也可以引用它们插入的方法的参数。否则,它们必须通过下文描述的特殊变量$0
, $1
, $2
等访问方法的参数。访问方法声明的本地变量是不允许的,尽管允许代码块声明新的本地变量。然而,如果这些变量在指定的行号可以获得且目标方法使用-g选项编译,insertAt()运行语句和代码块访问本地变量。
传入insertBefore(),insertAfter(),addCatch(),和insertAt()的字符串对象被Javassist包含的编译器编译。因此编译器支持语言扩展,专有的以$开头的标识符有特殊的意义:
$0 , $1 , $2 , … |
this和实际的参数 |
---|---|
$args | 参数数组,$args的类型为object[] |
$$ | 所有实际的参数,例如m($$)与m($1,$2,…)等同 |
$cflow(…) | cflow变量 |
$r | 返回类型。它被用在转换表达式中。 |
$w | 包装类类型。它被用在转换表达式中。 |
$_ | 返回值 |
$sig | 一个java.lang.Class对象数组,表示正式的参数类型。 |
$type | 一个java.lang.Class对象,表示了正式的返回类型。 |
$class | 一个java.lang.Class对象,表示当前编辑的类。 |
$0
, $1
, $2
, …
传入目标方法的参数需要使用$1
, $2
, … 而不是原始的参数名。$1
表示第一个参数,$2
表示第二个参数等等。这些变量的类型和参数的类型一致。$0
等于this。如果方法是静态的,$0
无法获取。
这些变量的使用如下。假设类Point:
class Point {
int x, y;
void move(int dx, int dy) { x += dx; y += dy; }
}
为了在每次调用move()时打印dx和dy的值,执行下面的程序:
ClassPool pool = ClassPool.getDefault();
CtClass cc = pool.get("Point");
CtMethod m = cc.getDeclaredMethod("move");
m.insertBefore("{ System.out.println($1); System.out.println($2); }");
cc.writeFile();
注意传入到insertBefore的源文本要被{}包围。insertBefore()只接收单个语句或者代码块。
Point类的定义修改后如下:
class Point {
int x, y;
void move(int dx, int dy) {
{ System.out.println(dx); System.out.println(dy); }
x += dx; y += dy;
}
}
$1
和$2
分别被替换成dx和dy。
$1
, $2
, $3
… 是可更新的。如果一个新的值被指定给其中一个变量,然后这个变量所表示的值也同时被更新。