如何编写可重复注解必需的“容器注解”以通过编译器的严格检查

千明酱_8079

千明酱_8079

2026-06-02

966人浏览

原创

要让自定义注解支持重复使用,必须定义符合三条件的容器注解并用@repeatable声明:①为@interface;②含value()元素,类型为目标注解数组;③无非默认元素。

如何编写可重复注解必需的“容器注解”以通过编译器的严格检查

要让自定义注解支持重复使用(即在同一个元素上多次声明),必须定义一个“容器注解”(Container Annotation),并配合 @Repeatable 元素正确声明。否则编译器会报错:“Duplicate annotation”,且无法通过严格的注解处理检查(如 Java 8+ 的类型检查或 APT 工具)。

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

容器注解不是任意写的,它需严格遵循以下规则:

  • 必须是一个注解类型(用 @interface 声明);
  • 必须声明一个名为 value 的元素,其类型为「目标重复注解」的数组(例如 MyAnno[] value() default {};);
  • 不能有其他非默认元素(即所有额外元素都必须提供默认值,否则编译失败;但最佳实践是只保留 value)。

重复注解与容器注解的配对写法

以自定义注解 @Role 为例,使其可重复使用:

@Repeatable(Roles.class)
public @interface Role {
  String value() default "";
}

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface Roles {
  Role[] value() default {};
}

注意:@Repeatable 的参数必须是容器注解的 Class 对象(Roles.class),且容器注解本身必须有运行时保留策略(@Retention(RUNTIME))才能被反射读取。

Suna
Suna

一款AI工具,主要用于全球首个开源的通用型AI Agent项目,适合需要提升相关任务效率的用户。

下载

编译器检查失败的常见原因

即使写了容器注解,仍可能因以下细节被编译器拒绝:

  • 容器注解缺少 @Retention 或 @Target,导致元注解不完整;
  • @Repeatable 指向的容器类型与实际声明不一致(大小写、包名错误);
  • 容器中 value() 的返回类型不是「目标注解」的数组(例如写成 List<role></role> 或 Role 单个实例);
  • 目标重复注解未标注 @Repeatable,或标注了但容器不存在/不可见(如包私有、拼写错误)。

验证是否通过编译器严格检查的简单方法

写一个测试类,尝试在同一方法上重复使用该注解:

public class Test {
  @Role("ADMIN")
  @Role("USER")
  void doSomething() {}
}

若编译通过,且 doSomething().getAnnotationsByType(Role.class) 返回长度为 2 的数组,则说明容器注解已正确通过编译器和运行时检查。

相关专题

更多
java
java

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

2023.06.15

10257

6

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

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

2023.07.05

7402

9

java自学难吗
java自学难吗

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

2023.07.31

6492

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

2709

5

java在线网站
java在线网站

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

2023.08.03

20011

3

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

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

2023.08.03

1195

8

热门下载

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

精品课程

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

共6课时 | 54.6万人学习

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

共89课时 | 133.4万人学习