关于后端:字节码操作的手术刀Javassist

5次阅读

共计 3930 个字符，预计需要花费 10 分钟才能阅读完成。

后面文章介绍的 ASM 入门门槛还是挺高的，须要跟底层的字节码指令打交道，长处是玲珑、性能好。Javassist 是一个性能比 ASM 稍差然而应用起来简略很多的字节码操作库，不须要理解字节码指令，由东京工业大学的数学和计算机科学系的传授 Shigeru Chiba 开发.

Javassist 是能够动静编辑 Java 字节码的类库。它能够在 Java 程序运行时定义一个新的类，并加载到 JVM 中；还能够在 JVM 加载时批改一个类文件。Javassist 使用户不用关怀字节码相干的标准也是能够编辑类文件的。

动静代理 Javassist 能够在运行时生成代理类，从而实现 AOP 编程，比方在办法调用前后减少日志、权限管制等性能。
动静生成类 Javassist 能够在运行时动静地生成新的类，这个个性在一些框架中被宽泛应用。
类文件编辑 Javassist 能够在运行时批改类的字节码，从而实现一些性能，比方动静批改类的字段、办法等。
字节码剖析 Javassist 能够对字节码进行剖析，提取类的构造信息，比方类名、字段、办法等。

在 Javassist 中每个须要编辑的 class 都对应一个 CtClass，CtClass 的含意是编译时的类（”compile time class”），这些类会存储在 ClassPool 中，ClassPool 是一个容器，存储了一系列 CtClass 对象。

Javassist 的 API 与 Java 反射 API 比拟类似，Java 类蕴含的字段、办法在 Javassist 中别离对应 CtField 和 CtMethod，通过 CtClass 对象就能够给类新增字段、批改办法了。

对应一个 class 文件，CtMethod 对应一个办法，ClassPool 是 CtClass 的汇合。

CtClass 的 writeFile 能够将生成的 class 文件输入到指定目录中。新建一个 Hello 类能够用上面的代码：

ClassPool cp = ClassPool.getDefault();
CtClass ct = cp.makeClass("ya.me.Hello");
ct.writeFile("./out");

运行下面的代码，out 目录下就生成了一个 Hello 类，内容如下：

package ya.me;

public class Hello {public Hello() {}}

给已有类新增办法
有一个空的 MyMain 类，如下所示：

public class MyMain {

}

接下来用 Javassist 给它新增一个 foo 办法。

ClassPool cp = ClassPool.getDefault();
cp.insertClassPath("/path/to/MyMain.class");
CtClass ct = cp.get("MyMain");
CtMethod method = new CtMethod(
        CtClass.voidType,
        "foo",
        new CtClass[]{CtClass.intType, CtClass.intType},
        ct);
method.setModifiers(Modifier.PUBLIC);
ct.addMethod(method);
ct.writeFile("./out");

查看生成 MyMain 类能够看到生成了 foo 办法

public void foo(int var1, int var2) {
}

CtMethod 提供了几个实用的办法来批改办法体：

setBody 办法来替换整个办法体，setBody 办法接管一段源代码字符串，Javassist 会将这段源码字符串编译为字节码，替换原有的办法体。
insertBefore、insertAfter：在办法开始和完结插入语句。
```
public int foo(int a, int b) {return a + b;}
```
比方想把 foo 办法体批改为 “return 0;”，能够这么批改：
```
...
CtMethod method = ct.getMethod("foo", "(II)I");
method.setBody("return 0;");
...
```
生成的批改过的 foo 办法如下：
```
public int foo(int var1, int var2) {return 0;}   
```
如果想把 foo 办法体的 a + b; 批改为 “a * b”，是不是能够用上面的代码：

method.setBody("return a * b;")

运行报错，提醒找不到字段 a：

Exception in thread "main" javassist.CannotCompileException:  no such field: a
    at javassist.CtBehavior.setBody(CtBehavior.java:474)
    at javassist.CtBehavior.setBody(CtBehavior.java:440)
    at JavassistTest2.main(JavassistTest2.java:17)
