Java 变量怎么在注解处理器(Annotation Processor)中生成元数据变量

落瑶同学_9218

落瑶同学_9218

2026-08-28

201人浏览

原创

注解处理器在编译期通过element和typemirror提取java变量元数据,不操作运行时值;需过滤field元素、调用variableelement方法获取名称类型等,并用filer生成json或java文件。

java 变量怎么在注解处理器(annotation processor)中生成元数据变量

Java 变量本身不能直接“在注解处理器中生成”,但变量的元数据(如名称、类型、修饰符、所属类、是否被特定注解标记等)可以在注解处理器中被提取、分析,并用于生成新的元数据文件(如 spring-configuration-metadata.json)或辅助代码(如 Builder 类、DTO 映射类等)。

关键在于:注解处理器运行在编译期,它不操作运行时变量值,而是通过 Java 编译器提供的 javax.annotation.processing 和 com.sun.source.tree 等 API,扫描源码中的元素(包括字段/变量),读取其结构信息和关联注解,再据此生成新文件或类。


注解处理器如何获取并处理 Java 变量的元数据

你需要在处理器中:

  • 使用 RoundEnvironment 获取所有被目标注解标记的元素;
  • 过滤出 ElementKind.FIELD 类型的元素(即类中的成员变量);
  • 调用 VariableElement 接口方法提取变量信息;
  • 结合 Types、Elements 工具类解析类型、包名、默认值等;
  • 最终写入 JSON 文件或生成 .java 源文件。

例如,处理一个带 @ConfigurationProperties 的配置类:

@ConfigurationProperties(prefix = "app")
public class AppProperties {
    private String name;
    private int version;
}

注解处理器会识别 AppProperties 类,遍历其所有 FIELD 元素,提取:

OpenJDK 24
OpenJDK 24

OpenJDK 24 Windows x64 官方参考实现(24+36),适合 Windows 环境进行 Java 开发、编译、运行和版本兼容性验证。

下载
  • 字段名:name, version
  • 类型:String, int
  • 所属类:AppProperties
  • 是否有 @NotNull、@DefaultValue 等扩展注解

然后生成元数据片段:

{
  "name": "app.name",
  "type": "java.lang.String",
  "description": "",
  "sourceType": "com.example.AppProperties"
}

实现步骤简明清单

  • 声明支持的注解
    在 process() 方法开头,用 getSupportedAnnotationTypes() 声明要监听的注解(如 "org.springframework.boot.context.properties.ConfigurationProperties")。

  • 遍历被注解的类型元素

    for (Element element : roundEnv.getElementsAnnotatedWith(ConfigurationProperties.class)) {
        if (element.getKind() == ElementKind.CLASS) {
            TypeElement typeElement = (TypeElement) element;
            // 遍历该类所有字段
            for (Element enclosed : typeElement.getEnclosedElements()) {
                if (enclosed.getKind() == ElementKind.FIELD) {
                    VariableElement field = (VariableElement) enclosed;
                    String fieldName = field.getSimpleName().toString();
                    TypeMirror fieldType = field.asType();
                    // 获取类型全限定名:types.erasure(fieldType).toString()
                    // 获取是否为 final / static:field.getModifiers()
                }
            }
        }
    }
  • 使用工具类增强解析能力

    • Types:解析泛型、原始类型、数组等
    • Elements:获取包名、类名、Javadoc 注释
    • Messager:输出编译期提示或错误
  • 生成元数据文件(如 JSON)
    使用 Filer 创建资源文件(非 .java):

    FileObject resource = filer.createResource(
        StandardLocation.CLASS_OUTPUT,
        "",
        "META-INF/spring-configuration-metadata.json"
    );
    try (Writer writer = resource.openWriter()) {
        writer.write(jsonContent); // 手动拼或用 Jackson/Gson 序列化
    }

注意事项

  • 注解必须声明为 @Retention(RetentionPolicy.SOURCE) 或 CLASS,才能被注解处理器读到(RUNTIME 注解也可,但非必需);
  • 不要依赖反射(Class>),因为源码尚未编译成 class,只能用 Element 和 TypeMirror;
  • 字段默认值(如 private String env = "dev";)无法直接从 VariableElement 获取,需借助 TreePath + JavacTrees(较复杂,通常只处理 @DefaultValue("xxx") 这类显式注解);
  • Spring Boot 的 spring-boot-configuration-processor 就是典型实现,它扫描 @ConfigurationProperties 并生成 spring-configuration-metadata.json,供 IDE 提示和配置校验使用。

不复杂但容易忽略。

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

相关专题

更多
java
java

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

2023.06.15

10817

6

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

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

2023.07.05

7942

9

java自学难吗
java自学难吗

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

2023.07.31

6892

8

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

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

2023.08.01

1164

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1416

5

java有什么用
java有什么用

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

2023.08.02

2849

5

java在线网站
java在线网站

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

2023.08.03

20131

3

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

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

2023.08.03

1255

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习