[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

参考资料

相关推荐
水淹萌龙11 分钟前
玩转 Go 表达式引擎:expr 实战指南
开发语言·后端·golang
penguin_bark18 分钟前
C++ 异步编程(future、promise、packaged_task、async)
java·开发语言·c++
又是忙碌的一天33 分钟前
Java基础 与运算
java·开发语言
程序猫.36 分钟前
学生管理系统
java·1024程序员节
m0_7482412339 分钟前
Java注解与反射实现日志与校验
java·开发语言·python
一成码农1 小时前
3w字一文讲透Java IO
java·开发语言
Yeats_Liao1 小时前
Go Web 编程快速入门 07.4 - 模板(4):组合模板与逻辑控制
开发语言·后端·golang
木易 士心1 小时前
MyBatis 与 Spring Data JPA 核心对比:选型指南与最佳实践
java·spring·1024程序员节
努力写代码的熊大1 小时前
stack、queue与priority_queue的用法解析与模拟实现
java·前端·javascript
咖啡教室2 小时前
每日一个计算机小知识:MAC地址
后端·网络协议