Java中 ProcessingEnvironment 和 RoundEnvironment 怎么在 APT 中获取注解元素

陌磊酱_1419

陌磊酱_1419

2026-07-17

557人浏览

原创

processingenvironment 是注解处理器全局唯一上下文,在 init() 中由编译器注入,提供 elements、types、filer、messager 等工具;roundenvironment 代表单次处理轮次上下文,在 process() 中传入,用于获取本轮被注解的元素。

java中 processingenvironment 和 roundenvironment 怎么在 apt 中获取注解元素

在 Java 注解处理器(APT)中,ProcessingEnvironment 是注解处理器的“上下文环境”,由编译器注入,用于获取工具类、日志、元素处理等能力;而 RoundEnvironment 则代表当前注解处理轮次的上下文,用于获取本轮中被标注的元素。二者不能直接 new,必须通过标准生命周期方法获得。

ProcessingEnvironment 在 init() 中获取

ProcessingEnvironment 由编译器在调用处理器的 init() 方法时传入,是整个处理器生命周期中唯一且稳定的入口点。它提供关键工具:

  • getElementUtils():获取 Elements 工具,用于操作类型、包、方法等元素
  • getTypeUtils():获取 Types 工具,用于类型比较、泛型解析等
  • Filer:用于生成源文件、class 文件或资源文件
  • Messager:用于输出编译期提示、警告或错误信息

示例:

@Override
public void init(ProcessingEnvironment processingEnv) {
    super.init(processingEnv);
    this.elementUtils = processingEnv.getElementUtils();
    this.typeUtils = processingEnv.getTypeUtils();
    this.filer = processingEnv.getFiler();
    this.messager = processingEnv.getMessager();
}

RoundEnvironment 在 process() 中获取

RoundEnvironment 每次调用 process() 方法时都会传入,代表当前注解处理轮次的状态。它只在本轮有效,不可缓存复用。主要用途是:

  • getRootElements():获取本轮所有被编译器解析出的顶层元素(如类、接口)
  • getElementsAnnotatedWith(Class extends Annotation>):获取被指定注解标记的元素(最常用)
  • processingOver():判断是否为最后一轮(可用于清理或收尾逻辑)

注意:即使没有匹配的注解,process() 仍会被调用至少一次(初始轮),此时 getElementsAnnotatedWith(...) 返回空集合。

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载

示例:

@Override
public boolean process(Set extends TypeElement> annotations, RoundEnvironment roundEnv) {
    for (TypeElement annotation : annotations) {
        Set extends Element> annotatedElements =
            roundEnv.getElementsAnnotatedWith(annotation);
        for (Element element : annotatedElements) {
            // 处理被 @MyAnnotation 标记的类、字段或方法
            if (element instanceof TypeElement) {
                // 解析类
            }
        }
    }
    return true; // 声明已处理,避免其他处理器重复处理该注解
}

二者关系与使用时机

ProcessingEnvironment 是全局、单例、线程安全的(编译器保证),适合初始化工具和缓存引用;RoundEnvironment 是每轮新建、仅当轮次有效,必须在 process() 内使用,不能跨轮保存或传递。

  • 不要在 process() 外保存 RoundEnvironment 引用
  • 不要在 init() 中尝试访问元素或注解——此时 AST 尚未完全构建
  • 若需跨轮累积数据(如收集所有被注解类),应使用成员变量 + 轮次判断(!roundEnv.processingOver())

常见误区提醒

容易混淆的是:ProcessingEnvironment.getElementUtils().getTypeElement("xxx") 可能返回 null,因为该方法只查已加载的类型(如已编译或已处理的类),不支持未编译的引用;而 RoundEnvironment 中的 getElementsAnnotatedWith() 才是获取当前编译单元中实际存在的被注解元素的正确方式。

另外,TypeElement 是 Element 的子类,代表类/接口;获取其字段或方法需用 getEnclosedElements(),再按 ElementKind 过滤,而非直接强转。

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

10577

6

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

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

2023.07.05

7702

9

java自学难吗
java自学难吗

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

2023.07.31

6712

8

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

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

2023.08.01

1144

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

1396

5

java有什么用
java有什么用

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

2023.08.02

2789

5

java在线网站
java在线网站

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

2023.08.03

20091

3

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

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

2023.08.03

1235

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习