Javassist的使用
简介
- Java 字节码以二进制的形式存储在 .class 文件中。Javaassist 是一个用来处理 Java 字节码的类库。它可以在一个已经编译好的类中添加新的方法,或者是修改已有的方法,并且不需要对字节码方面有深入的了解。
- 建议同时学习Javaagent,与配合Javaagent配合可以产生魔法般的体验,使Java能够在动态语言中有点发言权。
- 让你修改class文件像在编译器中写代码一样,直接使用源代码修改class文件。
使用场景
- 当拿到一个没有开源的jar时,如果想修改里面的某一个类普通的方法就是,将整个jar包反编译下来修改并重新编译,但是如果使用javassist你就可以只单独修改一个类,修改完成后替换进jar包即可。
- 可以在运行期间动态的生成方法,字段,类等几乎所有java类型。
创建一个类
编写创建对象的类:
1 | Copypackage com.rickiyang.learn.javassist; |
执行上面的 main 函数之后,会在指定的目录内生成 Person.class 文件:
1 | Copy// |
跟咱们预想的一样。
在 Javassist 中,类 Javaassit.CtClass
表示 class 文件。一个 GtClass (编译时类)对象可以处理一个 class 文件,ClassPool
是 CtClass
对象的容器。它按需读取类文件来构造 CtClass
对象,并且保存 CtClass
对象以便以后使用。
需要注意的是 ClassPool 会在内存中维护所有被它创建过的 CtClass,当 CtClass 数量过多时,会占用大量的内存,API中给出的解决方案是 有意识的调用CtClass
的detach()
方法以释放内存。
ClassPool
需要关注的方法:
- getDefault : 返回默认的
ClassPool
是单例模式的,一般通过该方法创建我们的ClassPool; - appendClassPath, insertClassPath : 将一个
ClassPath
加到类搜索路径的末尾位置 或 插入到起始位置。通常通过该方法写入额外的类搜索路径,以解决多个类加载器环境中找不到类的尴尬; - toClass : 将修改后的CtClass加载至当前线程的上下文类加载器中,CtClass的
toClass
方法是通过调用本方法实现。需要注意的是一旦调用该方法,则无法继续修改已经被加载的class; - get , getCtClass : 根据类路径名获取该类的CtClass对象,用于后续的编辑。
CtClass
需要关注的方法:
- freeze : 冻结一个类,使其不可修改;
- isFrozen : 判断一个类是否已被冻结;
- prune : 删除类不必要的属性,以减少内存占用。调用该方法后,许多方法无法将无法正常使用,慎用;
- defrost : 解冻一个类,使其可以被修改。如果事先知道一个类会被defrost, 则禁止调用 prune 方法;
- detach : 将该class从ClassPool中删除;
- writeFile : 根据CtClass生成
.class
文件; - toClass : 通过类加载器加载该CtClass。
上面我们创建一个新的方法使用了CtMethod
类。CtMthod代表类中的某个方法,可以通过CtClass提供的API获取或者CtNewMethod新建,通过CtMethod对象可以实现对方法的修改。
CtMethod
中的一些重要方法:
- insertBefore : 在方法的起始位置插入代码;
- insterAfter : 在方法的所有 return 语句前插入代码以确保语句能够被执行,除非遇到exception;
- insertAt : 在指定的位置插入代码;
- setBody : 将方法的内容设置为要写入的代码,当方法被 abstract修饰时,该修饰符被移除;
- make : 创建一个新的方法。
注意到在上面代码中的:setBody()的时候我们使用了一些符号:
1 | Copy// $0=this / $1,$2,$3... 代表方法参数 |
具体还有很多的符号可以使用,但是不同符号在不同的场景下会有不同的含义,所以在这里就不在赘述,可以看javassist 的说明文档。http://www.javassist.org/tutorial/tutorial2.html
2. 调用生成的类对象[#]
1. 通过反射的方式调用
上面的案例是创建一个类对象然后输出该对象编译完之后的 .class 文件。那如果我们想调用生成的类对象中的属性或者方法应该怎么去做呢?javassist也提供了相应的api,生成类对象的代码还是和第一段一样,将最后写入文件的代码替换为如下:
1 | Copy// 这里不写入文件,直接实例化 |
然后执行main方法就可以看到调用了 printName
方法。
2. 通过读取 .class 文件的方式调用
1 | CopyClassPool pool = ClassPool.getDefault(); |
3. 通过接口的方式
上面两种其实都是通过反射的方式去调用,问题在于我们的工程中其实并没有这个类对象,所以反射的方式比较麻烦,并且开销也很大。那么如果你的类对象可以抽象为一些方法得合集,就可以考虑为该类生成一个接口类。这样在newInstance()
的时候我们就可以强转为接口,可以将反射的那一套省略掉了。
还拿上面的Person
类来说,新建一个PersonI
接口类:
1 | Copypackage com.rickiyang.learn.javassist; |
实现部分的代码如下:
1 | CopyClassPool pool = ClassPool.getDefault(); |
使用起来很轻松。
2. 修改现有的类对象[#]
前面说到新增一个类对象。这个使用场景目前还没有遇到过,一般会遇到的使用场景应该是修改已有的类。比如常见的日志切面,权限切面。我们利用javassist来实现这个功能。
有如下类对象:
1 | Copypackage com.rickiyang.learn.javassist; |
然后对他进行修改:
1 | Copypackage com.rickiyang.learn.javassist; |
在personFly
方法前后加上了打印日志。然后新增了一个方法joinFriend
。执行main函数可以发现已经添加上了。
另外需要注意的是:上面的insertBefore()
和 setBody()
中的语句,如果你是单行语句可以直接用双引号,但是有多行语句的情况下,你需要将多行语句用{}
括起来。javassist只接受单个语句或用大括号括起来的语句块。
作者: rickiyang
- 本文作者: GermMC
- 本文链接: http://blog.germmc.com/2020/04/16/Javassist使用详解/
- 版权声明: 本博客所有文章除特别声明外,均采用 MIT 许可协议。转载请注明出处!