从0到1实现基于Javassist字节码增强本地公参传递

后端

2024-02-15 15:29:52

使用 Javassist 字节码增强实现本地参数传递

背景

在测试环境中，向代码传递公共参数（如用户 ID、租户 ID）至关重要。然而，在本地环境中获取这些参数通常不可行，这会妨碍测试执行并影响效率。

Javassist 字节码增强：一种解决方案

Javassist 字节码增强技术提供了一种优雅的解决方案。它允许我们修改 Java 字节码，将公共参数注入目标类。这样，我们可以在本地环境中无缝传递参数。

实现步骤

创建一个 Javassist 项目并添加 Javassist 依赖项。
编写一个 Javassist 字节码增强类，继承 ClassPool 并实现 ClassTransformer。
在 transform 方法中，查找目标类并使用 Javassist API 修改其字节码。
将增强类打包成 JAR 包并将其添加到测试环境的类路径中。

示例代码

// ClassTransformer 实现
import javassist.*;

public class LocalParameterTransformer implements ClassTransformer {

    // 要传递的参数名称和值
    private String parameterName;
    private String parameterValue;

    // 构造函数
    public LocalParameterTransformer(String parameterName, String parameterValue) {
        this.parameterName = parameterName;
        this.parameterValue = parameterValue;
    }

    @Override
    public byte[] transform(ClassPool pool, ClassClassPath classPath, ClassFile classFile, ConstPool constPool) throws CannotCompileException {
        CtClass ctClass = pool.get(classFile.getName());
        // 找到 main 方法
        CtMethod mainMethod = ctClass.getDeclaredMethod("main");
        // 获取 main 方法的参数类型
        CtClass[] parameterTypes = mainMethod.getParameterTypes();

        // 遍历参数类型，找到需要传递的参数
        for (int i = 0; i < parameterTypes.length; i++) {
            if (parameterTypes[i].getName().equals(parameterName)) {
                // 创建参数字段
                CtClass stringType = pool.get("java.lang.String");
                CtField field = new CtField(stringType, parameterName, ctClass);
                ctClass.addField(field);

                // 添加构造函数，初始化参数字段
                CtConstructor constructor = ctClass.getConstructor(new CtClass[]{stringType});
                constructor.insertBefore("this." + parameterName + " = $1;");

                // 在 main 方法中打印参数值
                mainMethod.insertBefore("System.out.println(this." + parameterName + ");");
            }
        }

        // 返回修改后的字节码
        return ctClass.toBytecode();
    }

    public static void main(String[] args) {
        // 使用示例
        ClassPool pool = new ClassPool();
        LocalParameterTransformer transformer = new LocalParameterTransformer("arg", "hello");
        try {
            CtClass ctClass = pool.get("LocalParameterTransformer$Example");
            byte[] bytecode = ctClass.toBytecode(transformer);
            ClassLoader classLoader = new ByteArrayClassLoader(bytecode);
            Class<?> exampleClass = classLoader.loadClass("LocalParameterTransformer$Example");
            exampleClass.getMethod("main", String[].class).invoke(null, (Object) new String[]{});
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    // 示例类
    private static class Example {

        private String arg;

        public Example(String arg) {
            this.arg = arg;
        }

        public static void main(String[] args) {
            System.out.println(arg);
        }
    }
}