javassist入门总结介绍

概要

javassist本身是一个类库，旨在帮助开发者简化对java字节码的操作。开发者可以藉由javassist在源码级别（source level）和字节码级别（bytecode level）对java字节码进行操作。作为一般开发者，我理解我们只需要重点关注source level级别的就够了。然后再借助JDPA机制，就可以实现无侵入地对jar进行字节码增强了。

核心类

• ClassPool

可以理解为是一个入口容器，所有需要修改的类（对应CtClass）均需由这个类获取。
典型例子如下

ClassPool pool = ClassPool.getDefault();
CtClass cc = pool.get("test.Rectangle");

• CtClass： compile-time class

由ClassPool返回，任何要对类的字节码操作，均通过此类进行。通过调用writeFile()和toBytecode()方法获取修改后的字节码文件。

常见基本流程

//获取CtClass
ClassPool cp = ClassPool.getDefault();
CtClass cc  = cp.get("");

//字节码增强
CtMethod method = cc.getDeclaredMethod("");
method.insertBefore("System.out.println(\"insert before : \" + $1);");
method.insertAfter("{$_ = $_ + \"[insert after]\";}");

// 返回字节码
// byte[] clazzByte = cc.toBytecode();

//返回修改后的字节码
Class clazz = cc.toClass();

// 实例对象
Object newEnhancedObject = clazz.newInstance();

常见操作

1. 定义一个新类

ClassPool pool = ClassPool.getDefault();
CtClass cc = pool.makeClass("Point");

定义新方法可以通过CtNewMethod类完成，方法或者接口的添加方法有：CtClass#addMethod、CtClass#makeInterface

2.类冻结

如果调用了CtClass的writeFile(), toClass()或者toBytecode()，那么CtClass就会被冻结（预期类已经加载到jvm了，用户应该不会有其它修改），不允许编辑。可以通过defrost()方法取消冻结。

3.类查找路径设置

默认情况下，ClassPool的类查找目录和底层依托的JVM的类查找目录相同。但是很多情况下，用户可能会有多个自定义的类目录。因此，可以通过insertClassPath命令，添加比如来自本地文件、网络或者字节码数组到ClassPool的类查找目录中。

注意事项

1. 避免内存损耗

1.1 新增方法内存损耗

在从ClassPool中获取CtClass后，比如增加了一个新方法，那么需要找到原先类的所有实例，这样会引起极大的内存损耗，因此，需要注意及时清理内存。

CtClass cc = ... ;
cc.writeFile();
cc.detach();

1.2 ClassPool内存损耗

不要一直使用同一个ClassPool。要在需要的时候，重新实例化ClassPool（丢弃旧的）

ClassPool cp = new ClassPool(true);
// if needed, append an extra search path by appendClassPath()

2.局部变量访问

增强区块可以访问类字段或者方法，也可以访问增强方法的入参。但是无法访问方法内的局部变量（新增局部变量倒是可以的-CtMethod#addLocalVariable）。有一个特殊，如果使用的是insertAt方法，如果在插入的那行有某个局部变量并且对应方法使用-g选项编译，那么就可以访问到这个局部变量。

总结： javassist提供的支持及局限

支持：

（1）对方法进行增强；
（2）新增字段、方法；
（3）修改原方法体；

借助 ExprEditor对方法体进行修改，例如：

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($$); }");
        }
    });

（4）移除字段、方法。

局限：

（1）不支持内部类；
（2）不支持枚举、泛型（源码层面）；
（3）针对方法重载，会产生混淆（错误调用）；
（4）不支持continue和break标签；
（5）不支持数组初始化方式；
（6）javassist的编译器不支持自动拆装箱（即类似，"Integer i = 1"这种语句是非法的）

javassist调试功能

设置 CtClass.debugDump，指定一个目录，则所有编译过的类文件会在那个目录下。如果需要取消debug，将属性置null即可。
例如：CtClass.debugDump = "./dump";

附录

常见插入符号

$0, $1, $2, ...     this and actual parameters
$args               An array of parameters. The type of $args is Object[].
$$                  All actual parameters.
                    For example, m($$) is equivalent to m($1,$2,...)
 
$cflow(...)         cflow variable
$r                  The result type. It is used in a cast expression.
$w                  The wrapper type. It is used in a cast expression.
$_                  The resulting value
$sig                An array of java.lang.Class objects representing the formal parameter types.
$type               A java.lang.Class object representing the formal result type.
$class              A java.lang.Class object representing the class currently edited.