Caused by: compile error: no such field: a

这是因为源代码在 javac 编译当前，局部变量名字都被抹去了，只留下了类型和局部变量表的地位，比方下面的 a 和 b 对应局部变量表 1 和 2 的地位，地位 0 由 this 占用。

在 Javassist 中拜访办法参数应用 $0 $1 ...，而不是间接应用变量名，把下面的代码改为：

method.setBody("return $1 * $2;");

生成新的 MyMain 类中 foo 办法曾经变

public int foo(int var1, int var2) {return var1 * var2;}

除了办法的参数，Javassist 定义了以 $ 结尾的非凡标识符，如下表所示：

上面来逐个介绍

$0 $1 $2 ... 办法参数
0 等价于 this，如果是静态方法 $0 不可用，从 $1 开始顺次示意办法参数
$args 参数
$args变量示意所有参数的数组，它是一个 Object 类型的数组，如果参数中有原始类型，会被转为对应的对象类型，比方下面 foo(int a, int b) 对应的 $args 为
```
new Object[]{ new Integer(a), new Integer(b) }
```
?参数
? 参数示意所有的参数的开展，参数间接用逗号分隔，
```
foo(?)
```
相当于：
```
foo($1, $2, ...)
```
$cflow
$cflow 是 “control flow” 的缩写，这是一个只读的属性，示意某办法递归调用的深度。一个典型的应用场景是监控某递归办法执行的工夫，只想记录一次最顶层调用的工夫，能够应用 $cflow 来判断以后递归调用的深度，如果不是最顶层调用疏忽记录时间。

比方上面的计算 fibonacci 的办法：

public long fibonacci(int n) {if (n <= 1) return n;
    else return fibonacci(n-1) + fibonacci(n-2);
}

如果只想在第一次调用的时候执行打印，能够用上面的的代码：

CtMethod method = ct.getMethod("fibonacci", "(I)J");
method.useCflow("fibonacci");
method.insertBefore("if ($cflow(fibonacci) == 0) {" +
            "System.out.println(\"fibonacci init \"+ $1);" +
        "}"
);

执行生成的 MyMain，能够看到只输入了一次打印：

java -cp /path/to/javassist.jar:. MyMain
fibonacci init 10

$_ 参数
CtMethod 的 insertAfter() 办法在指标办法的开端插入一段代码。$_ 来示意办法的返回值，在 insertAfter 办法能够援用。比方上面的代码：
```
method.insertAfter("System.out.println(\"result: \"+ $_);");
```
查看反编译生成的 class 文件：
```
public int foo(int a, int b) {
  int var4 = a + b;
  System.out.println(var4);
  return var4;
}
```
仔细的读者看到这里会有疑难，如果是办法异样退出，它的办法返回值是什么呢？如果 foo 代码如下：
```
public int foo(int a, int b) {
  int c = 1 / 0;
  return a + b;
}
```
执行上的改写后，反编译当前代码如下：
```
public int foo(int a, int b) {
  int c = 1 / 0;
  int var5 = a + b;
  System.out.println(var5);
  return var5;
}
```
这种状况下，代码块抛出异样，是无奈执行插入的语句的。如果想代码抛出异样的时候也能执行，就须要把 insertAfter 的第二个参数 asFinally 设置为 true：
```
method.insertAfter("System.out.println(\"result: \"+ $_);", true);
```
执行输入后果如下，能够看到曾经输入了 “result: 0”

result: 0
Exception in thread "main" java.lang.ArithmeticException: / by zero
        at MyMain.foo(MyMain.java:9)
        at MyMain.main(MyMain.java:6)

还有几个 Javassist 提供的内置变量（$r 等），用的非常少，这里不再介绍，具体能够查看 javassist 的官网。

本文的内容次要介绍了 Javassist 这个十分宽泛的字节码改写工具，具体介绍了它们的 API 和常见应用场景，后续咱们将看到更多这两个工具的利用。

本文由 mdnice 多平台公布

正文完