Java APT_java APT 生成代码
liuian 2025-10-02 03:21 42 浏览
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,你可以:
- 自动生成代码;
- 提高开发效率;
- 实现编译期安全检查;
- 构建插件化、模块化的架构。
虽然学习成本较高,但掌握后可以极大提升开发效率和系统设计能力。
相关推荐
- 搭建一个20人的办公网络(适用于20多人的小型办公网络环境)
-
楼主有5台机上网,则需要一个8口路由器,组网方法如下:设备:1、8口路由器一台,其中8口为LAN(局域网)端口,一个WAN(广域网)端口,价格100--400元2、网线N米,这个你自己会看了:)...
- 笔记本电脑各种参数介绍(笔记本电脑各项参数新手普及知识)
-
1、CPU:这个主要取决于频率和二级缓存,频率越高、二级缓存越大,速度越快,现在的CPU有三级缓存、四级缓存等,都影响相应速度。2、内存:内存的存取速度取决于接口、颗粒数量多少与储存大小,一般来说,内...
- 汉字上面带拼音输入法下载(字上面带拼音的输入法是哪个)
-
使用手机上的拼音输入法打成汉字的方法如下:1.打开手机上的拼音输入法,在输入框中输入汉字的拼音,例如“nihao”。2.根据输入法提示的候选词,选择正确的汉字。例如,如果输入“nihao”,输...
- xpsp3安装版系统下载(windowsxpsp3安装教程)
-
xpsp3纯净版在采用微软封装部署技术的基础上,结合作者的实际工作经验,融合了许多实用的功能。它通过一键分区、一键装系统、自动装驱动、一键设定分辨率,一键填IP,一键Ghost备份(恢复)等一系列...
- 没有备份的手机数据怎么恢复
-
手机没有备份恢复数据方法如下1、使用数据线将手机与电脑连接好,在“我的电脑”中可以看到手机的盘符。 2、将手机开启USB调试模式。在手机设置中找到开发者选项,然后点击“开启USB调试模式”。 3、...
- 电脑怎么激活windows11专业版
-
win11专业版激活方法有多种,以下提供两种常用的激活方式:方法一:使用激活密钥激活。在win11桌面上右键点击“此电脑”,选择“属性”选项。进入属性页面后,点击“更改产品密钥或升级windows”。...
- 华为手机助手下载官网(华为手机助手app下载专区)
-
华为手机助手策略调整,已不支持从应用市场下载手机助手,目前华为手机助手是需要在电脑上下载或更新手机助手到最新版本,https://consumer.huawei.com/cn/support/his...
- 光纤线断了怎么接(宽带光纤线断了怎么接)
-
宽带光纤线断了可以重接,具体操作方法如下:1、光纤连接的时候要根据束管内,同色相连,同芯相连,按顺序进行连接,由大到小。一般有三种连接方法,分别是熔接、活动连接和机械连接。2、连接的时候要开剥光缆,抛...
- win7旗舰版和专业版区别(win7旗舰版跟专业版)
-
1、功能区别:Win7旗舰版比专业版多了三个功能,分别是Bitlocker、BitlockerToGo和多语言界面; 2、用途区别:旗舰版的功能是所有版本中最全最强大的,占用的系统资源,...
- 万能连接钥匙(万能wifi连接钥匙下载)
-
1、首先打开wifi万能钥匙软件,若手机没有开启WLAN,就根据软件提示打开WLAN开关;2、打开WLAN开关后,会显示附近的WiFi,如果知道密码,可点击相应WiFi后点击‘输入密码’连接;3、若不...
- 雨林木风音乐叫什么(雨林木风是啥)
-
雨林木风的创始人是陈年鑫先生。陈年鑫先生于1999年创立了雨林木风公司,其初衷是为满足中国市场对高品质、高性能电脑的需求。在陈年鑫先生的领导下,雨林木风以技术创新、产品质量和客户服务为核心价值,不断推...
- aics6序列号永久序列号(aics6破解序列号)
-
关于AICS6这个版本,虽然是比较久远的版本,但是在功能上也是十分全面和强大的,作为一名平面设计师的话,AICS6的现有的功能已经能够应付几乎所有的设计工作了……到底AICC2019的功能是不是...
- 手机可以装电脑系统吗(手机可以装电脑系统吗怎么装)
-
答题公式1:手机可以通过数据线或无线连接的方式给电脑装系统。手机安装系统需要一定的技巧和软件支持,一般需要通过数据线或无线连接的方式与电脑连接,并下载相应的软件和系统文件进行安装。对于大部分手机用户来...
- 一周热门
- 最近发表
- 标签列表
-
- 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)
