如何在 Java 中通过反射机制获取类定义的 Annotation 注解并读取其配置的元数据

小涛姑娘_4273

小涛姑娘_4273

2026-05-01

645人浏览

原创

Java反射读取注解需注解声明@Retention(RUNTIME),否则运行时不可见;通过getAnnotation()获取单个注解,getDeclaredAnnotations()获取本类注解,getAnnotationsByType()处理可重复注解,并需异常处理与空值判断。

如何在 java 中通过反射机制获取类定义的 annotation 注解并读取其配置的元数据

在 Java 中,可以通过反射机制获取类、方法、字段等元素上定义的注解,并读取其配置的元数据。关键在于使用 getAnnotation(Class) 或 getDeclaredAnnotations() 等反射 API,同时确保注解本身具有合适的 @Retention(RetentionPolicy.RUNTIME),否则运行时无法访问。

确保注解支持运行时保留

只有声明了 @Retention(RetentionPolicy.RUNTIME) 的注解才能在运行时通过反射读取。若缺少该元注解,反射调用会返回 null 或空数组。

  • 正确示例:
  @Target(ElementType.TYPE)
  @Retention(RetentionPolicy.RUNTIME) // 必须
  public @interface MyConfig {
    String value() default "";
    int version() default 1;
  }
  • 错误情况:若只写 @Retention(RetentionPolicy.CLASS) 或未声明,默认为 SOURCE,反射将不可见。

获取类上的注解实例并提取属性值

使用 Class.getAnnotation(Class) 获取指定类型的注解对象,再调用其方法读取元数据。

java-api-doc-generator
java-api-doc-generator

分析 Java Spring Boot 后端 Controller 代码,自动生成 Markdown 格式的接口文档。当用户说“生成 Java 接口文档”、“生成 API 文档”、“从 Spring 代码生成文档”时触发。

下载
  • 示例代码:
  @MyConfig(value = "service-v2", version = 2)
  public class UserService { }

  // 反射读取
  Class> clazz = UserService.class;
  MyConfig anno = clazz.getAnnotation(MyConfig.class);
  if (anno != null) {
    System.out.println(anno.value()); // 输出 "service-v2"
    System.out.println(anno.version()); // 输出 2
  }

批量获取所有注解或处理重复注解

若需检查多个注解,可用 getAnnotations()(含继承)或 getDeclaredAnnotations()(仅本类声明)。对可重复注解(@Repeatable),应使用 getAnnotationsByType()。

  • clazz.getAnnotations():返回所有 @Retention(RUNTIME) 注解(包括父类/接口继承的)
  • clazz.getDeclaredAnnotations():仅返回当前类显式声明的注解,不包含继承的
  • 可重复注解示例:
  @Repeatable(MyConfigs.class)
  @Retention(RetentionPolicy.RUNTIME)
  public @interface MyConfig { ... }

  @MyConfig("A") @MyConfig("B")
  public class Service { }

  // 正确获取多个实例:
  MyConfig[] configs = clazz.getAnnotationsByType(MyConfig.class);

注意访问权限与异常处理

反射操作本身不抛出检查异常,但若类未加载、注解类型不可见或安全策略限制,可能触发 NoClassDefFoundError 或 SecurityException。生产环境建议包裹 try-catch 并做空值判断。

  • 常见防护写法:
  MyConfig anno = null;
  try {
    anno = clazz.getAnnotation(MyConfig.class);
  } catch (Exception e) {
    // 记录日志,避免崩溃
    log.warn("Failed to read @MyConfig on {}", clazz.getName(), e);
  }
  if (anno == null) return defaultValue;

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

11777

6

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

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

2023.07.05

8882

9

java自学难吗
java自学难吗

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

2023.07.31

7612

8

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

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

2023.08.01

1244

3

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

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

2023.08.02

1008

3

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

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

2023.08.02

1496

5

java有什么用
java有什么用

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

2023.08.02

3089

5

java在线网站
java在线网站

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

2023.08.03

20351

3

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

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

2023.08.03

1355

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习