APT插件处理SOURCE注解_注解处理器如何在编译期根据注解生成冗余代码

千涛大大_8992

千涛大大_8992

2026-05-14

279人浏览

原创

APT插件必须使用@Retention(RetentionPolicy.SOURCE)注解,因其仅在源码阶段可见,确保编译期生成Java文件、不污染class文件且语义明确;需继承AbstractProcessor、注册处理器、用Elements/Filer/JavaPoet生成代码,并在Android项目中配置annotationProcessor依赖、启用IDE注解处理及标记生成路径为Sources Root。

apt插件处理source注解_注解处理器如何在编译期根据注解生成冗余代码

APT插件处理 @Retention(RetentionPolicy.SOURCE) 注解,本质是让注解只存在于源码阶段、不进入 class 文件,专为编译期代码生成而设计。它不靠运行时反射,也不改写原有类,而是通过扫描这些“短暂存在”的注解,在 javac 编译过程中实时生成新的 .java 文件——这些文件和手写代码完全等价,会被一并编译进最终的字节码。

为什么必须用 SOURCE 级注解

使用 @Retention(RetentionPolicy.SOURCE) 是 APT 正常工作的前提,原因很直接:

  • 编译器只在源码解析阶段暴露 SOURCE 注解给处理器;CLASS 或 RUNTIME 注解在 APT 阶段可能尚未完成写入或不可见
  • 避免注解残留:SOURCE 注解不会出现在 class 文件里,不增加 APK 体积,也不影响运行时类加载和反射逻辑
  • 语义清晰:明确告诉团队和工具链——这个注解纯属“编译指令”,不是业务配置或运行时元数据

注解处理器如何触发并读取注解

处理器不是自动运行的,它需要被编译器识别并调用。关键步骤包括:

Miller CSV TSV JSON 数据处理器
Miller CSV TSV JSON 数据处理器

Miller (mlr) 是一个命令行工具,用于查询、整形和重新格式化名称索引数据,如 CSV、TSV、JSON 和 JSON Lines。它将 awk、sed、cut、join 和 sort 的功能整合到一个专为结构化数据处理而构建的单一工具中。

下载
  • 继承 AbstractProcessor,重写 process() 方法作为主入口
  • 用 @SupportedAnnotationTypes 声明要监听的注解全限定名(如 "com.example.BindView")
  • 在 META-INF/services/javax.annotation.processing.Processor 中注册类名,或更推荐用 @AutoService(Processor.class) 自动注册
  • 在 process() 中调用 roundEnv.getElementsAnnotatedWith(BindView.class) 获取所有被标注的元素(字段、方法、类等)

从注解信息到 Java 源码的生成逻辑

拿到被注解的元素后,处理器需提取结构化信息,并生成合法、可编译的 Java 代码。典型操作有:

  • 用 Elements 工具类获取包名、类名、字段类型、注解属性值(如 @BindView(R.id.tv) 中的 R.id.tv)
  • 用 Filer 创建新源文件,路径需严格匹配包结构(如 com.example.MainActivity_ViewBinding.java)
  • 推荐使用 JavaPoet 构建代码:它能安全生成带缩进、分号、import 的 Java 源码,避免字符串拼接出错
  • 生成的类通常以 “原类名 + 后缀” 命名,并提供静态 bind() 方法,接收 Activity/Fragment 实例,内部调用 findViewById 并赋值

Android 项目中必须配置的三处关键点

即使代码写对,缺一配置就会导致 process() 不执行、生成文件不出现、IDE 报红:

  • Gradle 依赖声明:compiler 模块要用 annotationProcessor(非 implementation)引入处理器;annotation 模块用 api 或 compileOnly 提供给 app 使用
  • IDE 启用支持:Android Studio 需开启 Settings → Build → Compiler → Annotation Processors → 勾选 “Enable annotation processing”
  • 生成路径识别:确保 IDE 将 build/generated/source/apt/(Gradle)或 out/production/generated-sources/annotations/(IntelliJ)标记为 Sources Root,否则无法跳转和补全

相关专题

更多
java
java

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

2023.06.15

11517

6

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

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

2023.07.05

8642

9

java自学难吗
java自学难吗

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

2023.07.31

7432

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

3029

5

java在线网站
java在线网站

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

2023.08.03

20291

3

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

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

2023.08.03

1335

8

热门下载

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

精品课程

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

共14课时 | 1.5万人学习

PHP入门速学(台湾同胞版)
PHP入门速学(台湾同胞版)

共10课时 | 1.6万人学习

韩顺平 2016年 最新PHP基础视频教程
韩顺平 2016年 最新PHP基础视频教程

共47课时 | 12.2万人学习