如何利用反射的 getAnnotation 接口精准提取类、方法或字段上的注解实例

夏芳酱_8385

夏芳酱_8385

2026-05-27

1014人浏览

原创

精准提取注解需确认其@retention(retentionpolicy.runtime)、通过class/method/field等annotatedelement调用getannotation(),注意私有成员需setaccessible(true),并判空处理属性值。

如何利用反射的 getannotation 接口精准提取类、方法或字段上的注解实例

要精准提取类、方法或字段上的注解实例,关键不是调用 getAnnotation 就完事,而是明确目标注解类型、确认其保留策略(@Retention)、确保运行时可见,并正确选择被注解的元素进行反射访问。

确认注解的 RetentionPolicy 是 RUNTIME

只有声明为 @Retention(RetentionPolicy.RUNTIME) 的注解,才能在运行时通过反射获取。如果注解是 CLASS 或 SOURCE 级别,getAnnotation 会始终返回 null,且无任何异常提示。

  • 检查你使用的注解源码,或文档,确认其保留策略
  • 自定义注解时务必显式加上:@Retention(RetentionPolicy.RUNTIME)
  • 例如 Spring 的 @Component、JUnit 的 @Test 都是 RUNTIME 级别

按目标元素类型调用对应反射 API

不能对任意对象调用 getAnnotation —— 它是 AnnotatedElement 接口的方法,而该接口由 Class、Method、Field、Constructor 等实现。必须先拿到具体元素实例:

  • 类上注解:用 MyClass.class.getAnnotation(MyAnnotation.class)
  • 方法上注解:先获取 Method 对象,如 clazz.getDeclaredMethod("doSomething"),再调用 method.getAnnotation(MyAnnotation.class)
  • 字段上注解:用 clazz.getDeclaredField("name"),再调用 field.getAnnotation(MyAnnotation.class)
  • 注意:私有成员需先调用 setAccessible(true) 才能访问(否则可能抛 IllegalAccessException)

区分 getAnnotation 与 getDeclaredAnnotation(Java 8+)

两者行为不同,容易误用:

  • getAnnotation(Class<a>)</a>:只查当前元素**直接声明**的注解(不查继承来的),且对类而言,**不查父类/接口上的同名注解**
  • getDeclaredAnnotation(Class<a>)</a>:语义更严格,也只查当前元素直接声明的注解;但对类来说,它**不会跨层级查找**,和 getAnnotation 在大多数场景下表现一致
  • 真正影响“是否继承”的是注解自身的 @Inherited 元注解 —— 仅对 Class 级注解生效,且只作用于子类(不适用于方法/字段)
  • 推荐优先使用 getAnnotation,语义清晰;除非明确需要排除间接声明(极少见),否则无需刻意换用 getDeclaredAnnotation

安全提取并处理注解属性值

拿到注解实例后,通常需读取其属性。Java 注解属性本质是接口方法,调用即获得默认值或显式设置的值:

  • 直接调用注解实例的方法,如 myAnn.value()、myAnn.order()
  • 若属性未显式指定,将返回定义时的 default 值(注意:基本类型不能为 null,但引用类型可为 null)
  • 建议加空判断:if (ann != null) { String v = ann.value(); ... },避免 NPE
  • 若需批量处理多个同类型注解(如 @MyAnn 可重复),应改用 getAnnotationsByType(需注解标注 @Repeatable)
PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

8977

6

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

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

2023.07.05

6182

9

java自学难吗
java自学难吗

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

2023.07.31

5552

8

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

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

2023.08.01

1004

3

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

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

2023.08.02

828

3

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

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

2023.08.02

1176

5

java有什么用
java有什么用

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

2023.08.02

2389

5

java在线网站
java在线网站

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

2023.08.03

19711

3

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

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

2023.08.03

1075

8

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.2万人学习