怎么自定义Retention为RUNTIME的注解并在运行时解析

酷芳姑娘_9220

酷芳姑娘_9220

2026-04-11

659人浏览

原创

@retention(retentionpolicy.runtime)是前提,否则注解编译后即丢弃,运行时无法通过反射获取;必须搭配@target指定作用位置,且注解元素需为常量类型、有合法默认值,反射读取时须判空并从实际声明类中获取。

怎么自定义retention为runtime的注解并在运行时解析

为什么 @Retention(RetentionPolicy.RUNTIME) 是前提

没有这个声明,注解在编译后就会被丢弃,运行时连 Class.getAnnotations() 都拿不到。JVM 默认只保留 SOURCE 和 CLASS 级注解,RUNTIME 是唯一能通过反射读取的级别。如果你写了注解但 getDeclaredAnnotations() 返回空数组,先检查这里。

必须搭配 @Target 明确作用位置,否则编译不通过。常见组合是:@Target({ElementType.METHOD, ElementType.TYPE}) —— 否则哪怕加了 RUNTIME,也不能用在类或方法上。

怎么定义一个带参数的 RUNTIME 注解

注解本质是接口,所有元素必须是常量类型(String、Class、enum、基本类型、其他注解,或它们的一维数组)。不能有方法体,不能继承,不能有 default null(null 不是合法默认值)。

示例:

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface LogExecutionTime {
    String value() default "default";
    int thresholdMs() default 100;
    Class extends Throwable> ignoreException() default RuntimeException.class;
}
  • value() 是惯用名,调用时可省略键名:@LogExecutionTime("slow")
  • 数组类型写法是 String[] tags() default {},不能写 default null
  • Class 类型参数必须用 Class> 或具体泛型,不能用原始类型 Class

运行时怎么安全地获取并解析注解

反射读取注解本身很快,但频繁调用 getMethod().getAnnotation() 会有反射开销;更关键的是,注解属性访问可能抛 NullPointerException —— 比如你用 annotation.ignoreException(),而该注解没显式设置,又没设 default,就会崩。

推荐写法:

LogExecutionTime ann = method.getAnnotation(LogExecutionTime.class);
if (ann != null) {
    String label = ann.value(); // 安全:有 default 就不会 NPE
    int threshold = ann.thresholdMs();
    Class> ignoreType = ann.ignoreException(); // 注意:即使 default 是 RuntimeException.class,这里也绝不会为 null
}
  • 永远先判空再取值,getAnnotation() 在找不到时返回 null,不是空数组
  • 不要对注解对象做 toString() 或 equals() 判等,它只是代理对象,行为不可靠
  • 如果需批量处理(如 AOP),建议缓存注解元数据,避免每次执行都反射

常见踩坑:注解生效但解析不到

最典型的情况是——你在子类方法上加了注解,却去父类的 Method 对象上调用 getAnnotation()。Java 反射的 getAnnotation() 不继承,必须从实际声明该注解的类中获取。

例如:

class Parent { void doWork() {} }
class Child extends Parent {
    @LogExecutionTime("child")
    @Override void doWork() {} // 注解在这里
}
  • 错误:Parent.class.getMethod("doWork").getAnnotation(...) → 返回 null
  • 正确:Child.class.getMethod("doWork").getAnnotation(...)
  • 若不确定声明位置,可用 method.getDeclaringClass() 确认
  • 注意:接口默认方法上的注解,要从接口类而非实现类获取

注解解析看似简单,真正难的是边界情况——继承关系、泛型擦除后 Class 参数的类型安全、重复注解(@Repeatable)的遍历顺序、还有模块系统(Java 9+)下 Module.addOpens() 对反射的限制。这些不显式踩一次,很难意识到。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10817

6

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

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

2023.07.05

7942

9

java自学难吗
java自学难吗

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

2023.07.31

6892

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

2849

5

java在线网站
java在线网站

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

2023.08.03

20131

3

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

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

2023.08.03

1255

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.8万人学习