【譯】8. 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反射——類的動態加載和重新加載

 

 

 

(敬請期待下一篇翻譯)