Java 自定义注解中怎么配合编译期注解处理器(Annotation Processor)生成代码

舞夢輝影

舞夢輝影

2026-08-03

749人浏览

原创

java自定义注解配合编译期注解处理器生成代码的核心是:定义@retention(source)和@target的注解,编写继承abstractprocessor的处理器,通过meta-inf/services注册,并在javac编译阶段用filer生成新源文件。

java 自定义注解中怎么配合编译期注解处理器(annotation processor)生成代码

Java 自定义注解配合编译期注解处理器生成代码,核心在于:定义注解 + 编写 Processor + 注册处理器 + 触发编译。整个过程不运行时生效,而是在 javac 编译阶段扫描、解析、生成新源文件或资源。

定义可被处理器识别的自定义注解

注解需声明 @Retention(RetentionPolicy.SOURCE)(仅保留到源码阶段)和 @Target(明确作用位置),并建议加上 @Documented@SupportedSourceVersion 提升规范性:

  • 必须用 SOURCE 级别,否则编译器不会将其传递给 Processor
  • @Target({ElementType.TYPE, ElementType.FIELD}) 表示该注解可用在类或字段上
  • 避免使用 CLASSRUNTIME,否则无法在编译期被 Processor 拦截处理

编写 AnnotationProcessor 子类处理逻辑

继承 AbstractProcessor,重写 process() 方法,在其中遍历被注解的元素,提取信息,并调用 Filer 生成 Java 源文件:

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载
  • RoundEnvironment 提供 getElementsAnnotatedWith(YourAnnotation.class) 获取所有匹配元素
  • Filer.createSourceFile() 创建 .java 文件,返回 Writer 写入内容(推荐用 JavaFileObject + Writer,或更安全地用 javapoet 库生成结构化代码)
  • 注意:不能修改已有源文件,只能生成新文件;生成路径自动匹配包名(如包名 com.example → 输出到 com/example/ 目录)

注册处理器并确保编译时启用

有两种主流方式让 javac 发现你的 Processor:

  • 通过 META-INF/services/javax.annotation.processing.Processor:在 src/main/resources/META-INF/services/ 下建该文件,内容为处理器全限定类名(如 com.example.MyProcessor
  • Maven 中显式配置 annotationProcessorPath:在 maven-compiler-plugin 中添加 <annotationprocessorpaths></annotationprocessorpaths>,指定包含 Processor 的 jar(尤其多模块项目中 Processor 在独立 module 时必需)
  • 若用 JDK 9+,还需在 module-info.java 中声明 uses javax.annotation.processing.Processor

常见陷阱与注意事项

实际开发中容易卡在几个关键点:

  • Processor 类必须有无参构造函数(由编译器反射调用)
  • 不要在 process() 中抛出未捕获异常,会导致编译中断;应记录 Messager 错误信息(processingEnv.getMessager().printMessage(Diagnostic.Kind.ERROR, "...")
  • 生成的类名不能与已有类冲突,否则编译报错“duplicate class”
  • 首次编译可能看不到生成文件——因为 Maven 默认 clean 后才触发 Processor;建议执行 mvn compile 并检查 target/generated-sources/annotations/ 目录

不复杂但容易忽略细节。只要注解声明正确、Processor 注册到位、生成逻辑清晰,就能稳定在编译期产出所需代码。

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

相关专题

更多
java
java

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

2023.06.15

3716

6

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

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

2023.07.05

2751

9

java自学难吗
java自学难吗

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

2023.07.31

2776

8

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

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

2023.08.01

635

3

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

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

2023.08.02

600

3

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

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

2023.08.02

705

5

java有什么用
java有什么用

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

2023.08.02

1267

5

java在线网站
java在线网站

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

2023.08.03

18824

3

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

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

2023.08.03

646

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

Java 26官方文档
Java 26官方文档

共0课时 | 0人学习