Javassist用法详解

Javassist⽤法详解
⽬录
概述
ClassPool
CtClass
CtMthod
CtField
CtConstructor
ClassPath
ClassLoader
⽰例
创建Class⽂件
调⽤⽣成的类对象
修改现有的类对象
概述
Java字节码以⼆进制的形式存储在.class⽂件中，每⼀个.class⽂件包含⼀个Java类或接⼝。

Javaassist就是⼀个⽤来处理Java字节码的类库。

它可以在⼀个已经编译好的类中添加新的⽅法，或者是修改已有的⽅法，并且不需要对字节码⽅⾯有深⼊的了解。

同时也可以通过完全⼿动的⽅式⽣成⼀个新的类对象。

Maven依赖⽅式：
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.27.0-GA</version>
</dependency>
Gradle依赖⽅式：
implementation 'org.javassist:javassist:3.27.0-GA'
ClassPool
ClassPool是CtClass对象的容器，它按需读取类⽂件来构造CtClass对象，并且保存CtClass对象以便以后使⽤。

从实现的⾓度来看，ClassPool 是⼀个存储 CtClass 的 Hash 表，类的名称作为 Hash 表的 key。

ClassPool 的 get() 函数⽤于从 Hash 表中查找 key 对应的 CtClass 对象。

如果没有找到，get() 函数会创建并返回⼀个新的 CtClass 对象，这个新对象会保存在 Hash 表中。

需要注意的是ClassPool会在内存中维护所有被它创建过的CtClass，当CtClass数量过多时，会占⽤⼤量的内存，API中给出的解决⽅案是重新创建ClassPool 或有意识的调⽤CtClass的detach()⽅法以释放内存。

ClassPool需要关注的⽅法：
getDefault：返回默认的ClassPool，⼀般通过该⽅法创建我们的ClassPool；
appendClassPath, insertClassPath：将⼀个ClassPath加到类搜索路径的末尾位置或插⼊到起始位置。

通常通过该⽅法写⼊额外的类搜索路径，以解决多个类加载器环境中找不到类的尴尬；
toClass：将修改后的CtClass加载⾄当前线程的上下⽂类加载器中，CtClass的toClass⽅法是通过调⽤本⽅法实现。

需要注意的是⼀旦调⽤该⽅法，则⽆法继续修改已经被加载的class；
makeClass：根据类名创建新的CtClass对象；
get，getCtClass：根据类路径名获取该类的CtClass对象，⽤于后续的编辑。

可以使⽤toBytecode()函数来获取修改过的字节码：
byte[] b = cc.toBytecode();
也可以通过toClass()函数直接将CtClass转换成Class对象:
Class clazz = cc.toClass();
toClass()会请求当前线程的ClassLoader加载CtClass所代表的类⽂件,它返回此类⽂件的ng.Class对象。

CtClass
CtClass类表⽰⼀个class⽂件，每个CtClass对象都必须从ClassPool中获取，CtClass需要关注的⽅法：freeze：冻结⼀个类，使其不可修改；
isFrozen：判断⼀个类是否已被冻结；
defrost：解冻⼀个类，使其可以被修改；
prune：删除类不必要的属性，以减少内存占⽤。

调⽤该⽅法后，许多⽅法⽆法将⽆法正常使⽤，慎⽤；
detach：将该class从ClassPool中删除；
writeFile：根据CtClass⽣成.class⽂件；
toClass：通过类加载器加载该CtClass；
addField，removeField：添加/移除⼀个CtField；
addMethod，removeMethod：添加/移除⼀个CtMethod；
addConstructor，removeConstructor：添加/移除⼀个CtConstructor。

如果⼀个 CtClass 对象通过 writeFile(), toClass(), toBytecode() 被转换成⼀个类⽂件，此 CtClass 对象会被冻结起来，不允许再修改，因为⼀个类只能被 JVM 加载⼀次。

但是，⼀个冷冻的 CtClass 也可以被解冻，例如：
CtClasss cc = ...;
cc.writeFile();
cc.defrost();
cc.setSuperclass(...); // 因为类已经被解冻，所以这⾥可以调⽤成功
调⽤ defrost() 之后，此 CtClass 对象⼜可以被修改了。

如果 ClassPool.doPruning 被设置为 true，Javassist 在冻结 CtClass 时，会修剪 CtClass 的数据结构。

为了减少内存的消耗，修剪操作会丢弃 CtClass 对象中不必要的属性。

例如，Code_attribute 结构会被丢弃。

⼀个 CtClass 对象被修改之后，⽅法的字节码是不可访问的，但是⽅法名称、⽅法签名、注解信息可以被访问。

修剪过的 CtClass 对象不能再次被解冻。

ClassPool.doPruning 的默认值为 false。

stopPruning() 可以⽤来驳回修剪操作。

CtClasss cc = ...;
cc.stopPruning(true);
cc.writeFile(); // 转换成⼀个 class ⽂件
// cc is not pruned.
这个 CtClass 没有被修剪，所以在 writeFile() 之后，可以被解冻。

注意：调试的时候可能临时需要停⽌修剪和冻结，然后保存⼀个修改过的类⽂件到磁盘，debugWriteFile() ⽅法正是为此准备的。

它停⽌修剪，然后写类⽂件，然后解冻并再次打开修剪（如果开始时修养是打开的）。

CtMthod
CtMthod代表类中的某个⽅法，可以通过CtClass提供的API获取或者构造⽅法或者 CtNewMethod.make()⽅法新建，通过CtMethod对象可以实现对⽅法的修改。

CtMethod中的⼀些重要⽅法：
insertBefore：在⽅法的起始位置插⼊代码；
insterAfter：在⽅法的所有 return 语句前插⼊代码以确保语句能够被执⾏，除⾮遇到exception；
insertAt：在指定的位置插⼊代码；
setBody：将⽅法的内容设置为要写⼊的代码，当⽅法被abstract修饰时，该修饰符被移除；
make：创建⼀个新的⽅法。

CtNewMethod是⼀个⽤来创建CtMethod实例的类，其⼀个make⽅法如下：
public static CtMethod make(int modifiers, CtClass returnType,
String mname, CtClass[] parameters,
CtClass[] exceptions,
String body, CtClass declaring)
throws CannotCompileException
{
try {
CtMethod cm
= new CtMethod(returnType, mname, parameters, declaring);
cm.setModifiers(modifiers);
cm.setExceptionTypes(exceptions);
cm.setBody(body);
return cm;
}
catch (NotFoundException e) {
throw new CannotCompileException(e);
}
}
也可以通过CtNewMethod.setter/getter⽅法为某个属性创建get/set⽅法：
CtClass cc = ...;
CtField param = ...;
cc.addMethod(CtNewMethod.setter("setName", param));
cc.addMethod(CtNewMethod.getter("getName", param));
CtField
CtField代表类中的某个属性，可以直接通过其构造⽅法创建实例：
CtClass cc = pool.makeClass("com.hearing.demo.Person");
CtField param = new CtField(pool.get("ng.String"), "name", cc);
param.setModifiers(Modifier.PRIVATE);
cc.addField(param, CtField.Initializer.constant("hearing"));
CtConstructor
CtConstructor代表类中的⼀个构造器，可以通过CtConstructor.make⽅法创建：
public static CtConstructor make(CtClass[] parameters,
CtClass[] exceptions,
String body, CtClass declaring)
throws CannotCompileException
{
try {
CtConstructor cc = new CtConstructor(parameters, declaring);
cc.setExceptionTypes(exceptions);
cc.setBody(body);
return cc;
}
catch (NotFoundException e) {
throw new CannotCompileException(e);
}
}
也可以通过构造⽅法直接创建：
CtConstructor cons = new CtConstructor(new CtClass[]{pool.get("ng.String")}, cc);
// $0=this / $1,$2,$3... 代表⽅法参数
cons.setBody("{$ = $1;}");
cc.addConstructor(cons);
ClassPath
ClassPath是⼀个接⼝，代表类的搜索路径，含有具体的搜索实现。

当通过其它途径⽆法获取要编辑的类时，可以尝试定制⼀个⾃⼰的ClassPath。

