Java反射-注解

使用反射可以在运行时访问Java类附加的注解。

什么是Java注解

注解是Java5的新特性。注解是可以添加到Java代码中的一种注释或者说是元数据。注解可以使用预编译工具在编译时处理，或者通过反射在运行时处理。下面是类注解的示例：

@MyAnnotation(name="someName",  value = "Hello World")
public class TheClass {
}

类TheClass最上方有注解@MyAnnotation。注解的定义和接口类似。MyAnnotation的定义代码：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)

public @interface MyAnnotation {
    public String name();
    public String value();
}

@ 在interface前标记一个注解。一旦你定义一个注解，就可以在代码中使用，就像例子中一样。
在这个注解有2个指令，@Retention(RetentionPolicy.RUNTIME)和@Retention(RetentionPolicy.RUNTIME)，指定定义的注解该如何使用。
@Retention(RetentionPolicy.RUNTIME) 意思是注解可以在运行时通过反射访问。如果你没有设置这个指令，注解将不能在运行时保存，因此也不能通过反射访问。
@Target(ElementType.TYPE)意味着注解只能在类型（典型的类、接口）上使用。你同样可以指定METHOD、Field，或者你可以允许所有目标包括类型、方法、属性等。
注解的详细使用教程可以参考Java Annotations tutorial。

类注解

你可以在运行时访问一个类、方法、属性的注解。访问类的示例代码如下：

Class aClass = TheClass.class;
Annotation[] annotations = aClass.getAnnotations();

for(Annotation annotation : annotations){
    if(annotation instanceof MyAnnotation){
        MyAnnotation myAnnotation = (MyAnnotation) annotation;
        System.out.println("name: " + myAnnotation.name());
        System.out.println("value: " + myAnnotation.value());
    }
}

你也可以像这样访问类的特定注解：

Class aClass = TheClass.class;
Annotation annotation = aClass.getAnnotation(MyAnnotation.class);

if(annotation instanceof MyAnnotation){
    MyAnnotation myAnnotation = (MyAnnotation) annotation;
    System.out.println("name: " + myAnnotation.name());
    System.out.println("value: " + myAnnotation.value());
}

方法注解

方法上的注解示例：

public class TheClass {
  @MyAnnotation(name="someName",  value = "Hello World")
  public void doSomething(){}
}

访问方法注解代码：

Method method = ... //obtain method object
Annotation[] annotations = method.getDeclaredAnnotations();

for(Annotation annotation : annotations){
    if(annotation instanceof MyAnnotation){
        MyAnnotation myAnnotation = (MyAnnotation) annotation;
        System.out.println("name: " + myAnnotation.name());
        System.out.println("value: " + myAnnotation.value());
    }
}

访问方法的特定注解代码：

Method method = ... // obtain method object
Annotation annotation = method.getAnnotation(MyAnnotation.class);

if(annotation instanceof MyAnnotation){
    MyAnnotation myAnnotation = (MyAnnotation) annotation;
    System.out.println("name: " + myAnnotation.name());
    System.out.println("value: " + myAnnotation.value());
}

参数注解

我们也可以把注解添加在方法的参数声明上。示例如下：

public class TheClass {
  public static void doSomethingElse(
        @MyAnnotation(name="aName", value="aValue") String parameter){
  }
}

你可以通过Method对象访问参数注解，代码如下：

Method method = ... //obtain method object
Annotation[][] parameterAnnotations = method.getParameterAnnotations();
Class[] parameterTypes = method.getParameterTypes();

int i=0;
for(Annotation[] annotations : parameterAnnotations){
  Class parameterType = parameterTypes[i++];

  for(Annotation annotation : annotations){
    if(annotation instanceof MyAnnotation){
        MyAnnotation myAnnotation = (MyAnnotation) annotation;
        System.out.println("param: " + parameterType.getName());
        System.out.println("name : " + myAnnotation.name());
        System.out.println("value: " + myAnnotation.value());
    }
  }
}

注意：Method.getParameterAnnotations() 方法返回二维Annotation数组，包含每个参数上的注解数组。

属性注解

下面是属性上添加注解的示例：

public class TheClass {

  @MyAnnotation(name="someName",  value = "Hello World")
  public String myField = null;
}

访问属性上所有注解的代码：

Field field = ... //obtain field object
Annotation[] annotations = field.getDeclaredAnnotations();

for(Annotation annotation : annotations){
    if(annotation instanceof MyAnnotation){
        MyAnnotation myAnnotation = (MyAnnotation) annotation;
        System.out.println("name: " + myAnnotation.name());
        System.out.println("value: " + myAnnotation.value());
    }
}

访问属性上的特定注解：

Field field = ... // obtain method object
Annotation annotation = field.getAnnotation(MyAnnotation.class);

if(annotation instanceof MyAnnotation){
    MyAnnotation myAnnotation = (MyAnnotation) annotation;
    System.out.println("name: " + myAnnotation.name());
    System.out.println("value: " + myAnnotation.value());
}