Java 中怎么通过 APT(注解处理器)在编译期动态生成 Java 源代码

千婷吖_9538

千婷吖_9538

2026-08-16

429人浏览

原创

java apt在编译期生成源码,需实现processor接口、用source保留策略定义注解、继承abstractprocessor重写process方法,通过filer写入文件,并在meta-inf/services或maven中注册处理器。

java 中怎么通过 apt(注解处理器)在编译期动态生成 java 源代码

Java 中通过 APT(Annotation Processing Tool)在编译期动态生成 Java 源代码,核心是实现 javax.annotation.processing.Processor 接口,并配合 @SupportedAnnotationTypes@SupportedSourceVersion 声明支持的注解与 Java 版本。生成的代码由 Filer 写入源码目录,被后续编译流程自动编译。

定义并注册自定义注解

先创建一个运行时保留的注解,供开发者标记目标类或字段:

@Target({ElementType.TYPE, ElementType.FIELD})
@Retention(RetentionPolicy.SOURCE)  // 必须为 SOURCE,否则注解处理器无法捕获
public @interface GenerateBuilder {
}

注意:注解的 @Retention 必须设为 SOURCE,因为 APT 只处理源码阶段的注解;若用 CLASSRUNTIME处理器将收不到该注解。

编写注解处理器

继承 AbstractProcessor,重写 process() 方法,在其中解析被注解的元素并生成 Java 文件:

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

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

下载
  • 通过 RoundEnvironment 获取所有带指定注解的 Element(如类、字段)
  • 使用 Elements 工具类获取类型名、包名等元信息
  • 调用 Filer.createSourceFile() 创建新源文件,返回 JavaFileObject
  • Writer 向其写入合法 Java 源码(注意缩进、分号、import 等语法)

示例片段:

@Override
public boolean process(Set extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (Element element : roundEnv.getElementsAnnotatedWith(GenerateBuilder.class)) {
        if (element.getKind() == ElementKind.CLASS) {
            TypeElement classElement = (TypeElement) element;
            String packageName = elements.getPackageOf(classElement).getQualifiedName().toString();
            String className = classElement.getSimpleName().toString();
            String builderName = className + "Builder";

            try (Writer writer = filer.createSourceFile(
                    packageName + "." + builderName).openWriter()) {
                writer.write("package " + packageName + ";\n");
                writer.write("public class " + builderName + " { }\n");
            } catch (IOException e) {
                messager.printMessage(Diagnostic.Kind.ERROR, "生成失败: " + e);
            }
        }
    }
    return true;
}

正确配置和启用处理器

确保注解处理器能被编译器识别并执行:

  • Maven 项目中,将处理器模块打包为 jar,并在使用方的 pom.xml 中用 <annotationprocessor></annotationprocessor><processor></processor> 显式声明(JDK 8+ 推荐前者)
  • 或在处理器 jar 的 META-INF/services/javax.annotation.processing.Processor 文件中写入全限定类名(如 com.example.MyProcessor
  • IDE(如 IntelliJ)需开启「Enable annotation processing」并在设置中指定输出路径(如 target/generated-sources/annotations

生成代码时的实用技巧

避免手拼字符串导致语法错误,推荐结合模板或轻量工具:

  • String.format()StringBuilder 组织结构清晰的代码块
  • 借助 JavaPoet 库(Square 出品)安全构建类、方法、字段等,自动处理 import、缩进、泛型等细节
  • 通过 Messager 输出提示或错误(messager.printMessage(WARNING, "...")),便于调试
  • 生成前检查是否已存在同名类(Filer 会抛异常),可加逻辑跳过重复生成

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

8757

6

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

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

2023.07.05

5962

9

java自学难吗
java自学难吗

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

2023.07.31

5372

8

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

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

2023.08.01

964

3

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

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

2023.08.02

808

3

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

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

2023.08.02

1156

5

java有什么用
java有什么用

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

2023.08.02

2309

5

java在线网站
java在线网站

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

2023.08.03

19671

3

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

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

2023.08.03

1055

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习