API提供的实现中值得关注的有：
ByteArrayClassPath：将类以字节码的形式加⼊到该path中，ClassPool可以从该path中⽣成所需的CtClass。

ClassClassPath：通过某个class⽣成的path，通过该class的classloader来尝试加载指定的类⽂件。

LoaderClassPath：通过某个classloader⽣成path，并通过该classloader搜索加载指定的类⽂件。

需要注意的是该类加载器以弱引⽤的⽅式存在于path中，当不存在强引⽤时，随时可能会被清理。

通过 ClassPool.getDefault() 获取的 ClassPool 使⽤ JVM 的类搜索路径。

如果程序运⾏在 JBoss 或者 Tomcat 等 Web 服务器上，ClassPool 可能⽆法找到⽤户的类，因为 Web 服务器使⽤多个类加载器作为系统类加载器。

在这种情况下，ClassPool 必须添加额外的类搜索路径。

下⾯的例⼦中，pool 代表⼀个 ClassPool 对象：
pool.insertClassPath(new ClassClassPath(this.getClass()));
上⾯的语句将 this 指向的类添加到 pool 的类加载路径中。

你可以使⽤任意 Class 对象来代替 this.getClass()，从⽽将 Class 对象添加到类加载路径中。

也可以注册⼀个⽬录作为类搜索路径。

下⾯的例⼦将 /usr/local/javalib 添加到类搜索路径中：
ClassPool pool = ClassPool.getDefault();
pool.insertClassPath("/usr/local/javalib");
类搜索路径不但可以是⽬录，还可以是 URL ：
ClassPool pool = ClassPool.getDefault();
ClassPath cp = new URLClassPath("", 80, "/java/", "org.javassist.");
pool.insertClassPath(cp);
此外，也可以直接传递⼀个 byte 数组给 ClassPool 来构造⼀个 CtClass 对象，完成这项操作，需要使⽤ ByteArrayPath 类。

⽰例：
ClassPool cp = ClassPool.getDefault();
byte[] b = a byte array;
String name = class name;
cp.insertClassPath(new ByteArrayClassPath(name, b));
CtClass cc = cp.get(name);
⽰例中的 CtClass 对象表⽰ b 代表的 class ⽂件。

将对应的类名传递给 ClassPool 的 get() ⽅法，就可以从ByteArrayClassPath 中读取到对应的类⽂件。

如果你不知道类的全名，可以使⽤ makeClass() ⽅法：
ClassPool cp = ClassPool.getDefault();
InputStream ins = an input stream for reading a class file;
CtClass cc = cp.makeClass(ins);
makeClass() 返回从给定输⼊流构造的 CtClass 对象。

你可以使⽤ makeClass() 将类⽂件提供给 ClassPool 对象。

如果搜索路径包含⼤的 jar ⽂件，这可能会提⾼性能。

由于 ClassPool 对象按需读取类⽂件，它可能会重复搜索整个 jar ⽂件中的每个类⽂件。

makeClass() 可以⽤于优化此搜索。

由 makeClass() 构造的 CtClass 保存在 ClassPool 对象中，从⽽使得类⽂件不会再被读取。

⽤户可以通过实现 ClassPath 接⼝来扩展类加载路径，然后调⽤ ClassPool 的 insertClassPath() ⽅法将路径添加进来。

这种技术主要⽤于将⾮标准资源添加到类搜索路径中。

ClassLoader
CtClass的toClass()⽅法请求当前线程的上下⽂类加载器，加载CtClass对象所表⽰的类：
public class Hello {
public void say() {
System.out.println("Hello");
}
}
public class Test {
public static void main(String[] args) throws Exception {
ClassPool cp = ClassPool.getDefault();
CtClass cc = cp.get("Hello");
CtMethod m = cc.getDeclaredMethod("say");
m.insertBefore("{ System.out.println(\"Hello.say():\"); }");
Class c = cc.toClass();
Hello h = (Hello) c.newInstance();
h.say();
}
}
注意：上⾯的程序要正常运⾏，Hello 类在调⽤ toClass() 之前不能被加载。

如果 JVM 在 toClass() 调⽤之前加载了原始的Hello 类，后续加载修改的 Hello 类将会失败（LinkageError 抛出）。

