Java 中注解处理器怎么在编译期工作并生成源码

陌婷小哥_3383

陌婷小哥_3383

2026-11-06

855人浏览

原创

Java注解处理器在编译期自动扫描源码、生成新.java文件:javac按轮次处理,通过Elements/Types获取类型信息,用Filer输出标准源码,不修改原文件、不依赖反射,生成代码纳入编译路径并参与类型检查。

java 中注解处理器怎么在编译期工作并生成源码

Java 注解处理器在 javac 编译阶段 扫描源码中的注解,根据预定义逻辑生成新的 .java 文件,不修改原文件,也不依赖运行时反射。

编译期触发机制

注解处理器不是手动调用的工具,而是由 javac 自动发现并执行的:

  • 项目中引入了 processor 依赖(如 mapstruct-processor 或自定义 jar),且该 jar 的 META-INF/services/javax.annotation.processing.Processor 文件里声明了处理器全限定名
  • Maven 中需确保 mapstruct-processor 在 compile 范围;Gradle 需使用 annotationProcessor 配置
  • IDE(如 IntelliJ)必须开启 “Enable annotation processing”,否则不会运行处理器,也看不到生成的代码
  • 注解本身需用 @Retention(RetentionPolicy.SOURCE) 或 CLASS,否则编译器在源码阶段就丢弃了,处理器无法读取

处理流程分轮次进行

javac 把编译过程拆成多轮(round),每轮只处理上一轮新生成的源文件:

ImageMagick 批处理处理器
ImageMagick 批处理处理器

使用 ImageMagick 的 convert 和 mogrify 命令进行批量图像处理,支持调整大小、裁剪、水印和格式转换。与 libvips 集成以实现高性能缩略图生成。

下载
  • 第一轮:扫描用户写的 .java 源文件,找出带目标注解(如 @Mapper、@Data)的类或接口
  • 处理器的 process() 方法被调用,通过 RoundEnvironment 获取所有被注解标记的 Element(类、字段、方法等)
  • 根据注解元数据(如 @Mapping(source="id", target="uid"))和类型信息,用 Filer 写出新的 .java 文件(例如 UserMapperImpl.java)
  • 如果生成了新源文件,javac 启动第二轮,将这些文件加入编译输入,继续扫描和处理,直到某一轮不再生成新文件为止

生成的代码在哪、怎么用

生成的 Java 源码是真实可编译的普通类,和手写代码无异:

  • Maven 默认输出到 target/generated-sources/annotations/,该路径会被自动加入编译源路径(source root)
  • 生成的类(如 XXXMapperImpl)实现了你声明的 @Mapper 接口,可以直接 @Autowired 或 new 使用
  • IDE 能跳转、补全、调试这些类,因为它们是标准 Java 源码,不是字节码注入或运行时代理
  • 不参与 Git 提交——它由构建过程自动生成,应被 .gitignore 排除

关键支撑点:AST 与类型安全

处理器能生成正确代码,靠的是编译器提供的完整上下文:

  • 通过 Elements 和 Types 工具类,可精确获取字段类型、泛型参数、继承关系等信息
  • 所有字段映射、方法调用、类型转换都基于静态类型检查,错误(如字段名拼错、类型不匹配)会在编译时报出,而非运行时崩溃
  • 像 MapStruct 生成 target.setName(source.getUserName()),Lombok 生成 return this.name;,都是靠解析 AST 得出的准确语义,不是字符串模板硬拼

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

相关专题

更多
java
java

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

2023.06.15

12017

6

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

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

2023.07.05

9102

9

java自学难吗
java自学难吗

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

2023.07.31

7792

8

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

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

2023.08.01

1264

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1516

5

java有什么用
java有什么用

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

2023.08.02

3149

5

java在线网站
java在线网站

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

2023.08.03

20391

3

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

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

2023.08.03

1375

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习