Java中怎么在编译期通过 APT Annotation Processing Tool 处理注解并生成源码

秋浩同学_3389

秋浩同学_3389

2026-10-10

578人浏览

原创

apt是java编译期注解处理机制,核心作用是在编译阶段扫描注解、读取元素信息并生成新java源文件而不修改原代码。

java中怎么在编译期通过 apt annotation processing tool 处理注解并生成源码

什么是APT与注解处理器的核心作用

APT(Annotation Processing Tool)是Java 5引入、在Java 8中被集成进javac的编译期注解处理机制。它允许你在源码编译阶段扫描特定注解,读取元素信息,并自动生成新的Java源文件(如.java),而**不修改原有代码**。这正是诸如Lombok、ButterKnife(旧版)、Room、MapStruct等框架实现“零运行时反射”的基础。

编写一个最简注解处理器的三步关键操作

要让编译器在javac阶段调用你的处理器,需同时满足:声明注解、实现Processor、注册处理器。缺一不可。

Java Maven Secondary Analysis
Java Maven Secondary Analysis

分析ZIP压缩包或GitLab仓库中的Java Maven项目,确定二次开发范围、类数量、模块分布及生产相关指标。

下载
  • 定义一个可被编译期处理的注解:必须用@Retention(RetentionPolicy.SOURCE),且通常搭配@Target(如ElementType.TYPE或ElementType.FIELD)
  • 继承AbstractProcessor并重写核心方法:
    • getSupportedAnnotationTypes():返回你关心的注解全限定名(如"com.example.BindView"),推荐用Set.of()或Collections.singleton()
    • process():真正干活的地方——遍历RoundEnvironment中的被注解元素,用Filer生成源码,用Messager输出日志或错误
  • 通过META-INF/services/javax.annotation.processing.Processor注册:文件内容只有一行,写上你的处理器类全名(如com.example.BindViewProcessor)

用Filer生成源码的实用要点

生成源码不是拼字符串,而是借助Filer和JavaFileObject安全创建合法Java文件。常见误区是忽略包名、类名冲突或编码问题。

  • 调用filer.createSourceFile("com.example.UserViewBinding")获取JavaFileObject,再用openWriter()写入内容
  • 务必手动写入package com.example;和import语句,否则生成的类无法编译
  • 生成类名建议基于原类+后缀(如UserActivity$$ViewBinder),避免硬编码冲突;可用element.getSimpleName().toString() + "$$Binding"
  • 若需复杂代码结构(如方法体、注解、泛型),推荐搭配JavaPoet库——它专为安全生成Java源码设计,自动处理缩进、分号、导入、重复类名检测等

在项目中启用并调试注解处理器

现代构建工具已屏蔽原始APT命令,但原理一致。关键在于让处理器参与编译流程,并能及时看到错误提示。

  • Maven:把处理器模块作为provided依赖引入主模块;或使用maven-compiler-plugin配置<annotationprocessors></annotationprocessors>显式声明
  • Gradle(Kotlin DSL):dependencies { compileOnly("com.example:processor:1.0") },并确保sourceCompatibility = JavaVersion.VERSION_11及以上(高版本Java要求明确指定处理器路径)
  • 调试技巧:在process()里用messager.printMessage(Diagnostic.Kind.NOTE, "Processing " + element),配合-XprintRounds或-Xlint:processing参数查看编译器行为
  • 注意:处理器不能依赖被处理模块中尚未编译完成的类(即不能用Class.forName()),只能通过Element、TypeMirror等镜像API获取元信息

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

10057

6

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

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

2023.07.05

7202

9

java自学难吗
java自学难吗

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

2023.07.31

6332

8

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

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

2023.08.01

1104

3

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

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

2023.08.02

908

3

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

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

2023.08.02

1336

5

java有什么用
java有什么用

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

2023.08.02

2649

5

java在线网站
java在线网站

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

2023.08.03

19971

3

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

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

2023.08.03

1175

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习