Java重复注解架构模式:设计@Repeatable容器

酷杰吖_3522

酷杰吖_3522

2026-06-15

1042人浏览

原创

java 8 的 @repeatable 注解需配合容器注解才能生效,因其底层仍遵循单值映射设计,编译器将多个同类型注解自动收拢至容器的 value 数组中;容器必须命名规范、含 permission[] value() 成员、不可标 @repeatable 且 retention 至少为 class。

java重复注解架构模式:设计@repeatable容器

Java 8 引入了 @Repeatable 注解,让同一个注解可以在同一位置多次使用。但要真正生效,必须配合一个“容器注解”(Container Annotation)——它不是可选的装饰,而是编译器识别重复注解的必要结构。

为什么需要容器注解?

Java 的注解系统底层仍遵循“单值映射”设计:每个注解类型在目标元素上最多存在一个实例。@Repeatable 本质是语法糖,编译器会把多个同类型注解自动“收拢”进容器注解的 value 数组中。没有容器,重复声明会被编译器拒绝或静默忽略。

容器注解必须满足三个硬性条件:

  • 名称通常为原注解名 + “s” 或 “Container”(如 @Roles 对应 @Role)
  • 必须声明一个名为 value() 的数组类型成员,元素类型为被标记为 @Repeatable 的注解类
  • 自身不能标注 @Repeatable,且必须保留 RetentionPolicy.SOURCE 或 CLASS(运行时需反射读取时建议用 RUNTIME)

标准写法:两步定义缺一不可

以权限校验场景为例,定义可重复的 @Permission:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Permissions.class) // 指向容器
public @interface Permission {
    String value() default "";
    String action() default "read";
}

对应容器注解:

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Permissions {
    Permission[] value(); // 唯一且必需的成员,名称固定为 value,类型为原注解数组
}

之后就能在方法上这样使用:

js2java
js2java

JavaScript 到 Java 全栈翻译助手,专为前端开发者学习 Java 或快速实现后端业务逻辑而设计。当用户提到以下场景时必须使用此技能: - "帮我把这段 JS 代码转成 Java" - "用 Java 怎么写这个逻辑" - "我习惯用 JS 写,想翻译成 Java" - "教我 Java,我要写后端接...

下载
@Permission("user")
@Permission(value = "admin", action = "delete")
public void updateUser() { ... }

运行时通过 method.getAnnotation(Permissions.class) 获取全部实例,而非逐个调用 getAnnotation(Permission.class)(后者只返回第一个)。

常见陷阱与避坑建议

实际开发中容易踩的坑集中在命名、类型和元注解配置上:

  • 容器名不匹配:若容器类名不是编译器预期形式(如误写为 @PermissionList),即使结构正确,@Repeatable 也不会生效
  • value 成员缺失或类型错误:比如写成 Permission value();(非数组)或 String[] value();,编译直接报错
  • 容器注解的 Retention 不足:如果容器用了 @Retention(SOURCE),而代码在运行时通过反射读取,将始终得到 null
  • 重复注解未被容器包裹:JDK 9+ 支持直接读取重复注解(getAnnotationsByType),但旧版反射 API 仍依赖容器,兼容性要考虑

运行时如何安全获取所有实例?

推荐统一使用 getAnnotationsByType(JDK 8+),它自动处理重复逻辑,无需关心容器:

Permission[] perms = method.getAnnotationsByType(Permission.class);
// 直接拿到全部 @Permission 实例,无论是否显式声明容器

如果需兼容 JDK 7 或明确依赖容器结构,才手动查容器:

Permissions container = method.getAnnotation(Permissions.class);
if (container != null) {
    Permission[] perms = container.value();
}

注意:getAnnotation(Permission.class) 永远只返回第一个,切勿用于重复场景。

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

相关文章

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

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

下载

相关标签:

java

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

相关专题

更多
java
java

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

2023.06.15

10677

6

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

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

2023.07.05

7802

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

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习