深入理解Java Processor库（从零开始编写自定义注解处理器）

什么是 Java Processor？

Java 的 Processor 接口（位于 javax.annotation.processing 包中）是 Java 编译时处理 的核心。当你在项目中使用如 Lombok、Dagger、ButterKnife 等框架时，它们背后都依赖于注解处理器来在编译阶段生成额外的 Java 代码，而无需运行时反射，从而提升性能。

第一步：创建自定义注解

首先，我们需要定义一个注解，用于标记我们希望处理器处理的类或方法。

@Retention(RetentionPolicy.SOURCE)@Target(ElementType.TYPE)public @interface AutoGenerate {    String value() default "";}

这个注解 @AutoGenerate 只在源码阶段保留（SOURCE），作用于类（TYPE）。我们将在后续步骤中让处理器识别它。

第二步：编写注解处理器

接下来，我们创建一个继承自 AbstractProcessor 的类，并重写关键方法：

import javax.annotation.processing.*;import javax.lang.model.SourceVersion;import javax.lang.model.element.TypeElement;import javax.tools.JavaFileObject;import java.io.PrintWriter;import java.util.Set;@SupportedAnnotationTypes("com.example.AutoGenerate")@SupportedSourceVersion(SourceVersion.RELEASE_8)public class AutoGenerateProcessor extends AbstractProcessor {    @Override    public boolean process(Set<? extends TypeElement> annotations,                           RoundEnvironment roundEnv) {        for (TypeElement annotation : annotations) {            Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(annotation);            for (Element element : elements) {                if (element instanceof TypeElement) {                    TypeElement typeElement = (TypeElement) element;                    String className = typeElement.getSimpleName().toString();                    String packageName = processingEnv.getElementUtils()                            .getPackageOf(typeElement).getQualifiedName().toString();                    try {                        // 生成新文件：例如 MyClass_Generated.java                        JavaFileObject builderFile = processingEnv.getFiler()                                .createSourceFile(packageName + "." + className + "_Generated");                        PrintWriter out = new PrintWriter(builderFile.openWriter());                        out.println("package " + packageName + ";");                        out.println();                        out.println("public class " + className + "_Generated {");                        out.println("    public static void sayHello() {");                        out.println("        System.out.println(\"Hello from generated code!\");");                        out.println("    }");                        out.println("}");                        out.close();                    } catch (Exception e) {                        processingEnv.getMessager().printMessage(                            Diagnostic.Kind.ERROR, "Error generating file: " + e.getMessage());                    }                }            }        }        return true;    }}

注意几个关键点：

• @SupportedAnnotationTypes 声明该处理器处理哪些注解；
• process() 方法在编译时被调用，遍历所有被注解的元素；
• 使用 Filer 创建新的 Java 源文件。

第三步：注册处理器

为了让编译器知道你的处理器存在，需要在 resources/META-INF/services/ 目录下创建一个名为 javax.annotation.processing.Processor 的文件，内容为你的处理器全限定名：

com.example.AutoGenerateProcessor

如果你使用 Maven 或 Gradle，也可以通过插件自动注册，但手动方式更直观。

第四步：测试你的处理器

创建一个使用你注解的类：

@AutoGeneratepublic class MyService {    // 空类即可}

编译项目后，你会发现生成了 MyService_Generated.java 文件。在主程序中调用：

public class Main {    public static void main(String[] args) {        MyService_Generated.sayHello();    }}

运行结果：

Hello from generated code!

总结

通过本教程，你已经掌握了 Java Processor库 的基本使用方法，学会了如何编写 自定义注解处理器 来在编译期生成代码。这不仅减少了样板代码，还提升了运行时性能。掌握 Java编译时处理 技术，是你迈向高级 Java 开发者的重要一步。

希望这篇 注解处理器教程 对你有所帮助！你可以在此基础上扩展功能，比如生成 Builder 模式、数据库映射类等。