Java 中注解怎么结合编译期注解处理器生成代码

大强大大_3435

大强大大_3435

2026-08-27

214人浏览

原创

java编译期注解处理器(apt)在编译阶段扫描注解并生成源文件,运行时零开销,核心通过javax.annotation.processing实现,需定义source保留策略注解、继承abstractprocessor、用filer生成代码,并在meta-inf/services中注册;注意仅能读取源码信息、不可修改原类、需用javapoet等工具安全生成代码。

java 中注解怎么结合编译期注解处理器生成代码

Java 中通过 编译期注解处理器(Annotation Processor),可以在编译阶段扫描特定注解,并自动生成 Java 源文件或资源文件。这种方式不修改原有类,也不依赖反射,生成的代码在编译期就存在,运行时零开销,常用于 ButterKnife、Dagger、Lombok(部分能力)、Room 等框架。

核心机制:APT(Annotation Processing Tool)

从 JDK 6 开始,Java 提供了标准的注解处理 API(javax.annotation.processing),编译器(如 javac)会在编译过程中调用注册的 Processor 实现类。它分两步执行:

  • 发现并收集所有被标记的元素(类、方法、字段等)及其注解信息;
  • 调用 Filer 创建新的 .java 文件(或辅助资源),交由后续编译阶段处理。

实现一个简单注解 + 处理器的步骤

以生成「根据注解自动生成 Builder 类」为例:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 定义注解:必须声明 @Retention(RetentionPolicy.SOURCE)(仅保留到源码期)和 @Target(ElementType.TYPE)(作用于类);
  • 编写 Processor:继承 AbstractProcessor,重写 process() 方法,在其中遍历 RoundEnvironment 获取被注解的 Element;
  • 生成代码:用 Filer.createSourceFile() 创建新源文件,配合字符串拼接或模板引擎(如 JavaPoet)写出合法 Java 代码;
  • 注册处理器:在 resources/META-INF/services/javax.annotation.processing.Processor 中写入处理器全限定名。

关键细节与注意事项

实际开发中容易踩坑的地方:

  • 注解处理器运行在独立的 round 中,不能访问已生成字节码,只能读取源码级信息(如类型名、方法签名),无法获取泛型实际类型参数(需用 TypeMirror 和 TypeUtils 推导);
  • 不能在 process() 中修改已有类结构(如添加方法),只能新建文件;
  • 多个处理器之间无执行顺序保证,若需依赖,应使用 @SupportedOptions 或模块化隔离;
  • Maven/Gradle 需显式配置 annotationProcessor 依赖(如 Gradle 的 annotationProcessor 'group:artifact:version'),否则不会触发处理流程。

推荐工具:JavaPoet 让代码生成更安全

手动拼接字符串易出错且难维护。Square 开源的 JavaPoet 可以用声明式 API 构建语法树:

  • 支持 MethodSpec、TypeSpec、FieldSpec 等对象描述结构;
  • 自动处理缩进、分号、import 导入、重名类去重;
  • 与 APT 集成自然,例如:JavaFile.builder("com.example", typeSpec).build().writeTo(filer)。

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

9917

6

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

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

2023.07.05

7062

9

java自学难吗
java自学难吗

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

2023.07.31

6232

8

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

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

2023.08.01

1084

3

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

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

2023.08.02

888

3

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

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

2023.08.02

1296

5

java有什么用
java有什么用

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

2023.08.02

2609

5

java在线网站
java在线网站

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

2023.08.03

19931

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习