0

0

如何利用Java注解处理(APT)在编译期生成代码_Lombok原理初探

P粉602998670

P粉602998670

发布时间:2026-03-08 13:00:12

|

950人浏览过

|

来源于php中文网

原创

apt是java编译期注解处理工具,通过jsr-269标准在javac阶段生成代码,能替代部分模板代码但需正确配置环境;lombok即基于此实现,但jdk 17+需额外--add-exports参数。

如何利用java注解处理(apt)在编译期生成代码_lombok原理初探

Java APT 是什么,它真能替代手动写模板代码?

APT(Annotation Processing Tool)不是运行时反射,也不是字节码增强,它是编译器在 javac 阶段调用的一套标准接口,允许你在源码编译完成前读取注解、生成新 Java 文件。Lombok 就是靠它把 @Data 展开成 getter/setter/toString 等方法——但注意:它不修改原有类,只生成额外的 .java 文件(或直接注入到 AST,取决于实现方式)。

常见错误现象:Cannot resolve symbol 报错,明明写了 @Data 却没看到生成的方法;或者 IDE 不识别,但 mvn compile 又成功——这通常是因为 IDE 没启用 annotation processor,或未正确配置 processor path。

  • 必须在构建工具中显式启用:Maven 要配 maven-compiler-pluginannotationProcessorPaths;Gradle 要用 annotationProcessor 依赖 scope
  • IDEA 默认关闭 APT 支持,需进 Settings > Build > Compiler > Annotation Processors 手动勾选“Enable annotation processing”
  • Lombok 是个特例:它用的是 JSR-269 标准 + javac 内部 API(如 com.sun.source.tree),所以部分 JDK 版本(如 JDK 17+)需要额外加 --add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED

Lombok 的 @Data 到底生成了哪些东西?

@Data 不是魔法,它等价于同时加了 @Getter@Setter@ToString@EqualsAndHashCode@RequiredArgsConstructor(仅对 final@NonNull 字段)。但它不会生成无参构造函数,除非你显式加 @NoArgsConstructor

容易踩的坑:

立即学习Java免费学习笔记(深入)”;

Q.AI视频生成工具
Q.AI视频生成工具

支持一分钟生成专业级短视频,多种生成方式,AI视频脚本,在线云编辑,画面自由替换,热门配音媲美真人音色,更多强大功能尽在QAI