例如，如果 Test 中的 main() 是这样的：
public static void main(String[] args) throws Exception {
Hello orig = new Hello();
ClassPool cp = ClassPool.getDefault();
CtClass cc = cp.get("Hello");
}
那么，原始的 Hello 类在 main 的第⼀⾏被加载，toClass() 调⽤会抛出⼀个异常，因为类加载器不能同时加载两个不同版本的
Hello 类。

如果程序在某些应⽤程序服务器（如JBoss和Tomcat）上运⾏，toClass()使⽤的上下⽂类加载器可能是不合适的。

在这种情况下，你会看到⼀个意想不到的 ClassCastException。

为了避免这个异常，必须给 toClass() 指定⼀个合适的类加载器。

例如：
CtClass cc = ...;
Class c = cc.toClass(bean.getClass().getClassLoader());
应该给toClass()传递加载了你的程序的类加载器（上例中，bean对象的类），toClass() 是为了简便⽽提供的⽅法，如果你需要更复杂的功能，你应该编写⾃⼰的类加载器。

Javassit 提供⼀个类加载器 javassist.Loader。

它使⽤ javassist.ClassPool 对象来读取类⽂件。

例如，javassist.Loader 可以⽤于加载⽤ Javassist 修改过的类。

public class Main {
public static void main(String[] args) throws Throwable {
ClassPool pool = ClassPool.getDefault();
Loader cl = new Loader(pool);
CtClass ct = pool.get("test.Rectangle");
ct.setSuperclass(pool.get("test.Point"));
Class c = cl.loadClass("test.Rectangle");
Object rect = c.newInstance();
}
}
这个程序将 test.Rectangle 的超类设置为 test.Point。

然后再加载修改的类，并创建新的 test.Rectangle 类的实例。

如果⽤户希望在加载时按需修改类，则可以向 javassist.Loader 添加事件监听器。

当类加载器加载类时会通知监听器。

事件监听器类必须实现以下接⼝：
public interface Translator {
public void start(ClassPool pool)
throws NotFoundException, CannotCompileException;
public void onLoad(ClassPool pool, String classname)
throws NotFoundException, CannotCompileException;
}
当事件监听器通过 addTranslator() 添加到 javassist.Loader 对象时，start() ⽅法会被调⽤。

在 javassist.Loader 加载类之前，会调⽤ onLoad() ⽅法。

可以在 onLoad() ⽅法中修改被加载的类的定义。

例如，下⾯的事件监听器在类加载之前，将所有类更改为 public 类。

public class MyTranslator implements Translator {
void start(ClassPool pool) throws NotFoundException, CannotCompileException {}
void onLoad(ClassPool pool, String classname) throws NotFoundException, CannotCompileException {
CtClass cc = pool.get(classname);
cc.setModifiers(Modifier.PUBLIC);
}
}
注意，onLoad() 不必调⽤ toBytecode() 或 writeFile()，因为 javassist.Loader 会调⽤这些⽅法来获取类⽂件。

