javassist使用并生成动态代理

我不是女神ヾ 2022-09-10 08:14 232阅读 0赞

Javaassist 就是一个用来 处理 Java 字节码的类库。它可以在一个已经编译好的类中添加新的方法，或者是修改已有的方法，并且不需要对字节码方面有深入的了解。同时也可以去生成一个新的类对象，通过完全手动的方式。

首先需要引入jar包：

<dependency>
    
      <groupId>org.javassist</groupId>
    
      <artifactId>javassist</artifactId>
    
      <version>3.25.0-GA</version>
    
    </dependency>

示例：创建Person类的字节码

import javassist.*;
    
    public class CreatePerson {
        private static void createPerson() throws Exception {
            ClassPool pool = ClassPool.getDefault();
    
            // 1. 创建一个空类，类的全限定名
            CtClass cc =pool.makeClass("xxx.javassist.Person");
    
            // 2. 新增一个字段 private String name;
            // 字段名为name
            CtField  fName = new CtField(pool.get("java.lang.String"), "name", cc);
            // 访问级别是 private
            fName.setModifiers(Modifier.PRIVATE);
            //设置初始值 Tom
            cc.addField(fName, CtField.Initializer.constant("Tom"));
    
            //生成setter、getter方法
            cc.addMethod(CtNewMethod.setter("setName", fName));
            cc.addMethod(CtNewMethod.getter("getName", fName));
    
            // 4. 添加无参的构造函数
            CtConstructor cons = new CtConstructor(new CtClass[]{}, cc);
            cons.setBody("{name = \"Tom\";}");
            cc.addConstructor(cons);
    
            // 5. 添加有参的构造函数
            cons = new CtConstructor(new CtClass[]{pool.get("java.lang.String")}, cc);
            // $0=this / $1,$2,$3... 代表方法参数
            cons.setBody("$0.name = $1;");
            cc.addConstructor(cons);
    
    
            CtMethod  ctMethod = new CtMethod(CtClass.voidType, "printName", new CtClass[]{}, cc);
            ctMethod.setModifiers(Modifier.PUBLIC);
            ctMethod.setBody("{System.out.println(name);}");
            cc.addMethod(ctMethod);
    
            cc.writeFile("D:/***/src/main/java/");
        }
    
        public static void main(String[] args) {
            try {
                createPerson();
            } catch (Exception e) {
                e.printStackTrace();
            }
        }
    
    }

生成的.class类

//
    // Source code recreated from a .class file by IntelliJ IDEA
    // (powered by Fernflower decompiler)
    //
    
    package xxx.javassist;
    
    public class Person {
        private String name = "Tom";
    
        public void setName(String var1) {
            this.name = var1;
        }
    
        public String getName() {
            return this.name;
        }
    
        public Person() {
            this.name = "Tom";
        }
    
        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需要关注的方法：

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中的一些重要方法：

1.  insertBefore : 在方法的起始位置插入代码；
2.  insterAfter : 在方法的所有 return 语句前插入代码以确保语句能够被执行，除非遇到exception；
3.  insertAt : 在指定的位置插入代码；
4.  setBody : 将方法的内容设置为要写入的代码，当方法被 abstract修饰时，该修饰符被移除；
5.  make : 创建一个新的方法。

注意到在上面代码中的：setBody()的时候我们使用了一些符号：

Copy

// $0=this / $1,$2,$3... 代表方法参数

cons.setBody("\{$0.name = $1;\}");

具体还有很多的符号可以使用，但是不同符号在不同的场景下会有不同的含义，所以在这里就不在赘述，可以看javassist 的说明文档。http://www.javassist.org/tutorial/tutorial2.html

javassist用于生成动态代理

public class JavassistDemo {
        private String demoProperty = "demo-value"; // 字段
    
        // demoProperty字段对应的getter/setter方法
        public String getDemoProperty() {
            return demoProperty;
        }
    
        public void setDemoProperty(String demoProperty) {
            this.demoProperty = demoProperty;
        }
    
        // JavassistDemo的成员方法
        public void operation() {
            System.out.println("operation():" + this.demoProperty);
        }
    }

public class JavassitMainDemo {
    
      public static void main(String[] args) throws Exception {
    
        // 创建ProxyFactory工厂实例，它负责动态生成JavassistDemo的子类
        ProxyFactory factory = new ProxyFactory();
        factory.setSuperclass(JavassistDemo.class);
    
        // 设置Filter，用于确定哪些方法调用需要被代理
        factory.setFilter(m -> {
          if (m.getName().equals("operation")) {
            return true;
          }
          return false;
        });
    
    
        // 设置拦截处理逻辑，被拦截的方法会执行MethodHandler中的逻辑
        factory.setHandler((self, thisMethod, proceed, args1) -> {
          System.out.println("before operation");
          Object result = proceed.invoke(self, args1);
          System.out.println("after operation");
          return result;
        });
    
    
        // 生成代理类，并根据代理类创建代理对象
        Class<?> c = factory.createClass();
        JavassistDemo javassistDemo = (JavassistDemo) c.newInstance();
        // 执行operation()方法时会被拦截，进而执行代理逻辑
        javassistDemo.operation();
        System.out.println(javassistDemo.getDemoProperty());
      }
    }

打印：

before operation  
operation():demo-value  
after operation  
demo-value

感谢：

[https://www.cnblogs.com/rickiyang/p/11336268.html][https_www.cnblogs.com_rickiyang_p_11336268.html]

[https_www.cnblogs.com_rickiyang_p_11336268.html]: https://www.cnblogs.com/rickiyang/p/11336268.html