Java动态字节技术之Javassist

Posted 2021-05-19 指尖上的代码go

Javassist是一个开源的分析、编辑和创建Java字节码的类库，可以直接编辑和生成Java生成的字节码。相对于bcel,asm等这些工具，开发者不需要了解虚拟机指令，就能动态改变类的结构，或者动态生成类。javassist简单易用，快速。

 

重要的类

1. ClassPool：javassist的类池，使用ClassPool 类可以跟踪和控制所操作的类，它的工作方式与 JVM 类装载器非常相似

2. CtClass： CtClass提供了类的操作，如在类中动态添加新字段、方法和构造函数、以及改变类、父类和接口的方法。

3. CtField：类的属性，通过它可以给类创建新的属性，还可以修改已有的属性的类型，访问修饰符等

4. CtMethod：类中的方法，通过它可以给类创建新的方法，还可以修改返回类型，访问修饰符等， 甚至还可以修改方法体内容代码

5. CtConstructor：与CtMethod类似。推荐了解java培训课程。

 

API运用

 

ClassPool

 

// 类库, jvm中所加载的class

ClassPool pool = ClassPool.getDefault();

// 加载一个已知的类, 注：参数必须为全量类名

CtClass ctClass = pool.get("com.itheima.Student");

// 创建一个新的类, 类名必须为全量类名

CtClass tClass = pool.makeClass("com.itheima.Calculator");

 

 

CtField

// 获取已知类的属性

CtField ctField = ctClass.getDeclaredField("name");

// 构建新的类的成员变量

CtField ctFieldNew = new CtField(CtClass.intType,"age",ctClass);

// 设置类的访问修饰符为public

ctFieldNew.setModifiers(Modifier.PUBLIC);

// 将属性添加到类中

ctClass.addField(ctFieldNew);

 

CtMethod

// 获取已有方法

CtMethod ctMethod = ctClass.getDeclaredMethod("sayHello");

//创建新的方法, 参数1:方法的返回类型，参数2：名称，参数3：方法的参数，参数4：方法所属的类

CtMethod ctMethod = new CtMethod(CtClass.intType, "calc", new CtClass[]

{CtClass.intType,CtClass.intType}, tClass);

// 设置方法的访问修饰

ctMethod.setModifiers(Modifier.PUBLIC);

// 将新建的方法添加到类中

ctClass.addMethod(ctMethod);

// 方法体内容代码 $1代表第一个参数，$2代表第二个参数

ctMethod.setBody("return $1 + $2;");

// 直接创建方法

CtMethod getMethod = CtNewMethod.make("public int getAge() { return this.age;}", ctClass);

CtMethod setMethod = CtNewMethod.make("public void setAge(int age) { this.age = age;}",

ctClass);

ctClass.addMethod(getMethod);

ctClass.addMethod(setMethod);

 

 

CtConstructor

// 获取已有的构造方法, 参数为构建方法的参数类型数组

CtConstructor ctConstructor = ctClass.getDeclaredConstructor(new CtClass[]{});

// 创建新的构造方法

CtConstructor ctConstructor = new CtConstructor(new CtClass[]{CtClass.intType},ctClass);

ctConstructor.setModifiers(Modifier.PUBLIC);

ctConstructor.setBody("this.age = $1;");

ctClass.addConstructor(ctConstructor);

// 也可直接创建

ctConstructor = CtNewConstructor.make("public Student(int age){this.age=age;}", ctClass);

 

 

案例

1. 创建maven工程并添加依赖

 

添加依赖

添加Student类

package com.itheima;

    public class Student {

        private int age;

        private String name;

        public int getAge() {

             return age;

        }

        public void setAge(int age) {

            this.age = age;

         }

        public String getName() {

            return name;

        }

        public void setName(String name) {

            this.name = name;

        }

       public void sayHello(){

            System.out.println("Hello, My name is " + this.name);

        }

}

 

2. 修改已有方法体，插入新的代码

对已有的student类中的sayHello方法，当调用时，控制台会输出: Hello, My name is 张三(name=张三)

需求：通过动态修改sayHello方法，当调用sayHello时，除了输出已经的内容外，再输出当前学生的age信息创建JavassistDemo测试类，代码实现如下：

package com.itheima.test;

 

import org.junit.Test;

 

import com.itheima.Student;

 

import javassist.ClassPool;

import javassist.CtClass;

import javassist.CtMethod;

 

@SuppressWarnings("unchecked")

public class JavassistDemo {

    @Test

    public void t1() throws Exception{

        // 类库池, jvm中所加载的class

        ClassPool pool = ClassPool.getDefault();

        // 获取指定的Student类

        CtClass ctClass = pool.get("com.itheima.Student");

        // 获取sayHello方法

        CtMethod ctMethod = ctClass.getDeclaredMethod("sayHello");

        // 在方法的代码后追加 一段代码

        ctMethod.insertAfter("System.out.println(\\"I\'m \\" + this.age + \\" years old.\\");");

        // 使用当前的ClassLoader加载被修改后的类

        Class<Student> newClass = ctClass.toClass();

        Student stu = newClass.newInstance();

        stu.setName("张三");

        stu.setAge(18);

        stu.sayHello();

    }

}

运行结果:

3. 动态添加方法
接下来我们给Student类添加一个计算的方法，但不是直接在Student类中添加，而是使用javassist，动态添加

public int calculate(int a, int b){

    return a+b;

}

创建测试方法t2，代码如下

@Test

public void t2() throws Exception{

    // 类库池, jvm中所加载的class

    ClassPool pool = ClassPool.getDefault();

    // 获取指定的Student类

    CtClass ctClass = pool.get("com.itheima.Student");

    // 创建calc方法, 带两个参数，参数的类型都为int类型

    CtMethod ctMethod = new CtMethod(CtClass.intType,"calc",

    new CtClass[]{CtClass.intType,CtClass.intType}, ctClass);

    // 设置方法的访问修饰

    ctMethod.setModifiers(Modifier.PUBLIC);

    // 设置方法体代码

    ctMethod.setBody("return $1 + $2;");

    // 添加新建的方法到原有的类中

    ctClass.addMethod(ctMethod);

    // 加载修改后的类

    ctClass.toClass();

    // 创建对象

    Student stu = new Student();

    // 获取calc方法

    Method dMethod = Student.class.getDeclaredMethod("calc", new Class[]

    {int.class,int.class});

    // 反射调用 方法

    Object result = dMethod.invoke(stu, 10,20);

    // 打印结果

    System.out.println(String.format("调用calc方法，传入参数：%d,%d", 10,20));

    System.out.println("返回结果：" + (int)result);

}

控制台输出结果：

 

4. 动态创建类

下面我们再来个神的魔术，无中生有

@Test

public void t3() throws Exception{

    ClassPool pool = ClassPool.getDefault();

    // 创建teacher类

    CtClass teacherClass = pool.makeClass("com.itheima.Teacher");

    // 设置为公有类

    teacherClass.setModifiers(Modifier.PUBLIC);

    // 获取String类型

    CtClass stringClass = pool.get("java.lang.String");

    // 获取list类型

    CtClass listClass = pool.get("java.util.List");

    // 获取学生的类型

    CtClass studentClass = pool.get("com.itheima.Student");

    // 给teacher添加name属性

    CtField nameField = new CtField(stringClass, "name", teacherClass);

    nameField.setModifiers(Modifier.PUBLIC);

    teacherClass.addField(nameField);

    // 给teacher类添加students属性

    CtField studentList = new CtField(listClass, "students",teacherClass);

    studentList.setModifiers(Modifier.PUBLIC);

    teacherClass.addField(studentList);

    // 给teacher类添加无参构造方法

    CtConstructor ctConstructor = CtNewConstructor.make("public Teacher()

    {this.name=\\"abc\\";this.students = new java.util.ArrayList();}", teacherClass);

    teacherClass.addConstructor(ctConstructor);

    // 给teacher类添加addStudent方法

    CtMethod m = new CtMethod(CtClass.voidType, "addStudent", new CtClass[]{studentClass},

    teacherClass);

    m.setModifiers(Modifier.PUBLIC);

    // 添加学生对象到students属性中, $1代表参数1

    m.setBody("this.students.add($1);");

    teacherClass.addMethod(m);

    // 给teacher类添加sayHello方法

    m = new CtMethod(CtClass.voidType, "sayHello", new CtClass[]{}, teacherClass);

    m.setModifiers(Modifier.PUBLIC);

    m.setBody("System.out.println(\\"Hello, My name is \\" + this.name);");

    m.insertAfter("System.out.println(\\"I have \\" + this.students.size() + \\"students\\");");

    teacherClass.addMethod(m);

    // 加载修改后的类

    Class<?> cls = teacherClass.toClass();

    // 实例teacher对象

    Object obj = cls.newInstance();

    // 获取addStudent方法

    Method method = cls.getDeclaredMethod("addStudent", Student.class);

    // 创建张三和李四2个学生

    Student stu = new Student();

    stu.setName("张三");

    // 调用teacher类的addStudent方法，添加张三

    method.invoke(obj, stu);

    stu = new Student();

    stu.setName("李四");

    // 调用teacher类的addStudent方法，添加李四

    method.invoke(obj, stu);

    // 调用sayHello方法

    Method teacherSayHello = cls.getDeclaredMethod("sayHello",new Class[]{});

    teacherSayHello.invoke(obj, new Object[]{});

}

运行结果：

 

总结

javassist被用于struts2和hibernate中，都用来做动态字节码修改使用。一般开发中不会用到，但在封装框架时比较有用。虽然javassist提供了一套简单易用的API，但如果用于平常的开发，会有如下几点不好的地方:

1. 所引用的类型，必须通过ClassPool获取后才可以使用

2. 代码块中所用到的引用类型，使用时必须写全量类名

3. 即使代码块内容写错了，它也不会像eclipse等开发工具一样有提示，它只有在运行时才报错

4. 动态修改的类，必须在修改之前，jvm中不存在这个类的实例对象。修改方法的实现必须在修改的类加载之前进行