Java 中注解怎么结合 APT 技术在编译期动态生成 Java 代码

大强大大_3097

大强大大_3097

2026-07-22

578人浏览

原创

java注解结合apt可在编译期生成源码,提升性能与类型安全;核心步骤为定义source保留级注解、编写继承abstractprocessor的处理器、注册并触发编译生成。

java 中注解怎么结合 apt 技术在编译期动态生成 java 代码

Java 注解结合 APT(Annotation Processing Tool)可以在编译期自动生成 Java 源码,无需运行时反射,提升性能与类型安全。核心在于:定义注解 → 编写注解处理器 → 注册处理器 → 编译时触发生成。

定义可被处理的注解

注解必须声明 @Retention(RetentionPolicy.SOURCE)(仅保留到源码阶段)和 @Target(如 ElementType.TYPE 或 ElementType.FIELD),确保它不会进入字节码,只供 APT 使用。

例如:

@Target(ElementType.TYPE)
@Retention(RetentionPolicy.SOURCE)
public @interface GenerateService {
    String value() default "";
}

编写 AnnotationProcessor 实现类

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

Java Maven Code Review
Java Maven Code Review

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

下载
  • 通过 RoundEnvironment 获取所有被该注解标记的 Element(如类、字段)
  • 使用 Filer 创建新的 .java 源文件(注意包名与路径需严格匹配)
  • 借助 JavaFileObject 的 Writer 写入内容,或更推荐使用 JavaPoet 等库构造结构化代码

示例片段(简化):

@Override
public boolean process(Set extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (Element element : roundEnv.getElementsAnnotatedWith(GenerateService.class)) {
        if (element.getKind() == ElementKind.CLASS) {
            String className = element.getSimpleName().toString();
            String packageName = elements.getPackageOf(element).getQualifiedName().toString();
            try {
                JavaFileObject file = filer.createSourceFile(packageName + ".Generated" + className);
                try (Writer writer = file.openWriter()) {
                    writer.write("package " + packageName + ";\npublic class Generated" + className + " { }");
                }
            } catch (IOException e) {
                messager.printMessage(Diagnostic.Kind.ERROR, "Failed to generate: " + e);
            }
        }
    }
    return true;
}

注册处理器并参与编译

APT 处理器需在 META-INF/services/javax.annotation.processing.Processor 中声明全限定类名,否则 javac 不会加载它。

  • Maven 项目中,将处理器模块打包为 jar,并确保其 resources/META-INF/services/... 路径存在正确配置
  • 主项目依赖该处理器 jar 时,需用 provided 或 compileOnly 范围(Gradle),避免运行时引入
  • 启用注解处理:Maven 默认开启;Gradle 需确认 annotationProcessor 配置已添加

配合 JavaPoet 提升生成质量

手写字符串拼接易出错、难维护。JavaPoet 是 Google 推出的代码生成库,支持类型安全地构建类、方法、注解等。

  • 用 TypeSpec 构建类,MethodSpec 构建方法,自动处理缩进、分号、导入语句
  • 通过 ClassName.get() 引用已有类型,避免硬编码类名,增强重构友好性
  • 生成结果直接交由 Filer 输出,保持与 APT 生命周期一致

例如生成一个带构造函数的类:

TypeSpec serviceClass = TypeSpec.classBuilder("Generated" + className)
    .addModifiers(Modifier.PUBLIC)
    .addMethod(MethodSpec.constructorBuilder()
        .addParameter(String.class, "name")
        .addStatement("this.name = name")
        .build())
    .addField(String.class, "name", Modifier.PRIVATE)
    .build();

JavaFile javaFile = JavaFile.builder(packageName, serviceClass).build();
javaFile.writeTo(filer);

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

相关文章

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

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

下载

相关标签:

mysql java开发 java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Swoft2.x速学之http api篇课程
Swoft2.x速学之http api篇课程

共16课时 | 1.5万人学习

Django DRF 源码解析
Django DRF 源码解析

共21课时 | 2万人学习

Golang进阶实战编程
Golang进阶实战编程

共34课时 | 3.9万人学习