下载
  • @Datastatic 字段或 transient 字段默认忽略 getter/setter,但 toString() 仍会包含它们(除非用 @ToString.Exclude
  • hashCode()equals() 默认只基于非静态字段,但若字段类型本身没重写 equals,生成的逻辑可能不符合预期
  • 继承场景下:@Data 不会为父类字段生成 getter,也不会在 toString 中自动包含父类字段(需配合 @EqualsAndHashCode(callSuper = true) 等显式声明)

自己写一个简单 APT Processor,为什么编译后看不到生成的类?

最常卡在这一步:你写了 MyProcessor extends AbstractProcessor,也注册了 META-INF/services/javax.annotation.processing.Processor,但 process() 方法压根没被调用,或者生成的 .java 文件没出现在 target/generated-sources/annotations 下。

核心原因只有两个:

  • processor 没被 javac 扫描到:确保 jar 包里有正确的 META-INF/services/javax.annotation.processing.Processor 文件,且内容是完整类名(如 com.example.MyProcessor),末尾不能有多余空格或换行
  • 生成路径不对:必须用 Filer.createSourceFile(),不能用 new File().write();否则文件虽存在,但不会被编译器识别为源码参与后续编译
  • 如果想生成类 A,并让它被当前模块其他类引用,必须保证生成时机早于引用它的类——即 APT 必须在主源码编译前完成,且生成路径要加入 source roots(Maven 插件会自动处理,但纯命令行 javac 需手动加 -s 参数指定输出目录)

APT 和 Lombok 在 JDK 17+ 上为啥经常报错?

根本矛盾在于:JDK 9 引入模块系统后,com.sun.* 包被默认封装,而 Lombok 重度依赖 com.sun.tools.javac.treecom.sun.tools.javac.util 这些内部 API。JDK 17 进一步收紧,默认禁止反射访问这些包。

典型错误信息:java.lang.IllegalAccessError: class lombok.javac.apt.LombokProcessormodule java.base does not "opens java.lang" to unnamed module

  • 解决方案不是降级 JDK,而是启动参数加白名单:Maven 命令需带 -DjvmArgs="--add-exports jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED"
  • IntelliJ 用户还要在 Settings > Build > Compiler > Java Compiler 里填上同样的 Additional command line parameters
  • Gradle 用户可在 compileJava task 的 options.forkOptions.jvmArgs 中设置,但要注意:这个参数只对 forked 编译生效,非 fork 模式下无效

真正麻烦的从来不是写注解或生成逻辑,而是让整个链路在不同 JDK、不同构建环境、不同 IDE 下稳定触发——哪怕只是多了一个空格,或少一个 --add-exports,就卡住。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
Java Maven专题
Java Maven专题

本专题聚焦 Java 主流构建工具 Maven 的学习与应用,系统讲解项目结构、依赖管理、插件使用、生命周期与多模块项目配置。通过企业管理系统、Web 应用与微服务项目实战,帮助学员全面掌握 Maven 在 Java 项目构建与团队协作中的核心技能。

0

2025.09.15

硬盘接口类型介绍
硬盘接口类型介绍

硬盘接口类型有IDE、SATA、SCSI、Fibre Channel、USB、eSATA、mSATA、PCIe等等。详细介绍:1、IDE接口是一种并行接口,主要用于连接硬盘和光驱等设备,它主要有两种类型:ATA和ATAPI,IDE接口已经逐渐被SATA接口;2、SATA接口是一种串行接口,相较于IDE接口,它具有更高的传输速度、更低的功耗和更小的体积;3、SCSI接口等等。

1848

2023.10.19

PHP接口编写教程
PHP接口编写教程

本专题整合了PHP接口编写教程,阅读专题下面的文章了解更多详细内容。

614

2025.10.17

php8.4实现接口限流的教程
php8.4实现接口限流的教程

PHP8.4本身不内置限流功能,需借助Redis(令牌桶)或Swoole(漏桶)实现;文件锁因I/O瓶颈、无跨机共享、秒级精度等缺陷不适用高并发场景。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

2357

2025.12.29

java接口相关教程
java接口相关教程

本专题整合了java接口相关内容,阅读专题下面的文章了解更多详细内容。

47

2026.01.19

class在c语言中的意思
class在c语言中的意思

在C语言中,"class" 是一个关键字,用于定义一个类。想了解更多class的相关内容,可以阅读本专题下面的文章。

809

2024.01.03

python中class的含义
python中class的含义

本专题整合了python中class的相关内容,阅读专题下面的文章了解更多详细内容。

28

2025.12.06

idea快捷键大全
idea快捷键大全

本专题为大家提供idea快捷键相关的文章,帮助大家解决问题。

174

2023.08.03

JavaScript浏览器渲染机制与前端性能优化实践
JavaScript浏览器渲染机制与前端性能优化实践

本专题围绕 JavaScript 在浏览器中的执行与渲染机制展开,系统讲解 DOM 构建、CSSOM 解析、重排与重绘原理,以及关键渲染路径优化方法。内容涵盖事件循环机制、异步任务调度、资源加载优化、代码拆分与懒加载等性能优化策略。通过真实前端项目案例,帮助开发者理解浏览器底层工作原理,并掌握提升网页加载速度与交互体验的实用技巧。

23

2026.03.06

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.2万人学习

C# 教程
C# 教程

共94课时 | 10.8万人学习

Java 教程
Java 教程

共578课时 | 78.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号