如何自定义注解并通过反射在运行时获取注解的元数据

夜雪小哥_3021

夜雪小哥_3021

2026-04-07

232人浏览

原创

Java定义可反射读取的自定义注解必须加@Retention(RetentionPolicy.RUNTIME),否则getAnnotation()返回null;读取时应使用getMethod()而非getDeclaredMethod(),并判空避免NPE。

如何自定义注解并通过反射在运行时获取注解的元数据

Java 里怎么定义一个可被反射读取的自定义注解

必须用 @Retention(RetentionPolicy.RUNTIME),否则反射时拿不到。缺了这句,getAnnotation() 永远返回 null。

常见错误是只加了 @Target 就以为够了,结果运行时死活读不到值。

  • @Target(ElementType.METHOD) 或 ElementType.TYPE 等,标明能用在哪种元素上
  • @Retention(RetentionPolicy.RUNTIME) 是硬性要求,没它就白写
  • 推荐加上 @Documented(方便 Javadoc 生成)和 @Inherited(仅对类注解生效,子类是否继承)

示例:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface LogExecutionTime {
    String value() default "";
    boolean showArgs() default false;
}

怎么用反射读取方法上的注解值

别直接调 method.getAnnotation(LogExecutionTime.class) 就完事——得先确认方法确实被标注了,否则 NPE 风险高。

更关键的是:如果目标方法在父类或接口中,而你只查当前类的声明方法(getDeclaredMethod),会漏掉继承来的注解。

  • 用 getMethod() 而非 getDeclaredMethod(),才能跨类层次查找
  • 拿到注解对象后,再调 annotation.value()、annotation.showArgs() 读具体字段
  • 注意:注解字段不能为 null,未设默认值又没显式赋值会编译报错

示例(安全读取):

Method method = target.getClass().getMethod("doWork");
LogExecutionTime annotation = method.getAnnotation(LogExecutionTime.class);
if (annotation != null) {
    System.out.println(annotation.value());
    System.out.println(annotation.showArgs());
}

为什么 getAnnotations() 返回空数组但 getAnnotation() 能拿到

这是初学者高频困惑点:getAnnotations() 返回所有「显式声明」的注解(不含继承),而 getAnnotation(Class) 内部做了继承查找(对类有效,对方法/字段无效)。

重点:方法上的注解不支持继承(@Inherited 对 METHOD 无效),所以 getAnnotations() 查父类方法注解一定为空。

  • 若想批量检查多个注解,仍需逐个调 getAnnotation(X.class)
  • 类上注解可用 getAnnotations() 批量获取,但前提是它们都在当前类声明,不是从父类继承来的
  • 没有“通用版 getInheritedAnnotations()”API,要模拟继承需手动遍历 getSuperclass() 和 getInterfaces()

Spring AOP 里用自定义注解时为啥反射读不到

因为 Spring AOP 默认代理目标对象,实际执行的是代理对象的方法——你反射查的是原始类,但运行时调用的是代理类(比如 $Proxy23),而代理类上没保留原注解。

这不是反射失效,是对象错了。解决方案只有两个:要么换 CGLIB 代理(需关闭接口代理),要么改用 Spring 的 Advised 接口提取目标对象再反射。

  • 开启 CGLIB:@EnableAspectJAutoProxy(proxyTargetClass = true)
  • 或运行时通过 AopContext.currentProxy() 获取代理对象,再用 targetSource.getTarget() 拿到真实对象
  • 更稳妥的做法:在切面里用 JoinPoint.getSignature() 获取 MethodSignature,再调 getMethod() 反射读注解——这个 Method 是原始方法,注解还在

绕开代理问题最轻量的方式就是别在代理对象上反射,而是从 JoinPoint 入手。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

11897

6

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

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

2023.07.05

8982

9

java自学难吗
java自学难吗

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

2023.07.31

7692

8

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

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

2023.08.01

1264

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

1516

5

java有什么用
java有什么用

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

2023.08.02

3109

5

java在线网站
java在线网站

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

2023.08.03

20371

3

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

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

2023.08.03

1355

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 134.1万人学习