一、注解处理器是什么？
想象你正在装修房子，监理师傅会在施工过程中检查水电布线是否符合规范。Java注解处理器就像这样的监理，只不过它检查的是代码。它在编译阶段悄悄工作，帮你找出代码中的问题，甚至还能自动生成新代码。
注解处理器是javac的一个插件机制。当你编译代码时，它会扫描所有注解，然后根据你的处理逻辑执行相应操作。这个过程完全自动化，不需要你手动调用。
技术栈：Java 11 + javac
// 定义一个简单的注解
@Retention(RetentionPolicy.SOURCE) // 只在源码阶段保留
@Target(ElementType.TYPE) // 只能用在类上
public @interface Builder {
String value() default ""; // 可选的参数
}
二、注解处理器能做什么？
最常见的用途有两个：代码验证和代码生成。比如你可以检查某个类是否实现了必要的方法，或者在编译时自动生成Builder类。
来看个实际例子：实现一个简单的NotNull检查。
技术栈：Java 11 + javac
// 定义NotNull注解
@Retention(RetentionPolicy.SOURCE)
@Target({ElementType.FIELD, ElementType.PARAMETER})
public @interface NotNull {
}
// 处理器核心逻辑
@SupportedAnnotationTypes("com.example.NotNull")
@SupportedSourceVersion(SourceVersion.RELEASE_11)
public class NotNullProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv) {
// 遍历所有被@NotNull标记的元素
for (Element element : roundEnv.getElementsAnnotatedWith(NotNull.class)) {
// 检查字段是否有null检查逻辑
if (!hasNullCheck(element)) {
processingEnv.getMessager().printMessage(
Diagnostic.Kind.ERROR,
"@NotNull字段缺少null检查",
element);
}
}
return true;
}
private boolean hasNullCheck(Element element) {
// 这里简化实现，实际应该检查方法体
return true;
}
}
三、如何实现一个代码生成器？
更强大的功能是自动生成代码。比如自动生成Builder模式代码，可以大大减少样板代码。
技术栈：Java 11 + javac
// 使用注解标记需要生成Builder的类
@Builder
public class User {
private String name;
private int age;
}
// 处理器实现
@AutoService(Processor.class) // Google自动注册处理器
@SupportedAnnotationTypes("com.example.Builder")
public class BuilderProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations,
RoundEnvironment roundEnv) {
for (Element element : roundEnv.getElementsAnnotatedWith(Builder.class)) {
// 1. 解析类信息
TypeElement classElement = (TypeElement) element;
// 2. 生成Builder类源码
String builderCode = generateBuilderCode(classElement);
// 3. 写入Java文件
writeSourceFile(classElement.getSimpleName() + "Builder",
builderCode);
}
return true;
}
private String generateBuilderCode(TypeElement classElement) {
// 这里简化实现，实际应该用JavaPoet等库
return "public class " + classElement.getSimpleName() + "Builder { ... }";
}
}
四、实际应用中的技巧
- 使用JavaPoet简化代码生成： 技术栈：Java 11 + JavaPoet
// 使用JavaPoet生成方法
MethodSpec main = MethodSpec.methodBuilder("main")
.addModifiers(Modifier.PUBLIC, Modifier.STATIC)
.returns(void.class)
.addParameter(String[].class, "args")
.addStatement("$T.out.println($S)", System.class, "Hello World!")
.build();
// 生成整个类
TypeSpec helloWorld = TypeSpec.classBuilder("HelloWorld")
.addModifiers(Modifier.PUBLIC, Modifier.FINAL)
.addMethod(main)
.build();
// 生成Java文件
JavaFile javaFile = JavaFile.builder("com.example", helloWorld)
.build();
javaFile.writeTo(processingEnv.getFiler());
- 处理循环依赖： 当多个注解相互依赖时，需要使用多轮处理机制。javac会自动处理多轮处理。
五、应用场景分析
- 数据校验：在编译时检查参数是否为空、字符串格式等
- 代码生成：减少样板代码，如Builder、Delegate等模式
- 文档生成：根据注解自动生成API文档
- 依赖注入：像Dagger这样的框架底层就是注解处理器
六、技术优缺点
优点：
- 编译时检查，运行时零开销
- 可以大幅减少样板代码
- 错误在编译时就暴露出来
缺点：
- 学习曲线较陡峭
- 调试困难
- 处理速度影响编译时间
七、注意事项
- 注解处理器只能生成新文件，不能修改已有文件
- 处理器在独立类加载器中运行，不能直接使用项目中的类
- 注意处理速度，复杂处理器会显著增加编译时间
- 使用AutoService自动注册处理器，避免手动配置
八、总结
注解处理器是Java中一个强大但常被忽视的特性。它让我们可以把很多运行时的工作提前到编译时，既提高了性能，又能尽早发现问题。虽然上手有一定难度，但一旦掌握，就能大幅提升开发效率和代码质量。
对于常见模式，建议优先使用现成的库（如Lombok）。但当你有特殊需求时，自定义注解处理器会是个非常强大的工具。
评论