⽰例
创建Class⽂件
public class App {
public static void main(String[] args) {
try {
createPerson();
} catch (Exception e) {
e.printStackTrace();
}
}
private static void createPerson() throws Exception {
ClassPool pool = ClassPool.getDefault();
// 1. 创建⼀个空类
CtClass cc = pool.makeClass("com.hearing.demo.Person");
// 2. 新增⼀个字段 private String name = "hearing";
CtField param = new CtField(pool.get("ng.String"), "name", cc);
param.setModifiers(Modifier.PRIVATE);
cc.addField(param, CtField.Initializer.constant("hearing"));
// 3. ⽣成 getter、setter ⽅法
cc.addMethod(CtNewMethod.setter("setName", param));
cc.addMethod(CtNewMethod.getter("getName", param));
// 4. 添加⽆参的构造函数
CtConstructor cons = new CtConstructor(new CtClass[]{}, cc);
cons.setBody("{name = \"hearing\";}");
cc.addConstructor(cons);
// 5. 添加有参的构造函数
cons = new CtConstructor(new CtClass[]{pool.get("ng.String")}, cc);
// $0=this / $1,$2,$3... 代表⽅法参数
cons.setBody("{$ = $1;}");
cc.addConstructor(cons);
// 6. 创建⼀个名为printName⽅法，⽆参数，⽆返回值，输出name值
CtMethod ctMethod = new CtMethod(CtClass.voidType, "printName", new CtClass[]{}, cc); ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("{System.out.println(name);}");
cc.addMethod(ctMethod);
//这⾥会将这个创建的类对象编译为.class⽂件
cc.writeFile("/.../path/");
}
}
创建的class⽂件如下：
//
// Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.hearing.demo;
public class Person {
private String name = "hearing";
public void setName(String var1) {
= var1;
}
public String getName() {
return ;
}
public Person() {
= "hearing";
}
public Person(String var1) {
= var1;
}
public void printName() {
System.out.println();
}
}
调⽤⽣成的类对象
1.通过反射的⽅式调⽤：
Object person = cc.toClass().newInstance();
Method setName = person.getClass().getMethod("setName", String.class);
setName.invoke(person, "hearing1");
Method execute = person.getClass().getMethod("printName");
execute.invoke(person);
2.通过读取class⽂件的⽅式调⽤：
ClassPool pool = ClassPool.getDefault();
// 设置类路径
pool.appendClassPath("/.../path/");
CtClass ctClass = pool.get("com.hearing.demo.Person");
Object person = ctClass.toClass().newInstance();
// 下⾯和通过反射的⽅式⼀样去使⽤
3.通过接⼝的⽅式：
上⾯两种其实都是通过反射的⽅式去调⽤，问题在于我们的⼯程中其实并没有这个类对象，所以反射的⽅式⽐较⿇烦，并且开销也很⼤。

那么如果你的类对象可以抽象为⼀些⽅法的合集，就可以考虑为该类⽣成⼀个接⼝类。

这样在newInstance()的时候我们就可以强转为接⼝，可以将反射的那⼀套省略掉了。

还拿上⾯的Person类来说，新建⼀个IPerson接⼝类：
public interface IPerson {
void setName(String name);
String getName();
void printName();
}
实现部分的代码如下：
ClassPool pool = ClassPool.getDefault();
pool.appendClassPath("/.../path/");
// 获取接⼝
CtClass codeClassI = pool.get("com.hearing.demo.IPerson");
// 获取上⾯⽣成的类
CtClass ctClass = pool.get("com.hearing.demo.Person");
// 使代码⽣成的类，实现 IPerson 接⼝
ctClass.setInterfaces(new CtClass[]{codeClassI});
// 以下通过接⼝直接调⽤强转
IPerson person = (IPerson)ctClass.toClass().newInstance();
System.out.println(person.getName());
person.setName("hearing1");
person.printName();
修改现有的类对象
有如下类对象：
public class Test {
public void test1() {
System.out.println("I am test1");
}
}
然后进⾏修改：
public class App {
public static void main(String[] args) {
try {
update();
} catch (Exception e) {
e.printStackTrace();
}
}
private static void update() throws Exception {
ClassPool pool = ClassPool.getDefault();
CtClass cc = pool.get("com.hearing.demo.Test");
CtMethod personFly = cc.getDeclaredMethod("test1");
personFly.insertBefore("System.out.println(\"...before...\");");
personFly.insertAfter("System.out.println(\"...after...\");");
//新增⼀个⽅法
CtMethod ctMethod = new CtMethod(CtClass.voidType, "test2", new CtClass[]{}, cc);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("{System.out.println(\"I am test2\");}");
cc.addMethod(ctMethod);
Object test = cc.toClass().newInstance();
Method personFlyMethod = test.getClass().getMethod("test1");
personFlyMethod.invoke(test);
Method execute = test.getClass().getMethod("test2");
execute.invoke(test);
}
}
需要注意的是：上⾯的insertBefore() 和 setBody()中的语句，如果是单⾏语句可以直接⽤双引号，但是有多⾏语句的情况下，需要将多⾏语句⽤{}括起来。

javassist只接受单个语句或⽤⼤括号括起来的语句块。

以上就是Javassist⽤法详解的详细内容，更多关于Javassist⽤法的资料请关注其它相关⽂章！。