如何用 @Retention 决定你的自定义注解应该存活到哪一个生命周期

胖宇小哥_5120

胖宇小哥_5120

2026-05-28

863人浏览

原创

@retention是java中控制注解生命周期的关键元注解,决定注解在source(仅源码)、class(默认,class文件中但运行时不可见)、runtime(运行时可通过反射获取)三个阶段的保留策略,直接影响注解能否被编译器检查、字节码工具处理或反射读取。

如何用 @retention 决定你的自定义注解应该存活到哪一个生命周期

@Retention 是 Java 中用来指定自定义注解保留策略的关键元注解。它直接决定了你的注解在编译、类加载或运行时是否还“存在”,从而影响你能否通过反射读取、是否被编译器检查、甚至是否被打包进 class 文件里。

了解三种 RetentionPolicy 值的含义

Java 提供了三个枚举值,对应注解的三个生命周期阶段:

  • RetentionPolicy.SOURCE:注解只保留在源代码中,编译时就被丢弃,不会写入 .class 文件。适合用于编译期检查(如 @Override),或生成文档(如某些自定义文档标记)。
  • RetentionPolicy.CLASS:注解会写入 .class 文件,但 JVM 加载类时不会将其加载到内存,反射无法获取。这是默认策略(如果你没写 @Retention,默认就是这个)。适用于某些字节码处理工具(如 ASM、lombok 的部分实现)。
  • RetentionPolicy.RUNTIME:注解会写入 .class,并在运行时由 JVM 加载,可通过反射(如 getAnnotation())读取。这是最常用也最灵活的选择,适用于 AOP、序列化框架(如 Jackson)、测试框架(如 JUnit5 的 @Test)、DI 容器(如 Spring 的 @Autowired)等场景。

怎么选?关键看“谁需要读它”

决定用哪个策略,核心是问自己一个问题:哪个环节需要用到这个注解的信息?

  • 如果是给 IDE 或 javac 插件用(比如提示错误、自动补全),选 SOURCE;
  • 如果是给构建时的字节码增强工具用(比如修改方法逻辑、加日志),选 CLASS;
  • 如果是给运行中的程序逻辑用(比如根据注解动态调用方法、注入对象、校验参数),必须选 RUNTIME。

选高了(比如该用 SOURCE 却用了 RUNTIME)不会报错,但会增大 class 文件体积,且可能暴露不该在运行时可见的元数据;选低了(比如该用 RUNTIME 却用了 CLASS),反射就读不到,功能直接失效。

一个典型例子:自定义权限注解

假设你写了个 @RequiresRole("ADMIN") 注解,想在 Spring MVC 控制器方法上使用,并在请求进来时做权限拦截:

  • 拦截逻辑在运行时执行 → 需要反射读取该注解 → 必须声明为 @Retention(RetentionPolicy.RUNTIME);
  • 如果只在编译期做静态检查(比如发现某 Controller 方法有此注解但没配角色表就报错),那 SOURCE 就够了;
  • 如果用字节码插桩方式在方法入口自动插入校验逻辑(不依赖 Spring 拦截器),那 CLASS 可能更合适,还能避免反射开销。

别忘了搭配 @Target 使用

@Retention 控制“活多久”,@Target 控制“能标在哪”。两者常一起出现:

@Target(ElementType.METHOD)<br>@Retention(RetentionPolicy.RUNTIME)<br>public @interface RequiresRole {<br>    String value();<br>}

没有 @Target,注解可以随意标注在类、方法、字段甚至其他注解上,容易误用;没有 @Retention,就只能靠默认的 CLASS 策略,很可能不满足运行时需求。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

10697

6

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

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

2023.07.05

7822

9

java自学难吗
java自学难吗

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

2023.07.31

6792

8

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

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

2023.08.01

1144

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

1396

5

java有什么用
java有什么用

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

2023.08.02

2809

5

java在线网站
java在线网站

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

2023.08.03

20111

3

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

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

2023.08.03

1235

8

热门下载

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

精品课程

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

共6课时 | 54.7万人学习

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

共89课时 | 133.7万人学习