自定义注解

Java语言使用@interface语法来定义注解（Annotation），格式如下：

/ / 定义一个简单的注解类型
public @interface Test{

}

在默认情况下， 注解可用于修饰任何程序元素， 包括类、 接口、 方法等， 如下程序使用@Test 来修饰方法:

public class MyClass{
  // 使用@Test 注解修饰方法
  @Test
  public void info(){
  
  }
}

注解不仅可以是这种简单的注解， 还可以带成员变量， 成员变量在注解定义中以无形参的方法形式来声明， 其方法名和返回值定义了该成员变量的名字和类型。

如下代码可以定义一个有成员变量的注解:

public @interface MyTag{
  // 定义带两个成员变量的注解
  // 注解中的成员变量以方法的形式来定义
  String name();
  int age();
} 

注解的参数类似无参数方法，可以用default设定一个默认值（强烈推荐）。最常用的参数应当命名为value：

public @interface MyTag{
  // 定义带两个成员变量的注解
  // 注解中的成员变量以方法的形式来定义
  String name() default "牛钢铁";
  int age() 666;
} 

也可以在使用 MyTag 注解时为成员变量指定值， 如果为 MyTag 的成员变量指定了值， 则默认值不会起作用:

public class MyTest{
  @MyTag(name="麻球"， age=6)
  public void info(){

  }
}

通常会用元注解去修饰自定义注解，如上文所示。
例如，使用@Target可以定义Annotation能够被应用于源码的哪些位置：

//定义MyTag注解应用于方法上
@Target(ElementType.METHOD)    
public @interface MyTag{
  // 定义带两个成员变量的注解
  // 注解中的成员变量以方法的形式来定义
  String name() default "牛钢铁";
  int age() 666;
} 

提取注解信息

使用注解修饰了类、 方法、 成员变量等成员之后， 这些注解不会自己生效， 必须由开发者提供相应的工具来提取并处理注解信息。

因为注解定义后也是一种class，所有的注解都继承自 java.lang.annotation.Annotation，因此，读取注解，需要使用反射API。

Java提供的使用反射API读取Annotation的方法包括：

判断某个注解是否存在于Class、Field、Method或Constructor：

• Class.isAnnotationPresent(Class)
• Field.isAnnotationPresent(Class)
• Method.isAnnotationPresent(Class)
• Constructor.isAnnotationPresent(Class)

例如：

// 判断@Report是否存在于Person类:
Person.class.isAnnotationPresent(Report.class);

使用反射API读取Annotation：

• Class.getAnnotation(Class)

• Field.getAnnotation(Class)

• Method.getAnnotation(Class)

• Constructor.getAnnotation(Class)

例如：

// 获取Person定义的@Report注解:
Report report = Person.class.getAnnotation(Report.class);
int type = report.type();
String level = report.level();

使用反射API读取Annotation有两种方法。方法一是先判断Annotation是否存在，如果存在，就直接读取：

Class cls = Person.class;
if (cls.isAnnotationPresent(Report.class)) {
    Report report = cls.getAnnotation(Report.class);
    ...
}

第二种方法是直接读取Annotation，如果Annotation不存在，将返回null：

Class cls = Person.class;
Report report = cls.getAnnotation(Report.class);
if (report != null) {
   ...
}

读取方法、字段和构造方法的Annotation和Class类似。但要读取方法参数的Annotation就比较麻烦一点，因为方法参数本身可以看成一个数组，而每个参数又可以定义多个注解，所以，一次获取方法参数的所有注解就必须用一个二维数组来表示。例如，对于以下方法定义的注解：

public void hello(@NotNull @Range(max=5) String name,@NotNull String prefix) {
}

要读取方法参数的注解，我们先用反射获取Method实例，然后读取方法参数的所有注解：

// 获取Method实例:
Method m = ...
// 获取所有参数的Annotation:
Annotation[][] annos = m.getParameterAnnotations();
// 第一个参数（索引为0）的所有Annotation:
Annotation[] annosOfName = annos[0];
for (Annotation anno : annosOfName) {
    if (anno instanceof Range) { // @Range注解
        Range r = (Range) anno;
    }
    if (anno instanceof NotNull) { // @NotNull注解
        NotNull n = (NotNull) anno;
    }
}

使用注解实例

Demo1

注解@Testable 没有任何成员变量,仅是一个标记注解,它的作用是标记哪些方法是可测试的: