Java 注解处理器 AbstractProcessor 怎么写

轻丽酱_8466

轻丽酱_8466

2026-08-13

379人浏览

原创

java注解处理器核心三步:声明支持的注解、重写process()方法、在meta-inf/services/javax.annotation.processing.processor中注册;关键在于正确获取元素、生成代码且不破坏编译流程。

java 注解处理器 abstractprocessor 怎么写

写一个 Java 注解处理器(AbstractProcessor)核心是三步:声明支持的注解、重写 process() 方法处理逻辑、在 META-INF/services/javax.annotation.processing.Processor 中注册。关键不是“能运行”,而是“能正确获取元素、生成代码、不破坏编译流程”。

1. 继承 AbstractProcessor 并声明支持的注解

你的处理器必须继承 AbstractProcessor,并用 @SupportedAnnotationTypes 明确指定它响应哪些注解(支持通配符 *,但不推荐)。同时建议加上 @SupportedSourceVersion 声明兼容的 Java 版本。

示例:

<font size="2"><pre class="brush:php;toolbar:false;">@SupportedAnnotationTypes("com.example.MyAnnotation")<br>@SupportedSourceVersion(SourceVersion.RELEASE_17)<br>public class MyProcessor extends AbstractProcessor {<br>    @Override<br>    public boolean process(Set extends TypeElement> annotations,<br roundenvironment roundenv>        // 实际处理逻辑<br>        return true;<br>    }<br>}

2. 在 process() 中安全地遍历和处理被注解的元素

process() 会被编译器多次调用(多轮处理),每次传入本轮发现的注解及对应元素。务必用 roundEnv.getElementsAnnotatedWith(...) 获取元素,不要依赖字段缓存 —— 元素可能跨轮出现或未完全解析。

常见操作包括:

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载
  • 用 element.getEnclosedElements() 获取类内部的字段/方法
  • 用 element.asType().toString() 获取类型字符串(注意:不能直接 instanceof 判断泛型类型)
  • 用 processingEnv.getElementUtils().getTypeElement("java.lang.String") 安全获取已知类型
  • 对 VariableElement(字段)、ExecutableElement(方法)做类型检查时,优先用 Types.isAssignable() 而非字符串匹配

3. 用 Filer 生成源码或资源文件(不能修改原类)

注解处理器**不能修改已有源文件**,只能通过 processingEnv.getFiler() 创建新文件。生成 Java 源码推荐用 Filer.createSourceFile(),配合 JavaFileObject.openWriter() 写入内容。

重要细节:

  • 生成的类名必须与文件路径严格匹配(如生成 com.example.Foo,路径必须是 com/example/Foo.java)
  • 避免在 process() 中抛出未捕获异常,否则编译失败;应记录日志并返回 false 表示未完全处理
  • 若需读取注解属性值,用 annotationMirror.getElementValues() + AnnotationValueVisitor 安全提取,尤其注意数组、嵌套注解等复杂类型

4. 正确注册处理器(否则编译器根本不会加载)

在 src/main/resources/META-INF/services/ 下创建文件:
javax.annotation.processing.Processor,内容只有一行:

<font size="2">com.example.MyProcessor</font>

如果是 Maven 项目,确保该路径在编译输出中(resources 目录需被 maven-resources-plugin 处理)。Gradle 用户注意:src/main/resources 默认参与打包,但需确认 annotationProcessor 依赖已正确定义(不是 compileOnly 或 implementation)。

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

10637

6

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

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

2023.07.05

7782

9

java自学难吗
java自学难吗

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

2023.07.31

6772

8

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

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

2023.08.01

1144

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1396

5

java有什么用
java有什么用

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

2023.08.02

2809

5

java在线网站
java在线网站

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

2023.08.03

20111

3

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

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

2023.08.03

1235

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习