Java反射-註解

團結發表於2019-01-19
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());
}

相關文章