Java中 自定义注解配合 APT 怎么在编译期生成代码

大宇小哥_1698

大宇小哥_1698

2026-07-25

380人浏览

原创

java自定义注解配合apt可在编译期生成代码,需定义source保留策略的注解、继承abstractprocessor编写处理器、通过filer生成文件,并正确注册处理器以避免循环和类型误判。

java中 自定义注解配合 apt 怎么在编译期生成代码

Java 中自定义注解配合 APT(Annotation Processing Tool)可以在编译期自动生成代码,核心是通过编写注解处理器(AbstractProcessor),在 javac 编译过程中扫描并处理特定注解,然后用 Filer 生成新的 Java 文件或资源文件。

定义自定义注解

注解需声明保留策略为 RetentionPolicy.SOURCE(仅保留在源码阶段),且必须指定 @Target(如 ElementType.TYPE、ElementType.FIELD 等):

  • 使用 @Retention(RetentionPolicy.SOURCE) 避免运行时加载开销
  • 加上 @Target({ElementType.TYPE, ElementType.FIELD}) 明确可标注位置
  • 若需传递配置,可用 String value() default "" 或 Class>[] types() default {} 等属性

编写注解处理器

继承 AbstractProcessor,重写 process() 方法,通过 RoundEnvironment 获取被注解的元素:

java-enterprise
java-enterprise

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

下载
  • 在 init() 中获取 Messager(日志)、Filer(生成文件)、Elements(解析元素)等工具
  • process() 中调用 roundEnv.getElementsAnnotatedWith(YourAnnotation.class) 拿到所有匹配元素
  • 对每个 Element,用 element.getSimpleName()、element.getEnclosedElements() 等提取信息
  • 用 filer.createSourceFile() 创建 .java 文件,并用 Writer 写入内容(推荐结合 JavaPoet 或纯字符串拼接)

注册和打包处理器

让编译器识别你的处理器,有两种方式:

  • 在 resources/META-INF/services/javax.annotation.processing.Processor 文件中写入处理器全限定类名(如 com.example.MyProcessor)
  • 使用 @AutoService(Processor.class)(需引入 auto-service 库,自动注册)
  • 将处理器项目打成 jar 包,编译时通过 -processorpath 指定路径,或 Maven 中配置 maven-compiler-plugin 的 annotationProcessorPaths

注意事项与常见问题

APT 运行在编译期,不参与运行逻辑,但容易因误操作导致编译失败或无限循环:

  • 不要在 process() 中修改已有源文件,只能生成新文件
  • 避免在一次 round 中生成又立即被本 processor 处理的注解(否则可能触发下一轮 processing,造成循环)
  • 类型信息受限:不能直接用 instanceof 判断泛型类型,需用 Types.isSameType() 或 getKind() == ElementKind.CLASS 等 API
  • 调试困难:可在 Messager 中用 warning() 或 error() 输出提示,配合 IDE 的 annotation processor 设置启用 verbose 日志

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

10177

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人学习