Java中如何在类加载时动态添加带自定义注解的方法？

Java反射API仅支持修改已有方法的注解属性，无法直接动态添加新方法。要实现类加载时新增带指定注解的方法，必须借助字节码操作框架（如ByteBuddy、ASM），在类字节码被加载前修改其结构。以下是基于ByteBuddy的具体实现方案：

1. 引入ByteBuddy依赖 #

如果使用Maven，在pom.xml中添加依赖：

<dependency>
    <groupId>net.bytebuddy</groupId>
    <artifactId>byte-buddy</artifactId>
    <version>1.14.12</version>
</dependency>
<dependency>
    <groupId>net.bytebuddy</groupId>
    <artifactId>byte-buddy-agent</artifactId>
    <version>1.14.12</version>
</dependency>

2. 定义注解参数集合 #

先准备好要新增方法的注解参数（可从配置文件/数组读取）：

// 封装注解参数的实体类
class MethodXYParam {
    private int x;
    private int y;
    private String methodName;

    public MethodXYParam(String methodName, int x, int y) {
        this.methodName = methodName;
        this.x = x;
        this.y = y;
    }

    // getter方法
    public String getMethodName() { return methodName; }
    public int getX() { return x; }
    public int getY() { return y; }
}

// 模拟从配置读取的参数列表
List<MethodXYParam> newMethods = Arrays.asList(
    new MethodXYParam("myMethodC", 10, 20),
    new MethodXYParam("myMethodD", 30, 40)
);

3. 类加载时动态修改类 #

通过ByteBuddy的Agent机制，在AnnotationTest类加载时拦截并动态添加方法及注解：

import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.ByteBuddyAgent;
import net.bytebuddy.description.annotation.AnnotationDescription;
import net.bytebuddy.dynamic.DynamicType;
import net.bytebuddy.matcher.ElementMatchers;

public class DynamicMethodAdder {
    public static void main(String[] args) throws Exception {
        // 启动ByteBuddy代理
        ByteBuddyAgent.install();

        // 构建修改后的AnnotationTest类
        DynamicType.Builder<AnnotationTest> builder = new ByteBuddy()
                .redefine(AnnotationTest.class)
                .name(AnnotationTest.class.getName());

        // 遍历参数列表，逐个添加方法和注解
        for (MethodXYParam param : newMethods) {
            // 构建@MethodXY注解实例
            AnnotationDescription anno = AnnotationDescription.Builder
                    .ofType(MethodXY.class)
                    .define("x", param.getX())
                    .define("y", param.getY())
                    .build();

            // 向类中添加无参void方法，附上注解
            builder = builder.method(ElementMatchers.none()) // 匹配无对应方法
                    .define(param.getMethodName(), void.class)
                    .annotateWith(anno)
                    .intercept(() -> {
                        // 方法逻辑，这里用默认实现
                        System.out.println("Dynamic method " + param.getMethodName() + " executed");
                    });
        }

        // 加载修改后的类
        Class<?> modifiedClass = builder.make()
                .load(DynamicMethodAdder.class.getClassLoader())
                .getLoaded();

        // 验证：获取所有方法的注解
        for (java.lang.reflect.Method method : modifiedClass.getDeclaredMethods()) {
            MethodXY anno = method.getAnnotation(MethodXY.class);
            if (anno != null) {
                System.out.printf("Method: %s, @MethodXY(x=%d, y=%d)%n",
                        method.getName(), anno.x(), anno.y());
            }
        }

        // 调用动态添加的方法
        Object instance = modifiedClass.getDeclaredConstructor().newInstance();
        modifiedClass.getMethod("myMethodC").invoke(instance);
    }
}

4. 关键逻辑说明 #

• 注解构建：通过AnnotationDescription.Builder可以直接创建带指定属性值的注解实例，无需修改已有注解对象。
• 类重定义：ByteBuddy.redefine()方法会读取原有类的字节码，在其基础上添加新方法，不会破坏原有类结构。
• 方法拦截：intercept()方法可以指定动态方法的执行逻辑，这里用Lambda提供了简单的打印逻辑，你可以替换为自定义逻辑。

5. 替代方案（ASM） #

如果需要更底层的字节码操作，可以使用ASM框架，但需要手动编写字节码生成逻辑：

• 编写ClassVisitor遍历类结构
• 在visitMethod()前插入新的方法节点
• 手动生成注解的字节码属性

不过ByteBuddy已经封装了ASM的复杂逻辑，对于大多数场景更易用。

内容的提问来源于stack exchange，提问作者summary