Java中的注解处理器详解

注解处理器是Java编译时处理注解的工具，它可以在编译期间读取、修改或生成源代码。下面我将从注解处理器的基本概念、工作原理、实现步骤和实际应用场景等方面，逐步讲解这个知识点。

1. 注解处理器的基本概念

• 注解（Annotation）：Java中的一种元数据，可以附加在类、方法、字段等元素上，用于提供额外信息。
• 注解处理器（Annotation Processor）：在Java编译阶段（javac命令执行时）调用的工具，用于处理注解，并可以生成新的Java源文件、资源文件，或修改现有代码。
• 编译时处理：与反射（运行时处理注解）不同，注解处理器在编译阶段工作，不会影响运行时性能。

2. 注解处理器的工作原理

注解处理器的工作流程遵循以下步骤：

1. 编译启动：当执行javac编译Java源文件时，编译器会检查是否注册了注解处理器。
2. 轮次处理（Round）：编译过程分为多轮（Round）。
   • 第一轮：处理所有输入的源文件中的注解。
   • 后续轮次：处理前一轮生成的源文件中的注解（如果有）。
3. 处理器调用：在每一轮中，编译器调用已注册的注解处理器，传入当前轮次待处理的元素（如类、方法）。
4. 终止条件：当没有新文件生成，或所有处理器都不再处理时，编译结束。

3. 实现注解处理器的步骤

步骤1：定义注解

首先，定义一个自定义注解，用于标记需要处理的元素。例如：

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.TYPE) // 该注解只能用于类
@Retention(RetentionPolicy.SOURCE) // 注解只在源码级别保留，编译后不包含
public @interface MyAnnotation {
    String value() default "";
}

步骤2：实现处理器类

创建一个类继承javax.annotation.processing.AbstractProcessor，并重写关键方法：

• getSupportedAnnotationTypes()：指定处理器要处理的注解全限定名。
• getSupportedSourceVersion()：指定支持的Java版本。
• process()：处理注解的核心逻辑。

import javax.annotation.processing.*;
import javax.lang.model.SourceVersion;
import javax.lang.model.element.TypeElement;
import javax.tools.JavaFileObject;
import java.io.Writer;
import java.util.Set;

@SupportedAnnotationTypes("com.example.MyAnnotation")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class MyAnnotationProcessor extends AbstractProcessor {

    @Override
    public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
        // 遍历所有被@MyAnnotation注解的元素
        for (TypeElement annotation : annotations) {
            roundEnv.getElementsAnnotatedWith(annotation).forEach(element -> {
                // 获取注解的值
                String className = element.getSimpleName().toString();
                String value = element.getAnnotation(MyAnnotation.class).value();

                // 生成新的Java源文件
                String newClassName = className + "Generated";
                String code = "public class " + newClassName + " {\n" +
                              "    public void print() {\n" +
                              "        System.out.println(\"" + value + "\");\n" +
                              "    }\n" +
                              "}";
                try {
                    JavaFileObject file = processingEnv.getFiler().createSourceFile(newClassName);
                    try (Writer writer = file.openWriter()) {
                        writer.write(code);
                    }
                } catch (Exception e) {
                    e.printStackTrace();
                }
            });
        }
        return true; // 注解已处理，不需要其他处理器继续处理
    }
}

步骤3：注册注解处理器

在resources/META-INF/services目录下创建文件javax.annotation.processing.Processor，内容为处理器的全限定名：

com.example.MyAnnotationProcessor

（注：也可以使用Google的@AutoService注解自动生成该文件。）

步骤4：使用注解

在代码中使用自定义注解：

@MyAnnotation("Hello World")
public class MyClass {
    // 类内容...
}

步骤5：编译并触发处理

使用javac编译时，注解处理器会自动执行：

javac -processor com.example.MyAnnotationProcessor MyClass.java

编译后，会生成新的源文件MyClassGenerated.java。

4. 注解处理器的应用场景

• 代码生成：如Lombok通过注解自动生成Getter/Setter方法，或生成Builder模式代码。
• 编译时检查：检查代码规范性，例如检查某个注解是否用于正确类型。
• 生成资源文件：如生成数据库映射配置、路由表等。

5. 注意事项与局限性

• 无法修改现有代码：注解处理器只能生成新文件，不能修改已存在的源文件（但可通过生成子类或代理类间接实现“修改”）。
• 编译时依赖：处理器本身需单独编译，并在编译主代码时可用。
• 性能影响：过多的注解处理器可能拖慢编译速度。

通过以上步骤，你可以理解注解处理器的基本工作原理和实现方法。它在现代Java框架（如Lombok、ButterKnife、Dagger）中广泛应用，是提升开发效率的重要工具。