Java 怎么在编译期通过注解处理器生成代码

大枫吖_9632

大枫吖_9632

2026-09-04

883人浏览

原创

java注解处理器基于jsr 269在编译期生成代码:先定义source保留级别的自定义注解,再继承abstractprocessor实现process()方法,通过filer生成.java文件,最后通过meta-inf/services或构建工具注册处理器,生成代码自动参与后续编译。

java 怎么在编译期通过注解处理器生成代码

Java 在编译期通过注解处理器(Annotation Processor)生成代码,核心是利用 JSR 269 注解处理框架,在 javac 编译过程中扫描特定注解,并调用你写的处理器生成 .java 源文件(或 .class 文件),这些新生成的代码会自动参与后续编译流程。

1. 定义自定义注解

注解必须声明为 @Retention(RetentionPolicy.SOURCE)(仅保留在源码期)或 CLASS(但处理器通常只关心 SOURCE),并加上 @Target 明确作用位置:

  • 不要用 RUNTIME——运行时注解无法被注解处理器捕获;
  • 推荐加 @Documented 和 @Repeatable(如需)提升可用性;
  • 示例:
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface GenerateBuilder {
}

2. 编写注解处理器(Processor)

继承 AbstractProcessor,重写 process() 方法。关键点:

Java Maven Code Review
Java Maven Code Review

审查Java Maven项目(ZIP压缩包或GitLab仓库URL),检查代码规范、命名、模块边界、可维护性问题以及重复代码。

下载
  • 在 getSupportedAnnotationTypes() 中声明支持哪些注解(推荐用字符串,避免类加载问题);
  • 用 RoundEnvironment 获取被注解的元素(Element),例如 getTypeElementsAnnotatedWith();
  • 用 Filer 创建新 Java 源文件(filer.createSourceFile()),配合 JavaFileObject.openWriter() 写入内容;
  • 用 Messager 输出提示或错误(messager.printMessage(Diagnostic.Kind.NOTE, "..."));

3. 注册处理器并参与编译

有两种主流方式让编译器发现你的处理器:

  • META-INF/services/javax.annotation.processing.Processor:在资源目录下创建该文件,每行写一个处理器全限定名(如 com.example.MyProcessor);
  • 使用 Gradle/Maven 插件显式声明(更可靠,尤其多模块项目):
    Gradle 示例:
    compileOnly 'com.example:processor:1.0'<br>
        annotationProcessor 'com.example:processor:1.0'
  • 注意:处理器 JAR 必须包含 Processor 类且不能依赖未在编译期可见的运行时库(如 Spring);

4. 生成代码的注意事项

生成的代码不是“黑盒”,它和手写代码一样参与完整编译流程:

  • 生成的 .java 文件会被 javac 自动编译成 .class;
  • 可被其他注解处理器再次处理(需注意处理顺序,用 @SupportedOptions 或 getSupportedSourceVersion() 协调);
  • 避免生成语法错误代码——否则编译直接失败;建议用 JavaPoet 等库安全构造代码结构;
  • 不要尝试在 process() 中修改已有源码(JSR 269 不允许),只能生成新文件;

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

相关文章

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

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

下载

相关标签:

java 处理器

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

相关专题

更多
java
java

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

2023.06.15

9577

6

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

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

2023.07.05

6722

9

java自学难吗
java自学难吗

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

2023.07.31

5972

8

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

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

2023.08.01

1044

3

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

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

2023.08.02

868

3

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

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

2023.08.02

1256

5

java有什么用
java有什么用

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

2023.08.02

2509

5

java在线网站
java在线网站

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

2023.08.03

19851

3

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

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

2023.08.03

1135

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习