详解Java字节码编程之非常好用的javassist

前言

Java字节码是Java程序在编译过程中生成的中间代码，有些用户可能需要在程序运行时直接修改Java字节码，这就需要用到Java字节码编程技术。Java字节码编程技术使用非常广泛，涉及方面包括AOP、动态代理、字节码加密等。

在Java字节码编程中，有一个非常好用的工具库——javassist，它提供了简单、易用、且功能强大的API，可以帮助我们快速创建、修改Java字节码文件。

本文将带领大家深入了解javassist，并且通过自己动手编写代码来实践，加深理解。

javassist简介

什么是javassist

javassist是一个字节码编辑器，它提供了Java字节码的生成、转换、读取和操作等功能，是动态Java编程的中间件，可用于AOP编程、动态代理实现以及动态修改字节码等场景。javassist是一个开源项目，发行版支持Java6、Java7、Java8、Java9。

javassist的优势

1. 使用简单：提供了简单、易用、且功能强大的API，使用起来非常方便。

2. 扩展性强：javassist可以动态修改字节码，支持修改其成员变量、方法、注解、父类、接口等，还可以修改、或者动态生成方法的字节码。

3. 支持的字节码格式丰富：javassist支持直接生成JVM字节码、Class文件和Jar文件，可以便于我们直接操作字节码，以达到自己的目的。

javassist的使用

添加依赖

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

生成类

public class JavassistExample {

    public static void main(String[] args) throws Exception {

        ClassPool pool = ClassPool.getDefault();
        CtClass cc = pool.makeClass("com.demo.User");

        // 添加age字段
        CtField ageField = new CtField(pool.getCtClass("java.lang.Integer"), "age", cc);
        ageField.setModifiers(Modifier.PRIVATE);
        cc.addField(ageField);

        // 添加getName、setName方法
        CtMethod getNameMethod = new CtMethod(pool.getCtClass("java.lang.String"), "getName", new CtClass[]{}, cc);
        getNameMethod.setBody("{return null;}");
        cc.addMethod(getNameMethod);

        CtMethod setNameMethod = new CtMethod(CtClass.voidType, "setName", new CtClass[]{pool.getCtClass("java.lang.String")}, cc);
        setNameMethod.setBody("{return null;}");
        cc.addMethod(setNameMethod);

        // 将生成的类写入文件
        cc.writeFile("src/main/java");

    }
}

以上代码演示了使用javassist生成一个名为com.demo.User的Java类，并且在类中添加了一个age字段，以及一个getName方法和一个setName方法，并将生成的类写入到src/main/java目录下。

修改类

public class JavassistExample {

    public static void main(String[] args) throws Exception {

        ClassPool pool = ClassPool.getDefault();
        CtClass cc = pool.get("com.demo.User");

        // 修改age字段
        CtField field = cc.getDeclaredField("age");
        field.setModifiers(field.getModifiers() | Modifier.PUBLIC);

        // 修改getName方法
        CtMethod method = cc.getDeclaredMethod("getName");
        method.setBody("{return \"little cloud\";}");

        // 将修改后的类写入文件
        cc.writeFile("src/main/java");

    }
}

以上代码演示了如何使用javassist修改addUser方法，并将修改后的类写入到src/main/java目录下。

示例说明

示例1：修改class字节码里的方法体

在实际工作中，有时我们需要在没有服务重启的情况下修改Java类的方法体，这时可以使用javassist来修改方法体。

例如，我们有一个名为com.demo.User的Java类，包含了一个addUser方法，我们想要将该方法的实现修改为打印一句话：

修改前的addUser方法：

public class User {

    public void addUser(UserInfo userInfo) {
        // 代码省略
    }
}

修改后的addUser方法：

public class User {

    public void addUser(UserInfo userInfo) {
        System.out.println("add user success!");
    }
}

使用javassist实现代码如下：

public class ModifyMethodImpl {

    public static void main(String[] args) throws Exception {

        // 获取User类的Class对象，使用的是类全路径
        Class<User> clazz = (Class<User>) Class.forName("com.demo.User");

        // 获取方法名为addUser，参数为UserInfo.class的方法
        Method method = clazz.getDeclaredMethod("addUser", UserInfo.class);

        // 获取method对象对应CtMethod对象
        ClassPool pool = ClassPool.getDefault();
        pool.insertClassPath(new ClassClassPath(clazz));
        CtClass cc = pool.get(clazz.getName());
        CtMethod ctMethod = cc.getDeclaredMethod(method.getName(), pool.get(new String[]{userInfoClass.getName()}));

        // 修改method方法体
        ctMethod.setBody("{ System.out.println(\"add user success!\"); }");

        // 重新加载class
        clazz = (Class<User>) cc.toClass();
        System.out.println(clazz.getClassLoader());
    }
}

示例2：代理对象

Java的动态代理中，我们需要实现一个InvocationHandler接口，在invoke方法中实现代理逻辑。使用javassist能够帮助我们简化动态代理的编写过程：

public class JavassistProxyExample {

    public static void main(String[] args) throws Throwable {

        ProxyFactory proxyFactory = new ProxyFactory();
        proxyFactory.setSuperclass(Target.class);
        proxyFactory.setFilter(new ProxyFilter());
        proxyFactory.setHandler(new MethodHandler() {

            @Override
            public Object invoke(Object self, Method thisMethod, Method proceed, Object[] args) throws Throwable {

                System.out.println("before");
                Object result = proceed.invoke(self, args);
                System.out.println("after");

                return result;
            }
        });

        Target proxy = (Target) proxyFactory.create(new Class[]{}, new Object[]{});

        proxy.doSomething();
    }

    interface Target {
        void doSomething();
    }

    static class ProxyFilter implements MethodFilter {

        @Override
        public boolean isHandled(Method method) {
            return true;
        }
    }
}

以上代码演示了如何使用javassist来生成代理对象，并且在代理对象的方法调用前后打印日志。

结语

javassist作为一个Java字节码编辑器，拥有强大的生成、转换、读取和处理Java字节码的能力，能够帮助我们解决许多日常工作中遇到的问题。很多优秀的框架，比如Hibernate，就使用了javassist来实现，因此，学会使用javassist是非常有必要的。