教程:怎么用高阶反射工具(如 Spring的 AnnotationUtils)解决嵌套注解的读取

夏涛姑娘_5982

夏涛姑娘_5982

2026-06-01

828人浏览

原创

java原生getannotation()无法获取嵌套注解,因其只读取直接声明的注解;spring的annotationutils.findannotation支持递归查找嵌套注解,推荐优先使用。

教程:怎么用高阶反射工具(如 spring的 annotationutils)解决嵌套注解的读取

理解嵌套注解为什么不能直接 getAnnotation

Java 原生的 getAnnotation() 只能读取直接声明在目标元素(类、方法、字段等)上的注解,无法穿透到注解内部的属性值——尤其是当该属性本身又是另一个注解类型时。比如你写了 @Validated(groups = MyGroup.class),想拿到 MyGroup.class,这没问题;但若写成 @MyWrapper(@NotNull),想取出里面的 @NotNull,原生 API 就无能为力了,因为 @MyWrapper.value() 返回的是 Annotation 类型,而 JVM 不会自动解析它为具体注解实例。

用 Spring 的 AnnotationUtils 获取嵌套注解

AnnotationUtils 提供了 getAnnotationAttributes 和更实用的 findAnnotation / getAnnotation 重载方法,它们能递归扫描注解链。关键在于:Spring 会把注解属性中声明的注解(即嵌套注解)也当作“可查找目标”,只要传入正确的注解类型和搜索策略。

  • 对单个注解属性是嵌套注解的情况,用 AnnotationUtils.getAnnotation(annotatedElement, wrapperType).value() 拿到原始 Annotation 对象,再用 AnnotationUtils.synthesizeAnnotation(...) 转成可调用的代理实例
  • 更推荐方式:用 AnnotationUtils.findAnnotation(target, nestedAnnotationType),它默认开启深度搜索(包括注解的注解属性),适合大多数场景
  • 如果嵌套多层(如 @A(@B(@C))),需配合 SearchStrategy.TYPE_HIERARCHY 或自定义遍历逻辑,findAnnotation 默认只查一层嵌套,必要时要手动展开

动手写一个安全读取嵌套注解的工具方法

下面是一个通用方法,能从任意被注解的目标上,按类型找到所有嵌套层级中的指定注解:

左脉梦幻师
左脉梦幻师

一款基于AI大模型的创意内容生成工具,可辅助用户进行文字创作、创意构思和多类型内容生产等任务。

下载
public static <a extends annotation> A findNestedAnnotation(AnnotatedElement source, Class</a><a> annotationType) {
    // 先查直接声明的
    A direct = AnnotationUtils.getAnnotation(source, annotationType);
    if (direct != null) return direct;

    // 再查所有注解的属性值(递归)
    Annotation[] allAnnos = source.getAnnotations();
    for (Annotation anno : allAnnos) {
        for (Method attr : anno.annotationType().getDeclaredMethods()) {
            if (attr.getParameterCount() == 0 && Annotation.class.isAssignableFrom(attr.getReturnType())) {
                try {
                    Annotation nested = (Annotation) attr.invoke(anno);
                    if (nested != null && nested.annotationType() == annotationType) {
                        return (A) nested;
                    }
                    // 递归进嵌套注解内部继续找
                    A foundInNested = findNestedAnnotation(nested, annotationType);
                    if (foundInNested != null) return foundInNested;
                } catch (Exception ignored) {}
            }
        }
    }
    return null;
}</a>

这个方法不依赖 Spring,但如果你已在用 Spring,优先用 AnnotationUtils.findAnnotation + 自定义 AnnotationFilter 更简洁可靠。

常见陷阱与绕过技巧

实际使用中容易踩坑:

  • 注解属性必须有默认值:如果嵌套注解作为属性但没设默认值(如 MyAnn value() default @Inner; 缺失),JVM 会抛 AnnotationFormatError,编译期就失败
  • 重复注解不被自动展开:像 @Repeatable 容器注解里的多个同类型嵌套注解,findAnnotation 默认只返回第一个,需改用 getAnnotationsByType 配合手动解析
  • 运行时代理失效:用 synthesizeAnnotation 创建的代理对象,其方法返回值如果是泛型或数组,可能需额外处理(比如用 AnnotationUtils.getValue(anno, "xxx") 替代直接 getter)

遇到复杂结构,建议先用 AnnotationUtils.getAnnotationAttributes 把整个注解转成 Map,再按 key 逐层 inspect,比硬刚反射更稳。

相关文章

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10037

6

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

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

2023.07.05

7182

9

java自学难吗
java自学难吗

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

2023.07.31

6312

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

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.4万人学习