讲师中心 微信公众号
AI工具推荐 视频效率加速

Java 中注解处理器怎么编写才能在编译期生成代码

胖磊君_5712

胖磊君_5712

发布时间:2026-10-26 08:46:30

|

769人浏览过

|

来源于php中文网

原创

Java注解处理器需实现Processor接口,通过META-INF注册或auto-service简化,用RoundEnvironment获取元素并安全解析,借助Filer或JavaPoet生成源码,注意annotationProcessor依赖、跨模块可见性及多轮处理陷阱。

java 中注解处理器怎么编写才能在编译期生成代码

Java 注解处理器(Annotation Processor)在编译期生成代码,核心是实现 javax.annotation.processing.Processor 接口,并配合 @SupportedAnnotationTypes 和 @SupportedSourceVersion 声明支持的注解与 Java 版本。关键不在于“写个类”,而在于正确注册、识别目标注解、解析元素、生成合法源码文件。

声明处理器并正确注册

注解处理器必须被编译器发现并加载,不能靠手动触发。需在 META-INF/services/javax.annotation.processing.Processor 文件中写入处理器全限定名(如 com.example.MyProcessor)。Maven 项目推荐用 google/auto-service 库自动完成注册:

  • 添加依赖:compileOnly 'com.google.auto.service:auto-service-annotations:1.1.1' 和 annotationProcessor 'com.google.auto.service:auto-service:1.1.1'
  • 在处理器类上加 @AutoService(Processor.class),无需手写配置文件
  • 确保注解本身用 @Retention(RetentionPolicy.SOURCE),否则不会参与编译期处理

获取被注解的元素并安全提取信息

在 process() 方法中,通过 RoundEnvironment 获取所有匹配注解的 Element。注意:不能直接强转为 TypeElement 或 VariableElement,应先用 element.getKind() 判断类型;访问字段/方法名、类型、注解值时,必须用 element.getSimpleName().toString()、element.asType().toString() 等安全方式——因为 AST 尚未生成完整 Class,反射或 .getClass() 会失败。

Java注释规范Skills
Java注释规范Skills

当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。

下载
  • 用 Elements 工具类获取包名、父类、接口等元信息
  • 用 Types 工具类比较类型(如 types.isSameType(a, b)),避免字符串比对
  • 若需读取注解属性值(尤其是数组、嵌套注解),用 AnnotationMirror + AnnotationValueVisitor 安全遍历

用 JavaPoet 或原生 Filer 生成源码文件

生成代码必须通过 Filer 创建 JavaFileObject,不能直接写磁盘文件,否则编译器无法识别和编译新生成的类。推荐使用 JavaPoet(Square 出品)构造结构化代码,它能自动处理缩进、导入、泛型、重复类名冲突等问题:

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

  • 添加依赖:compileOnly 'com.squareup:javapoet:1.13.0'
  • 构建 TypeSpec 描述类,用 MethodSpec 描述方法,再通过 JavaFile.builder(packageName, typeSpec).build().writeTo(filer) 输出
  • 若不用第三方库,可用 filer.createSourceFile("com.example.GeneratedClass") 获得 Writer,但需手动拼接字符串——易出错,不推荐用于复杂逻辑
  • 生成的类名必须全局唯一,建议加入哈希或基于原始类名派生(如 OriginalClass$$Proxy)

规避常见陷阱

很多处理器看似运行了却没生成代码,往往卡在以下环节:

  • 注解处理器模块未被 annotationProcessor scope 引入:Gradle 中写成 implementation 或 compileOnly 都无效,必须用 annotationProcessor(或 kapt for Kotlin)
  • 跨 module 时注解类不可见:被处理的注解必须在 processor 的 classpath 中,通常需把注解定义放在独立的 -api 模块并让 processor 依赖它
  • 多次 round 导致重复生成:检查 roundEnv.processingOver(),只在最后一轮生成;或用 roundEnv.getRootElements() 判定是否首次处理
  • 生成的类引用了尚未编译的类:只能引用已存在的类(JDK 类、processor 依赖的类、当前编译单元中已处理完的类),不能引用同一轮中其他待生成的类

热门AI工具

更多
豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

火山引擎

火山引擎是一款面向企业的云计算与AI服务平台。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

11277

2023.06.15

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

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

8402

2023.07.05

java自学难吗
java自学难吗

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

7232

2023.07.31

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

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

1204

2023.08.01

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

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

968

2023.08.02

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

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

1456

2023.08.02

java有什么用
java有什么用

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

2969

2023.08.02

java在线网站
java在线网站

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

20231

2023.08.03

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

60

2026.10.22

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn