重复注解

重复注解

java8的重复注解允许你将同样的注解用在声明或类型上。

例如，你写了一个类似于UNIX中的cron服务的服务。该服务运行在特定schedule里，里面有一个在给定时间就运行的方法。现在你想通过设置一个定时器来运行方法，方法doPeriodicCleanup，在每个月的最后一天和每周五的下午11:00运行。通过创建注解@Schedule，并作用于方法doPeriodicCleanup两次。第一个注解指定每个月的最后一天而第二个注解指定每周五的下午11:00.如下所示：

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

上个例子将注解作用于方法。你可以将一个独立的注解重复地应用于任何地方。例如，你有一个处理未授权访问异常的类。你通过指定了Manager的 @Alert和一个指定了admins的类来注解该类。

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

由于兼容性问题，重复注解保存在一个由java编译器自动生成的注解容器中。为了让编译器生成注解容器，你需要在代码中添加两个声明。

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

必须用@Repeatable来标明注解类型。下面演示了一个自定义重复注解@Schedule

import java.lang.annotation.Repeatable;

@Repeatable(Schedules.class)
public @interface Schedule {
  String dayOfMonth() default "first";
  String dayOfWeek() default "Mon";
  int hour() default 12;
}

括号里面的元注解 @Repeatable的值，就是java编译器自动生成的用来存储重复注解的注解容器所要存储的类型。这个例子中，所要保存的注解的类型是Schedules，所以重复注解 @Schedule 声明要保存在注解@Schedules中。

在声明中使用同一个注解，如果第一次使用注解没有声明注解的值会导致编译时错误。

步骤2：声明容器注解的类型

容器注解的类型必须包含一个数组。数组的类型必须是重复注解的类型。声明容器注解的类型是Schedules的方法如下：

public @interface Schedules {
    Schedule[] value();
}

检索注解

在反射的API中有一些可以用来检索注解的方法。方法返回一个单独的注解，例如 AnnotatedElement.getAnnotationByType(Class<T>)在找到一个指定的类型的注解时就将该注解返回。如果有多个返回相同类型的注解，你可以先获取它们的注解容器。用这种方式，未执行的代码会继续执行。java8中获取多个注解的方法例如 AnnotatedElement.getAnnotations(Class<T>)。详情请看类AnnotatedElement。

设计注解所需要的考虑

当设计一个注解类型时，你必须考虑那种类型的注解的基数。现在注解可以被使用0次、1次，如果声明了@Repeatable甚至可以被用多次。还可以通过 元注解@Target来限定注解所能使用的范围。例如你可以创建一个只能作用于方法和变量上的重复注解。设计注解类型很重要，你要让编程人员根据注解尽可能方便快速地找到使用的地方。

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