javassist使⽤全解析
Java 字节码以⼆进制的形式存储在 .class ⽂件中，每⼀个 .class ⽂件包含⼀个 Java 类或接⼝。Javaassist 就是⼀个⽤来处理 Java 字节码的类库。它可以在⼀个已经编译好的类中添加新的⽅法，或者是修改已有的⽅法，并且不需要对字节码⽅⾯有深⼊的了解。同时也可以去⽣成⼀个新的类对象，通过完全⼿动的⽅式。
1. 使⽤ Javassist 创建⼀个 class ⽂件
⾸先需要引⼊jar包：
<dependency>
<groupId>org.javassist</groupId>
<artifactId>javassist</artifactId>
<version>3.25.0-GA</version>
</dependency>
编写创建对象的类：
package com.rickiyang.learn.javassist;
import javassist.*;
/**
* @author rickiyang
* @date 2019-08-06
* @Desc
*/
public class CreatePerson {
/**
* 创建⼀个Person 对象
*
* @throws Exception
*/
public static void createPseson() throws Exception {
ClassPool pool = Default();
// 1. 创建⼀个空类
CtClass cc = pool.makeClass("com.rickiyang.learn.javassist.Person");
// 2. 新增⼀个字段 private String name;
// 字段名为name
CtField param = new ("java.lang.String"), "name", cc);
// 访问级别是 private
param.setModifiers(Modifier.PRIVATE);
// 初始值是 "xiaoming"
cc.addField(param, stant("xiaoming"));
// 3. ⽣成 getter、setter ⽅法
cc.addMethod(CtNewMethod.setter("setName", param));
cc.("getName", param));
// 4. 添加⽆参的构造函数
CtConstructor cons = new CtConstructor(new CtClass[]{}, cc);
cons.setBody("{name = \"xiaohong\";}");
cc.addConstructor(cons);
// 5. 添加有参的构造函数
cons = new CtConstructor(new CtClass[]{("java.lang.String")}, cc);
// $0=this / $1,$2,$3... 代表⽅法参数
cons.setBody("{$0.name = $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("/Users/yangyue/workspace/springboot-learn/java-agent/src/main/java/");
}
public static void main(String[] args) {
try {
createPseson();
} catch (Exception e) {
e.printStackTrace();
}
}
}
执⾏上⾯的 main 函数之后，会在指定的⽬录内⽣成 Person.class ⽂件：
//
/
/ Source code recreated from a .class file by IntelliJ IDEA
// (powered by Fernflower decompiler)
//
package com.rickiyang.learn.javassist;
public class Person {
private String name = "xiaoming";
public void setName(String var1) {
this.name = var1;
}
public String getName() {
return this.name;
}
public Person() {
this.name = "xiaohong";
}
public Person(String var1) {
this.name = var1;
}
public void printName() {
System.out.println(this.name);
}
}
跟咱们预想的⼀样。
在 Javassist 中，类Javaassit.CtClass表⽰ class ⽂件。⼀个 GtClass (编译时类）对象可以处理⼀个 class ⽂件，ClassPool是CtClass对象的容器。它按需读取类⽂件来构造CtClass对象，并且保存CtClass对象以便以后使⽤。
需要注意的是 ClassPool 会在内存中维护所有被它创建过的 CtClass，当 CtClass 数量过多时，会占⽤⼤量的内存，API中给出的解决⽅案是有意识的调⽤CtClass的detach()⽅法以释放内存。
ClassPool需要关注的⽅法：
1. getDefault : 返回默认的ClassPool是单例模式的，⼀般通过该⽅法创建我们的ClassPool；
2. appendClassPath, insertClassPath : 将⼀个ClassPath加到类搜索路径的末尾位置或插⼊到起始位置。通常通过该⽅法写⼊额外的类搜
索路径，以解决多个类加载器环境中不到类的尴尬；
3. toClass : 将修改后的CtClass加载⾄当前线程的上下⽂类加载器中，CtClass的toClass⽅法是通过调⽤本⽅法实现。需要注意的是⼀旦
调⽤该⽅法，则⽆法继续修改已经被加载的class；
4. get , getCtClass : 根据类路径名获取该类的CtClass对象，⽤于后续的编辑。
CtClass需要关注的⽅法：
1. freeze : 冻结⼀个类，使其不可修改；
2. isFrozen : 判断⼀个类是否已被冻结；
3. prune : 删除类不必要的属性，以减少内存占⽤。调⽤该⽅法后，许多⽅法⽆法将⽆法正常使⽤，慎⽤；
4. defrost : 解冻⼀个类，使其可以被修改。如果事先知道⼀个类会被defrost，则禁⽌调⽤ prune ⽅法；
5. detach : 将该class从ClassPool中删除；
6. writeFile : 根据CtClass⽣成.class⽂件；
7. toClass : 通过类加载器加载该CtClass。
上⾯我们创建⼀个新的⽅法使⽤了CtMethod类。CtMthod代表类中的某个⽅法，可以通过CtClass提供的API获取或者CtNewMethod新建，通过CtMethod对象可以实现对⽅法的修改。
CtMethod中的⼀些重要⽅法：
1. insertBefore : 在⽅法的起始位置插⼊代码；
2. insterAfter : 在⽅法的所有 return 语句前插⼊代码以确保语句能够被执⾏，除⾮遇到exception；
3. insertAt : 在指定的位置插⼊代码；
4. setBody : 将⽅法的内容设置为要写⼊的代码，当⽅法被 abstract修饰时，该修饰符被移除；
5. make : 创建⼀个新的⽅法。
注意到在上⾯代码中的：setBody()的时候我们使⽤了⼀些符号：
// $0=this / $1,$2,$3... 代表⽅法参数
cons.setBody("{$0.name = $1;}");
具体还有很多的符号可以使⽤，但是不同符号在不同的场景下会有不同的含义，所以在这⾥就不在赘述，可以看javassist 的说明⽂档。2. 调⽤⽣成的类对象
1. 通过反射的⽅式调⽤
上⾯的案例是创建⼀个类对象然后输出该对象编译完之后的 .class ⽂件。那如果我们想调⽤⽣成的类对象中的属性或者⽅法应该怎么去做呢？javassist也提供了相应的api，⽣成类对象的代码还是和第⼀段⼀样，将最后写⼊⽂件的代码替换为如下：
// 这⾥不写⼊⽂件，直接实例化
Object person = cc.toClass().newInstance();
// 设置值
Method setName = Class().getMethod("setName", String.class);
setName.invoke(person, "cunhua");
// 输出值
Method execute = Class().getMethod("printName");
execute.invoke(person);
然后执⾏main⽅法就可以看到调⽤了printName⽅法。
2. 通过读取 .class ⽂件的⽅式调⽤
ClassPool pool = Default();
// 设置类路径
pool.appendClassPath("/Users/yangyue/workspace/springboot-learn/java-agent/src/main/java/");
CtClass ctClass = ("com.rickiyang.learn.javassist.Person");
Object person = Class().newInstance();
//  ...... 下⾯和通过反射的⽅式⼀样去使⽤
3. 通过接⼝的⽅式
上⾯两种其实都是通过反射的⽅式去调⽤，问题在于我们的⼯程中其实并没有这个类对象，所以反射的⽅式⽐较⿇烦，并且开销也很⼤。那么如果你的类对象可以抽象为⼀些⽅法得合集，就可以考虑为该类⽣成⼀个接⼝类。这样在newInstance()的时候我们就可以强转为接⼝，可以将反射的那⼀套省略掉了。
还拿上⾯的Person类来说，新建⼀个PersonI接⼝类：
package com.rickiyang.learn.javassist;
/**
* @author rickiyang
* @date 2019-08-07
* @Desc
*/
public interface PersonI {
void setName(String name);
String getName();
void printName();
}
实现部分的代码如下：
ClassPool pool = Default();
pool.appendClassPath("/Users/yangyue/workspace/springboot-learn/java-agent/src/main/java/");
// 获取接⼝
CtClass codeClassI = ("com.rickiyang.learn.javassist.PersonI");
// 获取上⾯⽣成的类
CtClass ctClass = ("com.rickiyang.learn.javassist.Person");
// 使代码⽣成的类，实现 PersonI 接⼝
ctClass.setInterfaces(new CtClass[]{codeClassI});
// 以下通过接⼝直接调⽤强转
PersonI person = (Class().newInstance();
System.out.Name());
person.setName("xiaolv");
person.printName();
使⽤起来很轻松。
2. 修改现有的类对象
前⾯说到新增⼀个类对象。这个使⽤场景⽬前还没有遇到过，⼀般会遇到的使⽤场景应该是修改已有的类。⽐如常见的⽇志切⾯，权限切⾯。我们利⽤javassist来实现这个功能。
有如下类对象：
package com.rickiyang.learn.javassist;
/**
* @author rickiyang
* @date 2019-08-07
* @Desc
*/
public class PersonService {
public void getPerson(){
System.out.println("get Person");
}
public void personFly(){
System.out.println("oh my god,I can fly");
}
}
然后对他进⾏修改：
package com.rickiyang.learn.javassist;
import javassist.ClassPool;
import javassist.CtClass;
import javassist.CtMethod;
import javassist.Modifier;
import flect.Method;
/**
* @author rickiyang
* @date 2019-08-07
* @Desc
*/
public class UpdatePerson {
public static void update() throws Exception {
ClassPool pool = Default();
CtClass cc = ("com.rickiyang.learn.javassist.PersonService");
CtMethod personFly = cc.getDeclaredMethod("personFly");
personFly.insertBefore("System.out.println(\"起飞之前准备降落伞\");");
personFly.insertAfter("System.out.println(\"成功落地。。。。\");");
//新增⼀个⽅法
CtMethod ctMethod = new CtMethod(CtClass.voidType, "joinFriend", new CtClass[]{}, cc);
ctMethod.setModifiers(Modifier.PUBLIC);
ctMethod.setBody("{System.out.println(\"i want to be your friend\");}");
cc.addMethod(ctMethod);
Object person = cc.toClass().newInstance();
// 调⽤ personFly ⽅法
Method personFlyMethod = Class().getMethod("personFly");
personFlyMethod.invoke(person);
//调⽤ joinFriend ⽅法
Method execute = Class().getMethod("joinFriend");
execute.invoke(person);
}springboot其实就是spring
public static void main(String[] args) {
try {
update();
} catch (Exception e) {
e.printStackTrace();
}
}
}
在personFly⽅法前后加上了打印⽇志。然后新增了⼀个⽅法joinFriend。执⾏main函数可以发现已经添加上了。
另外需要注意的是：上⾯的insertBefore()和setBody()中的语句，如果你是单⾏语句可以直接⽤双引号，但是有多⾏语句的情况下，你需要将多⾏语句⽤{}括起来。javassist只接受单个语句或⽤⼤括号括起来的语句块。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。