【譯】8. Java反射——註解

pengisgood發表於2013-09-12
Java反射

原文地址：http://tutorials.jenkov.com/java-reflection/annotations.html

 =====================================================================================

     使用Java反射機制，在執行時你可以訪問到Java類中所附屬的一些註解。下面是本文所涵蓋的主題列表：

  1. What are Java Annotations? （什麼是Java註解）
  2. Class Annotations （類註解）
  3. Method Annotations （方法註解）
  4. Parameter Annotations （引數註解）
  5. Field Annotations （欄位註解）

 =====================================================================================

 

  • What are Java Annotations?    

 　　註解是Java 5的一個新特性。註解是一種可以寫到程式碼中的註釋或者後設資料。這些註解可以在編譯時由預編譯工具進行處理，或者在執行時通過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之前加一個@符號來表示它是一個註解。一旦你定義了一個註解之後，你可以在程式碼中用它，和之前的例子一樣。

     在註解的定義中，@Retention(RetentionPolicy.RUNTIME)和@Target(ElementType.TYPE)這兩個註解指定了如何去使用它們。
     @Retention(RetentionPolicy.RUNTIME)表示該註解可以在執行時通過Java反射訪問。如果你沒有設定該指令，該註解在執行時就不會被儲存，那麼也就不能通過Java反射來使用。
     @Target(ElementType.TYPE)表示該註解只能被用於型別上（如類、介面）。你也可以指定METHOD或者FIELD，或者你也可以省略不寫，即該註解可以被用在類、方法和欄位上。
     關於Java註解更詳細的介紹在Java Annotation tutorial中。
 =====================================================================================

  • Class Annotations      

　　你可以在執行時訪問類、方法或欄位的註解。下面是一個訪問類註解的例子：

 

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());
}

 

=====================================================================================

  • Method Annotations

　　下面是一個註解用在方法上的例子：

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());
}

 

=====================================================================================

  • Parameter Annotations 

　　也可以在方法引數的宣告上新增註解。下面是一個例子：

 

 

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陣列，該陣列中包含每一個方法的引數註解。

=====================================================================================

  • Field Annotations      

　　下面是一個欄位註解的例子：

 

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());
}

 

 

 

========================================================================================

  •  目錄

 

　　這是一個本教程到目前為止涵蓋的主題列表：     

 

 

 

  1. Java反射——引言
  2. Java反射——Class物件
  3. Java反射——建構函式
  4. Java反射——欄位
  5. Java反射——方法
  6. Java反射——Getter和Setter
  7. Java反射——私有欄位和私有方法
  8. Java反射——註解
  9. Java反射——泛型
  10. Java反射——陣列
  11. Java反射——動態代理
  12. Java反射——類的動態載入和重新載入

 

 

 

(敬請期待下一篇翻譯)

 

相關文章