0

0

Java中的自定义注解生命周期怎么选_RetentionPolicy三态分析

P粉602998670

P粉602998670

发布时间:2026-03-10 11:21:11

|

890人浏览过

|

来源于php中文网

原创

应根据注解读取时机选择:source用于编译期处理(如lombok)、class用于字节码工具(如asm)或构建期aop、runtime仅限运行时反射必需场景(如spring组件扫描),错误选择会导致注解不可见或性能损耗。

java中的自定义注解生命周期怎么选_retentionpolicy三态分析

注解该用 RetentionPolicy.SOURCE 还是 CLASS

看它要不要参与编译后处理。比如 @Override 只在编译期校验,用 SOURCE 就够了;但如果你写了个注解要被字节码工具(如 ASM、Byte Buddy)读取,就必须选 CLASS —— JVM 加载时它还在 class 文件里,但运行期反射拿不到。

常见错误:以为“不运行就不用 RUNTIME”,结果用了 CLASS,却在测试里用 Class.getDeclaredAnnotations() 去查,返回空数组——因为 CLASS 注解不会进运行时元数据。

  • SOURCE:仅保留在源码阶段,javac 处理完就丢,IDE 提示、lombok 的 @Data(默认)走这条路
  • CLASS:写进 .class 文件,但 JVM 不加载进内存,适合 javap 查看或构建期 AOP
  • RUNTIME:加载进 JVM,能被 getDeclaredAnnotations() 拿到,Spring 的 @Component 必须选它

为什么 @Retention(RetentionPolicy.RUNTIME) 不能乱加?

每个 RUNTIME 注解都会让 JVM 在类加载时解析并保留其结构,哪怕你从没调用过反射。类越多、注解越复杂(尤其带数组或嵌套注解),启动耗时和内存占用就越明显。

典型场景踩坑:给 DTO 字段加了一堆自定义校验注解(如 @NotBlank),全设成 RUNTIME,结果单元测试跑得慢、Mockito mock 失败(因反射初始化失败)。

立即学习Java免费学习笔记(深入)”;

MemFree
MemFree

MemFree - 来自知识库和互联网的混合AI搜索,更快获取准确答案

下载
  • 只对真正需要运行时动态行为的注解开 RUNTIME,比如框架集成点、条件判断依据
  • 字段级校验注解如果只配合 Hibernate Validator 用,它内部通过字节码或编译期插件读取,CLASS 足够
  • 检查是否真被反射调用:grep 项目代码里有没有 getAnnotation(YourAnno.class) 或类似逻辑

RetentionPolicy 和注解处理器(APT)的关系

APT 只能看到 SOURCE 和部分 CLASS 注解——因为它工作在 javac 编译中间阶段,还没生成最终 class。所以如果你写了个注解处理器,却把注解设成 RUNTIME,处理器反而收不到它。

错误现象:自定义注解加了 @Retention(RetentionPolicy.RUNTIME),APT 的 process() 方法里遍历 roundEnv.getElementsAnnotatedWith(YourAnno.class) 总是空。

  • APT 必须配 SOURCE(最常用)或显式声明支持 CLASS(需重写 getSupportedSourceVersion() 并确保编译器版本匹配)
  • 别指望用 RUNTIME 让 APT 工作——它根本等不到运行时
  • Android 开发中注意:kapt 默认只处理 SOURCECLASS 需额外配置 kapt.includeCompileClasspath = true

Spring Boot 里自定义注解常被忽略的生命周期陷阱

很多人照着 @Controller 写个新注解,直接抄 @Retention(RetentionPolicy.RUNTIME),结果发现 Spring 扫描不到。问题不在生命周期,而在 @Target 和 Spring 的 component-scan 规则。

但生命周期确实会放大问题:比如你写了 @MyService 并设为 CLASS,Spring 的 ClassPathBeanDefinitionScanner 默认只扫描 RUNTIME 级注解,它压根不进扫描逻辑——连“找不到”的日志都不会打。

  • Spring 的组件扫描(@ComponentScan)和自动配置(@EnableAutoConfiguration)都依赖 RUNTIME 注解
  • 若想用 CLASS 实现轻量级标记,得自己写 BeanDefinitionRegistryPostProcessor,从字节码层面解析
  • 测试时容易漏掉:用 @ContextConfiguration 加载配置类,但忘了该类上自定义注解没被识别——先确认它是 RUNTIME,再查是否被 @ComponentScan 覆盖到包路径

真正难的不是三选一,而是得同时想清楚:谁在什么时候、以什么方式读这个注解。漏掉任一环节,RetentionPolicy 就成了黑盒开关。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

154

2025.08.06

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

88

2026.01.26

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

139

2023.09.05

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

408

2023.10.12

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

73

2025.08.19

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

146

2025.12.22

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

271

2025.12.24

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

32

2026.02.11

Kotlin Android模块化架构与组件化开发实践
Kotlin Android模块化架构与组件化开发实践

本专题围绕 Kotlin 在 Android 应用开发中的架构实践展开,重点讲解模块化设计与组件化开发的实现思路。内容包括项目模块拆分策略、公共组件封装、依赖管理优化、路由通信机制以及大型项目的工程化管理方法。通过真实项目案例分析,帮助开发者构建结构清晰、易扩展且维护成本低的 Android 应用架构体系,提升团队协作效率与项目迭代速度。

24

2026.03.09

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 4.2万人学习

C# 教程
C# 教程

共94课时 | 11万人学习

Java 教程
Java 教程

共578课时 | 79.3万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号