前两篇文章我们介绍了如何修改一个方法的方法体,主要通过插入源文本的方式到方法体中。源文本需要是语句或者代码块,这样就可以部分修改方法体。本章我们将详细的讨论如何修改整个方法体。
修改方法体
CtMethod和CtConstructor提供了setBody()来替换全部的方法体。它们编译源文本成为Java字节码且替换原始的方法体。如果给出的源文本是null,那么被取代的方法体只会含有return语句,retutn 0或者null,除非返回类型是void。
在传入setBody()的源文本中,以$开头的标识符有着特殊的含义
$0 ,$1 ,$2 ,… |
this和实际的参数 |
---|---|
$args |
参数的数组。$args 的类型是Object[] |
$$ |
所有实际的参数 |
$cflow( …) |
cflow变量 |
$r |
返回类型。用在强制类型转换中 |
$w |
包装类型。用在强制类型转换中 |
$sig |
一个java.lang.Class对象数组,它表示正式的参数类型 |
$type |
一个java.lang.Class对象,它表示正式的返回类型 |
$class |
一个java.lang.Class对象,它表示当前正在修改方法的类($0 的类型) |
注意,$_
没有办法获取。
将源文本替换为现有表达式
Javassist仅允许修改一个方法体中的表达式。javassist.expr.ExprEditor是一个用来替换方法体内表达式的类。用户可以定义ExprEditor的子类来制定表达式的修改。
为了运行ExprEditor对象,用户必须调用CtMethod或CtClass的instrument(),例如,
CtMethod cm = ... ;
cm.instrument(
new ExprEditor() {
public void edit(MethodCall m)
throws CannotCompileException
{
if (m.getClassName().equals("Point")
&& m.getMethodName().equals("move"))
m.replace("{ $1 = 0; $_ = $proceed($$); }");
}
});
扫描的方法体用cm表示,同时替换Point类中所有move()的调用为一个代码块:
{ $1 = 0; $_ = $proceed($$); }
因此move()的第一个参数总是0.注意,替换的代码不是一个表达式,而是一个语句或者代码块。它不能是或包含try-catch的语句。
方法instrument()扫描整个方法体。如果发现方法调用的表达式,属性访问,对象创建,然后它调用由ExprEditor对象提供的edit()。edit()参数是一个表示发现的表达式的对象。通过这个对象,edit()方法可以检查和替换表达式。
调用edit()参数的replace()用给定的语句或者代码块替换表达式。如果给丁的代码块是一个空代码块,例如,如果replace("{}")
被执行,那么表达式将会从方法体中移除。
如果你想要插入一个语句(或代码块)在一个表达式的前/后,应该传入如下的代码块给replace():
{ before-statements; $_ = $proceed($$); after-statements; }
无论这个表达式是方法调用,属性访问,对象创建或其它。第二个语句将会是:
$_ = $proceed();
如果表达式是读访问,或者
$proceed($$);
如果表达式是写访问。
如果被instrument()扫描的方法被-g选项编译(类文件包含本地变量属性),目标表达式中的本地变量也可以在传入给replace()的源文本中获取。
javassist.expr.MethodCall
一个MethodCall对象表示了一个方法调用。MethodCall的replace()方法将方法调用替换成一个语句或代码块。它接收表示一个语句或代码块的源文本,有与传入insertBefore()的源文本相同的以$开头的标识符。
$0 |
方法调用的目标对象。这不等同于this,它表示this调用的对象。如果方法是静态的,$0 为null。 |
---|---|
$1 ,$2 ,… |
方法调用的参数。 |
$_ |
方法调用的返回值。 |
$r |
方法调用的返回类型。 |
$class |
一个java.lang.Class对象,它表示生命该方法的类。 |
$sig |
一个java.lang.Class对象数组,它表示正式的参数类型。 |
$type |
一个java.lang.Class对象,它表示方法的正式返回类型。 |
$proceed |
表达式中最初调用的方法的名称。 |
这里的方法调用是由MethodCall对象表示。
其它的标识符,例如$w
,$args
和$$
也可以使用。
除非方法调用的返回类型是void,在源文本中的$_
一定传入一个值,并且$_
的类型就是返回类型。如果返回类型是void,$_
的返回类型是Object且其值被忽略。
$procced
不是一个String值,而是一个特殊的语法。它后面跟着一个由()包围的参数列表。
javassist.expr.ConstructorCall
一个ConstructorCall对象表示一个构造方法的调用,例如构造方法体中包含的this()和super。ConstructorCall的replace()方法将构造方法的调用替换成语句或代码块。它接收表示替换语句或代码块的源文本,有与传入insertBefore()的源文本相同的以$开头的标识符。
$0 |
代码调用的目标对象。这与this等同。 |
---|---|
$1 ,$2 ,… |
构造函数调用的参数。 |
$class |
一个java.lang.Class对象,它表示声明该构造函数的类。 |
$sig |
一个java.lang.Class数组对象,它表示正式的参数类型。 |
$procced |
表达式中构造函数原始的调用名称。 |
这里构造函数调用由ConstructorCall对象所表示。
其它的标识符,例如$w
,$args
和$$
也可以使用。
因此构造函数调用要么是父类的构造函数或者另一个相同的类的构造函数,替换的语句必须包含构造函数调用,通常调用$procced()
。
$procced
不是一个String值,而是一个特殊的语法。它后面跟着一个由()包围的参数列表。
javassist.expr.FieldAccess
FieldAccess对象表示属性访问。如果属性访问被找到,ExprEditor的edit()方法接收这个对象。FieldAccess的replace()接收表示一个语句或代码块的源文本。
在源文本中,以$
开头的标识符有特殊的含义:
$0 |
包含表达式中要访问属性的类,这与this不等同。this表示包含表达式的方法被调用的对象。如果属性是静态的,$0 为null。 |
---|---|
$1 |
如果表达式是写访问,就表示将要被写入属性的值。否则,$1 无法使用。 |
$_ |
如果表达式是读访问,就表示属性访问的返回值。否则,存储在$_ 中的值会被释放。 |
$r |
如果表达式是读访问,表示属性的类型。否则,$r 是void。 |
$class |
一个java.lang.Class对象,表示声明该属性的类。 |
$type |
一个java.lang.Class对象,表示属性的类型。 |
$procced |
执行初始属性访问的虚拟方法的名称。 |
其它的标识符,例如$w
,$args
和$$
也可以使用。
如果表达式是读访问,在源文本中必将赋值给$_
。$_
的类型是属性的类型。