重复注解

原文： https://docs.oracle.com/javase/tutorial/java/annotations/repeating.html

在某些情况下，您希望将相同的注解应用于声明或类型用途。从 Java SE 8 版本开始，重复注解使您能够执行此操作。

例如，您正在编写代码以使用计时器服务，该服务使您能够在给定时间或某个计划上运行方法，类似于 UNIX cron服务。现在你要设置一个计时器来运行一个方法， doPeriodicCleanup ，在每个月的最后一天和每个星期五晚上 11 点运行。要将计时器设置为运行，请创建@Schedule注解并将其应用于doPeriodicCleanup方法两次。第一次使用指定月份的最后一天，第二次使用指定星期五晚上 11 点，如下面的代码示例所示：

  1. @Schedule(dayOfMonth="last")
  2. @Schedule(dayOfWeek="Fri", hour="23")
  3. public void doPeriodicCleanup() { ... }

前面的示例将注解应用于方法。您可以在使用标准注解的任何位置重复注解。例如，您有一个用于处理未授权访问异常的类。您为管理员注解了一个@Alert注解，为管理员注解了另一个注解：

  1. @Alert(role="Manager")
  2. @Alert(role="Administrator")
  3. public class UnauthorizedAccessException extends SecurityException { ... }

出于兼容性原因，重复注解存储在由 Java 编译器自动生成的容器注解中。为了使编译器执行此操作，代码中需要两个声明。

第 1 步：声明可重复的注解类型

注解类型必须使用@Repeatable元注解标记。以下示例定义自定义@Schedule可重复注解类型：

  1. import java.lang.annotation.Repeatable;
  3. @Repeatable(Schedules.class)
  4. public @interface Schedule {
  5.   String dayOfMonth() default "first";
  6.   String dayOfWeek() default "Mon";
  7.   int hour() default 12;
  8. }

括号中的@Repeatable元注解的值是 Java 编译器为存储重复注解而生成的容器注解的类型。在此示例中，包含注解类型为Schedules，因此重复@Schedule注解存储在@Schedules注解中。

将相同的注解应用于声明而不首先声明它是可重复的，这会导致编译时错误。

第 2 步：声明包含注解类型

包含注解类型必须具有带有数组类型的value元素。数组类型的组件类型必须是可重复的注解类型。包含注解类型的Schedules的声明如下：

  1. public @interface Schedules {
  2.     Schedule[] value();
  3. }

检索注解

Reflection API 中有几种可用于检索注解的方法。返回单个注解的方法（例如 AnnotatedElement.getAnnotation（Class< T>））的行为不变，因为如果一个注解，它们只返回单个注解。请求的类型存在。如果存在多个所请求类型的注解，则可以通过首先获取其容器注解来获取它们。通过这种方式，遗留代码继续工作。在 Java SE 8 中引入了其他方法，其扫描容器注解以一次返回多个注解，例如 AnnotatedElement.getAnnotationsByType（Class< T>）。有关所有可用方法的信息，请参阅 AnnotatedElement 类规范。

设计注意事项

设计注解类型时，必须考虑该类型注解的基数。现在可以使用注解零次，一次，或者，如果注解的类型标记为@Repeatable，则不止一次。也可以通过使用@Target元注解来限制可以使用注解类型的位置。例如，您可以创建只能在方法和字段上使用的可重复注解类型。仔细设计注解类型非常重要，以确保程序员使用注解发现它尽可能灵活和强大。