Java 中注解原理怎么实现编译期注解处理器 APT

冬宇小哥_1052

冬宇小哥_1052

2026-10-31

860人浏览

原创

APT是javac在编译早期调用的注解处理器,基于JSR 269规范和Processor接口,扫描源码、读取SOURCE/CLASS级注解并生成新Java文件,不修改原类,全过程在class生成前完成。

java 中注解原理怎么实现编译期注解处理器 apt

Java 中的编译期注解处理器(APT)不是靠运行时反射,而是由 javac 在编译早期阶段主动调用注册好的处理器,扫描源码、读取注解元数据,并生成新 Java 文件——整个过程发生在 class 字节码生成之前。

APT 的核心支撑:JSR 269 和 Processor 接口

从 Java 6 开始,官方通过 JSR 269 规范定义了可插拔的注解处理 API。所有 APT 行为都围绕 javax.annotation.processing.Processor 接口展开。实际开发中,通常继承 AbstractProcessor,它已封装了初始化、类型匹配、错误报告等基础逻辑。

关键点:

  • 处理器必须声明支持哪些注解类型(通过 getSupportedAnnotationTypes() 或 @SupportedAnnotationTypes)
  • 必须声明支持的 Java 源码版本(如 @SupportedSourceVersion(RELEASE_17))
  • 核心逻辑写在 process() 方法里,每次编译轮次都会传入 RoundEnvironment,从中获取被注解标记的元素(类、字段、方法等)
  • 通过 ProcessingEnvironment 提供的 Filer 生成 .java 文件,用 Elements 解析结构,用 Types 做类型判断

注解本身必须是编译期可见的

注解能否被 APT 捕获,取决于它的保留策略:@Retention(RetentionPolicy.SOURCE) 或 @Retention(RetentionPolicy.CLASS) 才行。

Java Api Extractor
Java Api Extractor

从 Java 项目中提取 Controller 层接口定义为 JSON 数据。

下载

原因很直接:

  • SOURCE:只保留在源码中,javac 能看到,运行时完全不可见 —— 最适合纯代码生成场景(如 @Data、@Builder)
  • CLASS:保留在 class 文件里但 JVM 不加载 —— 适合需要编译后工具(如字节码增强)配合的场景
  • RUNTIME:虽然也能被 APT 处理,但属于“过度保留”,增加 class 体积,且违背编译期处理的设计初衷

处理器如何被 javac 发现并启用

javac 不会自动扫描项目里的 Processor 类。它依赖 Java 的 SPI(Service Provider Interface)机制:

  • 在处理器模块的 META-INF/services/ 目录下,创建文件 javax.annotation.processing.Processor
  • 文件内容写上实现类的全限定名,例如:com.example.MyAnnotationProcessor
  • 编译时把该 jar(或 classpath)传给 javac,它就会按约定加载并实例化处理器
  • 现代构建工具(Maven/Gradle)通过 annotationProcessor 依赖配置自动完成这一步,无需手动维护 META-INF

生成代码而非修改原类:安全且可控

标准 APT 不能修改已有类的语法树(那是 Lombok 等库借助 javac 内部 API 实现的扩展能力),但它能可靠地生成全新 Java 文件:

  • 比如 @Loggable 注解触发生成 MyClass$$Logger.java
  • 生成的文件和原始源码一起参与后续编译,最终合并进 class 输出
  • 这种“只增不改”的设计避免了编译器兼容性风险,也便于调试(生成的代码可直接查看)

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

11577

6

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

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

2023.07.05

8702

9

java自学难吗
java自学难吗

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

2023.07.31

7472

8

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

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

2023.08.01

1224

3

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

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

2023.08.02

988

3

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

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

2023.08.02

1476

5

java有什么用
java有什么用

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

2023.08.02

3049

5

java在线网站
java在线网站

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

2023.08.03

20291

3

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

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

2023.08.03

1335

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习