Java APT_java APT 生成代码
liuian 2025-10-02 03:21 54 浏览
Java APT(Annotation Processing Tool)是一种在 Java 编译阶段处理注解的工具。APT 会在编译阶段扫描源代码中的注解,并根据这些注解生成代码、资源文件或其他输出,从而实现代码自动生成、配置生成、校验逻辑等功能。
一、APT 是什么?
APT 全称是 Annotation Processing Tool,它是 Java 编译器的一部分,用于在编译阶段处理注解(Annotations)。APT 允许开发者编写自定义的注解处理器(Annotation Processor),并在编译期间根据注解生成额外的代码或资源。
1.1 注解处理的生命周期
APT 的工作发生在编译阶段,具体是在 javac 编译 .java 文件为 .class 文件之前。在这个阶段,注解处理器可以:
- 扫描和处理源码中的注解;
- 生成新的 Java 源文件(.java)或资源文件;
- 修改已有的代码(不推荐,通常通过生成代码来替代)。
二、APT 的核心组件
2.1 注解(Annotation)
Java 注解是一种元数据形式,可以添加到类、方法、字段等元素上。例如:
@Retention(RetentionPolicy.SOURCE)
@Target(ElementType.TYPE)
public @interface MyAnnotation {
}2.2 注解处理器(Annotation Processor)
需要编写一个类实现 javax.annotation.processing.Processor 接口,或者继承 AbstractProcessor 类。
@SupportedAnnotationTypes("com.example.MyAnnotation")
@SupportedSourceVersion(SourceVersion.RELEASE_8)
public class MyAnnotationProcessor extends AbstractProcessor {
@Override
public boolean process(Set<? extends TypeElement> annotations, RoundEnvironment roundEnv) {
for (TypeElement annotation : annotations) {
Set<? extends Element> elements = roundEnv.getElementsAnnotatedWith(annotation);
for (Element element : elements) {
// 处理被注解的类、方法等
System.out.println("Found annotated element: " + element);
// 生成代码
generateCode(element);
}
}
return true;
}
private void generateCode(Element element) {
// 使用 JavaPoet 或手动拼接生成 Java 源文件
}
}2.3 注册处理器
可以在 resources/META-INF/services/javax.annotation.processing.Processor 文件中注册你的处理器:
com.example.MyAnnotationProcessor三、APT 的使用场景
APT 常用于以下场景:
框架 | 用途 |
Dagger / Hilt | 依赖注入框架,通过注解生成依赖注入代码 |
Butter Knife / ViewBinding | 视图绑定,通过注解绑定 View |
Lombok | 通过注解简化 Java 代码,如自动生成 getter/setter |
Room | 数据库框架,通过注解生成数据库访问代码 |
AutoService / AutoValue | 自动生成代码,简化开发 |
四、APT 的优缺点
优点:
- 提升开发效率:自动生成重复代码;
- 减少运行时开销:处理在编译期完成,不影响运行时性能;
- 编译期检查:可以在编译时进行类型安全检查;
- 与 IDE 集成良好。
缺点:
- 学习曲线陡峭:需要理解注解、处理器、代码生成等机制;
- 调试困难:APT 错误信息可能不直观;
- 生成代码维护困难:如果生成代码结构复杂,调试和维护成本高;
- 影响编译速度:注解处理器复杂或过多会拖慢编译速度。
五、APT 工具推荐
工具 | 说明 |
JavaPoet | Square 提供的 Java 代码生成库,简化代码生成过程 |
AutoService | Google 提供的工具,帮助自动生成 META-INF/services/ 文件 |
KAPT | Kotlin 的 APT 支持(用于 Kotlin 与 Java APT 兼容) |
KSP(Kotlin Symbol Processing) | Kotlin 官方提供的 APT 替代方案,比 KAPT 更快 |
六、简单示例:用 JavaPoet 生成代码
private void generateCode(Element element) {
TypeSpec generatedClass = TypeSpec.classBuilder("GeneratedClass")
.addMethod(MethodSpec.methodBuilder("sayHello")
.addStatement("System.out.println($S)", "Hello from " + element.getSimpleName())
.build())
.build();
JavaFile javaFile = JavaFile.builder("com.example", generatedClass).build();
try {
javaFile.writeTo(processingEnv.getFiler());
} catch (IOException e) {
e.printStackTrace();
}
}编译后会生成:
package org.example.apt;
public class GeneratedClass {
public void sayHello() {
System.out.println("Hello from MyClass");
}
}七、总结
APT 是 Java 编译期处理注解的强大工具,广泛用于现代 Java/Kotlin 框架中。通过 APT,你可以:
- 自动生成代码;
- 提高开发效率;
- 实现编译期安全检查;
- 构建插件化、模块化的架构。
虽然学习成本较高,但掌握后可以极大提升开发效率和系统设计能力。
相关推荐
-
- 驱动网卡(怎么从新驱动网卡)
-
网卡一般是指为电脑主机提供有线无线网络功能的适配器。而网卡驱动指的就是电脑连接识别这些网卡型号的桥梁。网卡只有打上了网卡驱动才能正常使用。并不是说所有的网卡一插到电脑上面就能进行数据传输了,他都需要里面芯片组的驱动文件才能支持他进行数据传输...
-
2026-01-30 00:37 liuian
- win10更新助手装系统(微软win10更新助手)
-
1、点击首页“系统升级”的按钮,给出弹框,告诉用户需要上传IMEI码才能使用升级服务。同时给出同意和取消按钮。华为手机助手2、点击同意,则进入到“系统升级”功能华为手机助手华为手机助手3、在检测界面,...
- windows11专业版密钥最新(windows11专业版激活码永久)
-
Windows11专业版的正版密钥,我们是对windows的激活所必备的工具。该密钥我们可以通过微软商城或者通过计算机的硬件供应商去购买获得。获得了windows11专业版的正版密钥后,我...
-
- 手机删过的软件恢复(手机删除过的软件怎么恢复)
-
操作步骤:1、首先,我们需要先打开手机。然后在许多图标中找到带有[文件管理]文本的图标,然后单击“文件管理”进入页面。2、进入页面后,我们将在顶部看到一行文本:手机,最新信息,文档,视频,图片,音乐,收藏,最后是我们正在寻找的[更多],单击...
-
2026-01-29 23:55 liuian
- 一键ghost手动备份系统步骤(一键ghost 备份)
-
步骤1、首先把装有一键GHOST装系统的U盘插在电脑上,然后打开电脑马上按F2或DEL键入BIOS界面,然后就选择BOOT打USDHDD模式选择好,然后按F10键保存,电脑就会马上重启。 步骤...
- 怎么创建局域网(怎么创建局域网打游戏)
-
1、购买路由器一台。进入路由器把dhcp功能打开 2、购买一台交换机。从路由器lan端口拉出一条网线查到交换机的任意一个端口上。 3、两台以上电脑。从交换机任意端口拉出网线插到电脑上(电脑设置...
- 精灵驱动器官方下载(精灵驱动手机版下载)
-
是的。驱动精灵是一款集驱动管理和硬件检测于一体的、专业级的驱动管理和维护工具。驱动精灵为用户提供驱动备份、恢复、安装、删除、在线更新等实用功能。1、全新驱动精灵2012引擎,大幅提升硬件和驱动辨识能力...
- 一键还原系统步骤(一键还原系统有哪些)
-
1、首先需要下载安装一下Windows一键还原程序,在安装程序窗口中,点击“下一步”,弹出“用户许可协议”窗口,选择“我同意该许可协议的条款”,并点击“下一步”。 2、在弹出的“准备安装”窗口中,可...
- 电脑加速器哪个好(电脑加速器哪款好)
-
我认为pp加速器最好用,飞速土豆太懒,急速酷六根本不工作。pp加速器什么网页都加速,太任劳任怨了!以上是个人观点,具体性能请自己试。ps:我家电脑性能很好。迅游加速盒子是可以加速电脑的。因为有过之...
- 任何u盘都可以做启动盘吗(u盘必须做成启动盘才能装系统吗)
-
是的,需要注意,U盘的大小要在4G以上,最好是8G以上,因为启动盘里面需要装系统,内存小的话,不能用来安装系统。内存卡或者U盘或者移动硬盘都可以用来做启动盘安装系统。普通的U盘就可以,不过最好U盘...
- u盘怎么恢复文件(u盘文件恢复的方法)
-
开360安全卫士,点击上面的“功能大全”。点击文件恢复然后点击“数据”下的“文件恢复”功能。选择驱动接着选择需要恢复的驱动,选择接入的U盘。点击开始扫描选好就点击中间的“开始扫描”,开始扫描U盘数据。...
- 系统虚拟内存太低怎么办(系统虚拟内存占用过高什么原因)
-
1.检查系统虚拟内存使用情况,如果发现有大量的空闲内存,可以尝试释放一些不必要的进程,以释放内存空间。2.如果系统虚拟内存使用率较高,可以尝试增加系统虚拟内存的大小,以便更多的应用程序可以使用更多...
-
- 剪贴板权限设置方法(剪贴板访问权限)
-
1、首先打开iphone手机,触碰并按住单词或图像直到显示选择选项。2、其次,然后选取“拷贝”或“剪贴板”。3、勾选需要的“权限”,最后选择开启,即可完成苹果剪贴板权限设置。仅参考1.打开苹果手机设置按钮,点击【通用】。2.点击【键盘】,再...
-
2026-01-29 21:37 liuian
- 平板系统重装大师(平板重装win系统)
-
如果你的平板开不了机,但可以连接上电脑,那就能好办,楼主下载安装个平板刷机王到你的个人电脑上,然后连接你的平板,平板刷机王会自动识别你的平板,平板刷机王上有你平板的我刷机包,楼主点击下载一个,下载完成...
- 联想官网售后服务网点(联想官网售后服务热线)
-
联想3c服务中心是联想旗下的官方售后,是基于互联网O2O模式开发的全新服务平台。可以为终端用户提供多品牌手机、电脑以及其他3C类产品的维修、保养和保险服务。根据客户需求层次,联想服务针对个人及家庭客户...
- 一周热门
-
-
用什么工具在Win中查看8G大的log文件?
-
如何在 Windows 10 或 11 上通过命令行安装 Node.js 和 NPM
-
如何修改图片拍摄日期?快速修改图片拍摄日期的6种方法
-
5步搞定动态考勤表!标记节假日、调休日?Excel自动变色!
-
RK3588-HDMIRX(瑞芯微rk3588芯片手册)
-
用纯Python轻松构建Web UI:Remi 动态更新,实时刷新界面内容
-
tplink无线路由器桥接教程(tplink路由器如何进行无线桥接)
-
R语言 | CNS绘图第1款——linkET万物皆可连
-
都说Feign是RPC,没有侵入性,为什么我的代码越来越像 C++
-
windows11专业版密钥最新(windows11专业版激活码永久)
-
- 最近发表
- 标签列表
-
- python判断字典是否为空 (50)
- crontab每周一执行 (48)
- aes和des区别 (43)
- bash脚本和shell脚本的区别 (35)
- canvas库 (33)
- dataframe筛选满足条件的行 (35)
- gitlab日志 (33)
- lua xpcall (36)
- blob转json (33)
- python判断是否在列表中 (34)
- python html转pdf (36)
- 安装指定版本npm (37)
- idea搜索jar包内容 (33)
- css鼠标悬停出现隐藏的文字 (34)
- linux nacos启动命令 (33)
- gitlab 日志 (36)
- adb pull (37)
- python判断元素在不在列表里 (34)
- python 字典删除元素 (34)
- vscode切换git分支 (35)
- python bytes转16进制 (35)
- grep前后几行 (34)
- hashmap转list (35)
- c++ 字符串查找 (35)
- mysql刷新权限 (34)
