Java中 AbstractProcessor 怎么编写自定义编译期注解处理器

落晨大大_2677

落晨大大_2677

2026-07-23

755人浏览

原创

编写java自定义编译期注解处理器需继承abstractprocessor,正确实现getsupportedannotationtypes()和process()方法,通过meta-inf/services/javax.annotation.processing.processor注册,并使用filer生成文件,确保编译时启用。

java中 abstractprocessor 怎么编写自定义编译期注解处理器

要编写 Java 自定义编译期注解处理器,核心是继承 AbstractProcessor 并正确注册、声明处理逻辑。它不是运行时反射,而是在 javac 编译阶段介入,生成代码或校验逻辑,关键在于“被识别”和“被调用”两个环节。

声明并实现 Processor 类

继承 AbstractProcessor,重写 getSupportedAnnotationTypes() 和 process() 方法。注意:init() 可用于获取常用工具(如 Elements、Filer、Messager),建议缓存复用。

  • getSupportedAnnotationTypes() 返回你希望处理的注解全限定名,推荐用 Set.of(YourAnnotation.class.getCanonicalName());若支持所有注解可返回 Set.of("*")(不推荐)
  • process() 是主入口:参数 annotations 是本轮编译中匹配到的注解元素集合,roundEnv 提供当前轮次的上下文(如 getElementsAnnotatedWith())
  • 必须返回 true 表示已处理该注解(后续轮次不再交由本 processor 处理),返回 false 表示未处理完,可能在后续 round 再次调用

通过 META-INF/services 注册处理器

编译器不会自动发现你的 Processor,必须显式声明。在 src/main/resources/META-INF/services/ 下创建文件 javax.annotation.processing.Processor(注意路径和文件名完全一致),内容为你的处理器类全限定名,例如:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
com.example.MyAnnotationProcessor

多个处理器换行写即可。Maven 构建时需确保该资源被正确打包进 jar 的对应位置。

正确使用 Filer 生成源码或 class 文件

不能直接用 FileWriter 写文件——必须通过 ProcessingEnvironment.getFiler() 创建文件,否则会被编译器忽略或报错。

  • 生成 Java 源文件:调用 filer.createSourceFile(className, originatingElements...),返回 JavaFileObject,再用 openWriter() 写入符合 Java 语法的字符串(建议配合 JavaPoet 等库构造)
  • 生成资源文件(如配置):用 filer.createResource(...)
  • 禁止生成已有类名的源文件(会冲突),也避免在 process() 中抛出未捕获异常,否则编译失败且无明确提示

编译时启用并验证处理器

仅写好 Processor 不够,还需让 javac 加载它:

  • Maven 项目:把 processor 打成独立 jar,并在使用方模块的 <dependencies></dependencies> 中引入;同时确保该 jar 包含 META-INF/services/... 文件
  • 命令行编译:用 javac -processorpath your-processor.jar -processor com.example.MyAnnotationProcessor ...
  • IDE 支持:IntelliJ 默认启用 annotation processing(Settings → Build → Compiler → Annotation Processors),Eclipse 需手动开启;若没生效,检查是否启用了 “Obtain processors from project classpath”
  • 调试技巧:在 process() 中用 messager.printMessage(Diagnostic.Kind.NOTE, "processing...") 输出日志,编译时可见

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

相关专题

更多
java
java

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

2023.06.15

10197

6

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

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

2023.07.05

7322

9

java自学难吗
java自学难吗

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

2023.07.31

6432

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1336

5

java有什么用
java有什么用

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

2023.08.02

2689

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习