Java 注解怎么在编译期通过自定义注解处理器(Annotation Processor)生成辅助代码

酷丽君_6974

酷丽君_6974

2026-08-28

231人浏览

原创

java注解本身不执行逻辑,但通过自定义注解处理器(继承abstractprocessor)并在编译期扫描@retention(retentionpolicy.source)注解,可生成新源文件,实现如butterknife、lombok等框架的代码生成功能。

java 注解怎么在编译期通过自定义注解处理器(annotation processor)生成辅助代码

Java 注解本身不执行逻辑,但配合自定义注解处理器(AnnotationProcessor),可以在编译期(javac 阶段)扫描源码中的特定注解,并生成新的 Java 源文件(如 XXX$$Generated.java),实现类似 ButterKnife、Lombok、Room、Dagger 的代码生成能力。

一、定义自定义注解(需声明保留策略为 SOURCE)

注解必须用 @Retention(RetentionPolicy.SOURCE),确保它只保留在源码阶段,不会进入字节码或运行时 —— 因为注解处理器只在编译期工作。

示例:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface AutoLog {
    String value() default "";
}
  • 必须加 @Target 明确作用位置(如 ElementType.TYPE 表示类上)
  • 不能用 CLASS 或 RUNTIME,否则注解处理器可能收不到(部分构建工具如 Gradle 会跳过非 SOURCE 注解的处理)

二、编写注解处理器(继承 AbstractProcessor)

核心是重写 process() 方法,在其中遍历被注解的元素,用 Filer 生成新源文件。

示例:为每个 @AutoLog 类生成一个日志辅助类:

public class AutoLogProcessor extends AbstractProcessor {
    private Messager messager;
    private Filer filer;

    @Override
    public synchronized void init(ProcessingEnvironment processingEnv) {
        super.init(processingEnv);
        this.messager = processingEnv.getMessager();
        this.filer = processingEnv.getFiler();
    }

    @Override
    public Set<string> getSupportedAnnotationTypes() {
        return Set.of(AutoLog.class.getCanonicalName());
    }

    @Override
    public boolean process(Set extends TypeElement> annotations, RoundEnvironment roundEnv) {
        for (Element element : roundEnv.getElementsAnnotatedWith(AutoLog.class)) {
            if (element.getKind() != ElementKind.CLASS) continue;
            TypeElement typeElement = (TypeElement) element;
            String className = typeElement.getSimpleName().toString();
            String packageName = processingEnv.getElementUtils()
                    .getPackageOf(typeElement).getQualifiedName().toString();

            try {
                JavaFileObject file = filer.createSourceFile(
                        packageName + "." + className + "$$Logger"
                );
                try (Writer writer = file.openWriter()) {
                    writer.write("package " + packageName + ";\n");
                    writer.write("public class " + className + "$$Logger {\n");
                    writer.write("    public static void log() { System.out.println(\"Log from " + className + "\"); }\n");
                    writer.write("}");
                }
            } catch (IOException e) {
                messager.printMessage(Diagnostic.Kind.ERROR, "Failed to generate logger: " + e.getMessage());
            }
        }
        return true; // 告诉编译器该注解已处理完毕
    }
}</string>
  • 必须重写 getSupportedAnnotationTypes(),返回全限定名(字符串),否则处理器不生效
  • process() 返回 true 表示“我处理了这些注解”,后续编译轮次不会再交由该处理器处理同一批注解
  • 用 Messager 输出编译期提示/错误,用户能在 IDE 或命令行看到反馈

三、注册处理器(META-INF/services/javax.annotation.processing.Processor)

在处理器模块的 src/main/resources/META-INF/services/ 下创建文件:

Miller CSV TSV JSON 数据处理器
Miller CSV TSV JSON 数据处理器

Miller (mlr) 是一个命令行工具,用于查询、整形和重新格式化名称索引数据,如 CSV、TSV、JSON 和 JSON Lines。它将 awk、sed、cut、join 和 sort 的功能整合到一个专为结构化数据处理而构建的单一工具中。

下载
javax.annotation.processing.Processor

内容为处理器类的全限定名,例如:

com.example.AutoLogProcessor
  • 文件名和路径必须严格匹配,大小写敏感
  • 多个处理器换行分隔

四、在项目中使用(Maven / Gradle 配置)

注解和处理器需拆分为两个模块(推荐):一个只放注解(annotation),一个放处理器(processor)。使用方只依赖注解模块,并通过 annotationProcessor 引入处理器。

Gradle 示例(app module):

dependencies {
    implementation project(':annotations')      // @AutoLog 所在模块
    annotationProcessor project(':processor') // AutoLogProcessor 所在模块
}

Maven 示例:

<plugin><groupid>org.apache.maven.plugins</groupid><artifactid>maven-compiler-plugin</artifactid><configuration><annotationprocessorpaths><path><groupid>com.example</groupid><artifactid>auto-log-processor</artifactid><version>1.0</version></path></annotationprocessorpaths></configuration></plugin>
  • Gradle 中 annotationProcessor 不会打包进最终 APK/JAR,仅参与编译;compileOnly 可用于注解模块
  • IDE(如 IntelliJ)需开启 “Enable annotation processing” 并配置输出目录(默认 build/generated/source/apt)

不复杂但容易忽略:生成的代码会被编译器自动编译进最终 class,所以你写的 MyClass$$Logger 在运行时可以直接 new 或调用 —— 它和手写类完全等价。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java 处理器

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

9497

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

6662

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

5912

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1044

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

868

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1236

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2489

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

19831

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1135

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习