怎么通过反射读取类、方法及字段上的自定义注解元数据信息

轻墨大大_1475

轻墨大大_1475

2026-04-16

214人浏览

原创

获取class对象是反射读取注解的第一步,常用方式有obj.getclass()、myclass.class和class.forname(),三者行为不完全等价;需用isannotationpresent()判断存在性,getannotation()获取实例;遍历成员须用getdeclaredxxx()并配合setaccessible(true);@target和@retention配置错误会导致注解不可见。

怎么通过反射读取类、方法及字段上的自定义注解元数据信息

获取 Class 对象是反射读取注解的第一步

没有 Class 对象,后续所有反射操作都无从谈起。Java 提供三种常用方式,但它们行为不完全等价:

  • obj.getClass():适用于已有实例的场景,返回运行时实际类型(可能为子类)
  • MyClass.class:最常用、最安全,编译期确定,不会触发类初始化
  • Class.forName("com.example.MyClass"):需传入完整类名字符串,会触发类的静态初始化,若类不存在或初始化失败会抛 ClassNotFoundException 或 ExceptionInInitializerError

读取注解前务必确认你拿到的是目标类的 Class 对象,而不是其父类或代理类。

用 getAnnotation() 和 isAnnotationPresent() 判断并提取注解

这两个方法是读取注解的核心入口,但用途和性能有明显差异:

  • isAnnotationPresent(MyAnnotation.class):只做存在性检查,开销极小,适合做条件分支(比如“如果有 @LogExecutionTime 就记录耗时”)
  • getAnnotation(MyAnnotation.class):返回注解实例,可调用其方法获取属性值;如果注解不存在,返回 null,不是异常
  • 注意:getAnnotation() 只能读取 @Retention(RetentionPolicy.RUNTIME) 的注解;CLASS 或 SOURCE 级注解在运行时已不可见

示例:

Class> clazz = UserService.class;
if (clazz.isAnnotationPresent(Service.class)) {
    Service service = clazz.getAnnotation(Service.class);
    System.out.println("Bean name: " + service.value());
}

遍历方法和字段时,别漏掉 getDeclaredXXX() 和 setAccessible()

默认的 getMethod() / getField() 只返回 public 成员,且无法访问私有注解目标。要完整扫描,必须用 getDeclaredMethod() 和 getDeclaredField():

  • getDeclaredMethods() 返回本类声明的所有方法(含 private),但不含继承的方法
  • getDeclaredFields() 同理,返回本类所有字段,包括 private、protected
  • 若目标字段/方法是 private,调用 setAccessible(true) 才能绕过 Java 访问控制 —— 否则读取注解本身不会报错,但后续尝试读取字段值或调用方法时会抛 IllegalAccessException

常见错误:写了 clazz.getMethods() 却发现自定义注解没被识别,其实是注解贴在 private 方法上,而 getMethods() 根本没返回它。

@Target 和 @Retention 不匹配会导致注解“消失”

这是最隐蔽也最容易忽略的问题。即使代码里明明白白写了 @MyAnnotation,反射也读不到,大概率是元注解配置错了:

  • 如果注解定义时用了 @Target(ElementType.METHOD),却把它贴在类上,编译器会报错,根本过不了编译
  • 如果用了 @Retention(RetentionPolicy.CLASS),那在 JVM 运行时 getAnnotation() 一定返回 null,因为字节码里虽然保留了,但运行时 Class 对象不加载这部分信息
  • 还有一种情况:注解本身没问题,但你用的类加载器不是定义注解的那个(比如 OSGi 或某些热部署环境),MyAnnotation.class 在反射时和目标类看到的不是同一个 Class 实例,导致 isAnnotationPresent() 返回 false

验证方式很简单:在注解定义处确认 @Target 是否覆盖你的使用位置,且 @Retention 必须是 RUNTIME —— 其他两个策略对反射无效。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10857

6

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

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

2023.07.05

7982

9

java自学难吗
java自学难吗

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

2023.07.31

6932

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

2869

5

java在线网站
java在线网站

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

2023.08.03

20151

3

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

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

2023.08.03

1255

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.8万人学习