Java元注解进阶:设计符合JSR标准的自定义注解

胖墨小哥_2172

胖墨小哥_2172

2026-06-10

456人浏览

原创

符合jsr标准的自定义注解关键在于元注解组合的行为合规:需根据读取主体(编译器/apt/运行时框架)、时机(source/class/runtime)和用途(校验/生成代码/反射)精准选择@retention、@target等元注解,并满足jsr-303等规范的扩展要求。

java元注解进阶:设计符合jsr标准的自定义注解

设计符合JSR标准的自定义注解,关键不在“写得像”,而在“行为合规”——即元注解组合必须严格匹配目标使用场景的生命周期、作用域和语义契约。比如,若注解需被框架在运行时通过反射读取(如Spring AOP或MyBatis拦截),@Retention(RetentionPolicy.RUNTIME)就是硬性前提;若仅用于编译检查(如自定义@NonNull),则应选SOURCE。

明确注解用途,反推元注解组合

先问自己三个问题:这个注解谁来读?什么时候读?读完干什么?答案直接决定元注解选型:

  • 由编译器读取并报错/警告 → 用 @Retention(RetentionPolicy.SOURCE) + @Target 限定语法位置(如METHOD、PARAMETER)
  • 由构建工具(如APT处理器)在编译期生成代码 → 必须 @Retention(RetentionPolicy.CLASS) 或 SOURCE,并搭配 @Target 和可选 @Repeatable
  • 由运行时框架(如Spring、Hibernate)通过反射解析 → 必须 @Retention(RetentionPolicy.RUNTIME),且 @Target 要覆盖实际使用位置(如TYPE+METHOD+FIELD)

@Target 必须精准,避免过度宽泛

ElementType枚举不是“多选就安全”,而是要最小化授权。例如定义一个用于字段校验的注解:

java-enterprise
java-enterprise

Java企业开发专家,专注于Spring Boot、微服务架构和JVM优化。适用于:Java语言掌握、

下载
  • ❌ @Target(ElementType.TYPE) —— 允许加在类上,但校验逻辑无法处理类级语义
  • ✅ @Target({ElementType.FIELD, ElementType.PARAMETER}) —— 精确匹配字段注入和方法参数两种主流校验入口
  • ⚠️ 若需支持局部变量(如Lambda内),需显式添加 ElementType.LOCAL_VARIABLE,但JVM规范不保证所有环境都支持反射获取局部变量注解

@Retention 与 @Inherited/@Documented 的协同约束

这三个元注解存在隐含依赖关系:

  • @Inherited 仅对 @Retention(RetentionPolicy.RUNTIME) 且 @Target(ElementType.TYPE) 的类级注解生效;它对方法、字段注解完全无效
  • @Documented 只有在 @Retention 为 SOURCE 或 RUNTIME 时才有意义;若设为 CLASS 且未文档化,JavaDoc 工具将跳过该注解
  • JSR-269(编译时注解处理)要求注解至少保留到 CLASS 阶段,否则APT处理器无法扫描到

兼容JSR-303/JSR-380校验规范的特别注意点

若注解用于Bean Validation(如@NotBlank、@Size),除基础元注解外,还需满足JSR标准扩展要求:

  • 必须声明 @Constraint(validatedBy = ...)(这是JSR-303定义的元注解,非Java内置)
  • 注解接口中必须包含 message()、groups()、payload() 三个标准方法,且返回类型固定
  • @Target 至少包含 ElementType.FIELD 和 ElementType.METHOD(支持属性和getter校验)
  • @Retention 必须为 RUNTIME,因为校验器在运行时执行

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java js

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

相关专题

更多
java
java

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

2023.06.15

10237

6

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

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

2023.07.05

7362

9

java自学难吗
java自学难吗

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

2023.07.31

6472

8

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

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

2023.08.01

1124

3

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

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

2023.08.02

928

3

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

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

2023.08.02

1356

5

java有什么用
java有什么用

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

2023.08.02

2689

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
CLion CMake 快速入门教程
CLion CMake 快速入门教程

共0课时 | 0人学习

CMake 构建系统手册
CMake 构建系统手册

共0课时 | 0人学习