[Java] 浅析可重复注解(Repeatable Annotation) 是如何实现的

浅析 java 中的可重复注解(Repeatable Annotation)是如何实现的

要点

使用可重复注解时,总是需要定义对应的 containing annotation

假设我们定义了可重复注解 A,而它的 containing annotationCA

  • 如果在类 C 上使用了可重复注解 A (且它的 @RentetionvalueRetentionPolicy.RUNTIME),那么
    1. C.class 中会有 RuntimeVisibleAnnotations 属性
    2. CA 会出现在这个 RuntimeVisibleAnnotations 属性中
    3. CA 中会有若干 A 出现

正文

JDK 8 支持可重复注解(Repeatable Annotation)。在 Java Language Specification 中的 9.6.3. Repeatable Annotation Interfaces 小节 提到

An annotation interface A is repeatable if its declaration is (meta-)annotated with an @Repeatable annotation (§9.6.4.8) whose value element indicates a containing annotation interface of A.

大意是说,一个注解 A 是可重复注解,如果 A 上有 @Repeatable 元注解且 @Repeatablevalue 的值是 A 的一个 containing annotation

例子

使用可重复注解的例子

我写了一个简单的例子,请将以下代码保存为 PrimeNumber.java ⬇️

java 复制代码
import java.lang.annotation.Repeatable;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Sample(value = 2)
@Sample(value = 3)
@Sample(value = 5)
@Sample(value = 7)
public class PrimeNumber {

    public static void main(String[] args) throws NoSuchMethodException {
        // 下面这行的 sample 会是 null
        Sample sample = PrimeNumber.class.getAnnotation(Sample.class);
        System.out.println(sample == null);

        // 下面这行的 samples 中会有 4 个元素
        Sample[] samples = PrimeNumber.class.getAnnotationsByType(Sample.class);
        System.out.println(samples.length);
    }
}

@Retention(RetentionPolicy.RUNTIME)
@Repeatable(Samples.class)
@interface Sample {
    int value();
}

@Retention(RetentionPolicy.RUNTIME)
@interface Samples {
    Sample[] value();
}

这里的 @Sample 注解是可重复注解,而 Samples 是对应的 containing annotation

以下命令可以编译 PrimeNumber.java 并运行其中的 main(...) 方法。

bash 复制代码
javac PrimeNumber.java
java PrimeNumber

运行结果如下 ⬇️

text 复制代码
true
4

在编译之后,我们会得到 PrimeNumber.class 文件,用以下命令可以查看 PrimeNumber.class 的内容 ⬇️

css 复制代码
javap -v -p PrimeNumber

完整的结果有点长,结尾部分的内容如下 ⬇️

text 复制代码
RuntimeVisibleAnnotations:
  0: #51(#52=[@#53(#52=I#54),@#53(#52=I#55),@#53(#52=I#56),@#53(#52=I#57)])
    Samples(
      value=[@Sample(
        value=2
      ),@Sample(
        value=3
      ),@Sample(
        value=5
      ),@Sample(
        value=7
      )]
    )

从中可以看出,在 RuntimeVisibleAnnotations 这个属性中,保存的是 @Samples 注解(这个注解中包含了 4@Sample 注解)。

显式使用 containing annotation 的例子

我们也可以直接使用 @Samples 注解。 请将以下代码保存为 PrimeNumber2.java

java 复制代码
@Samples(value = {
        @Sample(value = 2),
        @Sample(value = 3),
        @Sample(value = 5),
        @Sample(value = 7)
})
public class PrimeNumber2 {
}

用以下命令可以编译 PrimeNumber2.java

bash 复制代码
javac PrimeNumber2.java

编译后,我们会得到 PrimeNumber2.class 文件,用以下命令可以查看 PrimeNumber.class 的内容 ⬇️

css 复制代码
javap -v -p PrimeNumber2

完整的结果有点长,结尾部分的内容如下 ⬇️

text 复制代码
RuntimeVisibleAnnotations:
  0: #14(#15=[@#16(#15=I#17),@#16(#15=I#18),@#16(#15=I#19),@#16(#15=I#20)])
    Samples(
      value=[@Sample(
        value=2
      ),@Sample(
        value=3
      ),@Sample(
        value=5
      ),@Sample(
        value=7
      )]
    )

这里的 RuntimeVisibleAnnotations 属性的内容,和 PrimeNumber.classRuntimeVisibleAnnotations 属性的内容是一致的。由此可见,以下两种情况在 class 中的表示方式是一致的

  • 直接使用可重复注解
  • 显式使用可重复注解的 containing annotation

参考资料

相关推荐
红烧code22 分钟前
【Rust GUI开发入门】编写一个本地音乐播放器(9. 制作设置面板)
开发语言·后端·rust
咖啡Beans1 小时前
SseEmitter + WebClient + Flux实现SSE事件流推送
java·spring boot·flux
你三大爷1 小时前
Safepoint的秘密探寻
java·后端
福大大架构师每日一题1 小时前
2025-10-02:不同 XOR 三元组的数目Ⅰ。用go语言,给你一个长度为 n 的数组 nums,数组恰好包含 1 到 n 这 n 个整数(每个数出现一次)
后端
努力也学不会java1 小时前
【Java并发】揭秘Lock体系 -- condition等待通知机制
java·开发语言·人工智能·机器学习·juc·condition
王嘉俊9252 小时前
Django 入门:快速构建 Python Web 应用的强大框架
前端·后端·python·django·web·开发·入门
我需要打球2 小时前
SpringMVC的执行流程
java·servlet
拾忆,想起2 小时前
RabbitMQ死信交换机:消息的“流放之地“
开发语言·网络·分布式·后端·性能优化·rabbitmq
瑞士卷@2 小时前
JDBC进阶之连接池的配置(Druid与HikariCP)
java·开发语言·数据库
IT_陈寒2 小时前
Redis性能翻倍的5个冷门技巧,90%的开发者从不知道第3点!
前端·人工智能·后端