Java 反射機制及Annotation

標籤：style   blog   http   color   java   使用   os   io   

轉自：http://justjavac.iteye.com/blog/714654

 

 Java 反射是 Java 語言的一個很重要的特徵。 它允許運行中的 Java 程式對自身進行檢查，並能直接操作程式的內部屬性。例如，使用 它能獲得 Java 類中各成員的名稱並顯示出來。

       Java 反射機制主要提供了以下功能：

　　a ．在運行時判斷任意一個對象所屬的類。

　　b ．在運行時構造任意一個類的對象。

　　c ．在運行時判斷任意一個類所具有的成員變數和方法。

　　d ．在運行時調用任意一個對象的方法。

 

在 JDK 中，主要由以下類來實現 Java 反射機制，這些類在 java.lang.reflect 包中：

Class 類：代表一個類。

Field 類：代表類的成員變數（成員變數也 稱為類的屬性）。

Method 類：代表類的方法。

Constructor 類：代表類的構造方法。

Array 類：提供了動態建立數組，以及訪問數組的元素的靜態方法。

   下面寫了一個程式：設計了一個 POJO 類。所謂 POJO 類，本人粗淺的理解即和 JavaBean 類似，只有欄位和 setter/getter 方法。然後在主函數通過反射，在控制台列印該 POJO 類的所有欄位和方法。
     本人設計的 POJO 類為 WorkerPOJO.java ，然後另一個測試類別為 POJOReflection.java ，在 main 函數中負責列印該類的所有欄位和方法。程式見下：

WorkerPOJO.java ：

package com.xpec.landon.trainjava.annotation;/** * POJO類，和JavaBean相似 * @author lvwenyong * */public class WorkerPOJO{ 　　private String name; 　　private int age;  /**  * 用Annotation修飾  * @return 姓名  */ @WorkerPOJOAnnotation(name = "landon",age = 22)  public String getName() {  　　return name; } public void setName(String name) {  　　this.name = name; } public int getAge() {  　　return age; } public void setAge(int age) {  　　this.age = age; }}

 

POJOReflection.java ：

package com.xpec.landon.trainjava.annotation;import java.lang.reflect.Field;import java.lang.reflect.Modifier;import java.lang.reflect.Method;/** * 運用Java的反射機制，輸出POJO類的欄位和方法（新增了Annotation的修飾） * @author lvwenyong * */public class POJOReflectionTest {public static void main(String[] args) {  try   {   //載入WorkPOJO,注意這裡一定要寫全類名，包括包名，因為包名是類名的一部分   Class pojo = Class.forName("com.xpec.landon.trainjava.annotation.WorkerPOJO");   //擷取域的數組   Field []fieldList = pojo.getDeclaredFields();   //擷取方法的數組   Method []methodList = pojo.getDeclaredMethods();      System.out.println("WorkerPOJO類的所有欄位：");   System.out.println("修飾符" + "    " + "類型" + "                   " + "欄位名");      for(int i = 0;i < fieldList.length;i++)   {    Field field = fieldList[i];    //用下面的形式擷取具體的修飾符    System.out.println(Modifier.toString(field.getModifiers()) + " " + field.getType() + " " + field.getName());   }      System.out.println();   System.out.println("WorkerPOJO類的所有方法(不包括annotation修飾的方法)：");      for(int j = 0;j < methodList.length;j++)   {    Method method = methodList[j];    //判斷方法是否被Annotation修飾    boolean methodAnnotation = method.isAnnotationPresent(WorkerPOJOAnnotation.class);        //如果被annotation修飾，則過濾掉該方法，即不輸出    if(methodAnnotation)    {     continue;    }    //擷取方法參數列表    Class parameters[] = method.getParameterTypes();        System.out.print(Modifier.toString(method.getModifiers()) + " " + method.getReturnType() + " " + method.getName() + " (");        for(int k = 0;k < parameters.length;k++)    {     System.out.print(parameters[k].toString());    }        System.out.println(")");   }  }  catch(ClassNotFoundException exception1)  {   exception1.printStackTrace();  }   }}

    下面是程式的一個運行：



    可以看到，在WorkerPOJO類中引入了Annotation 。

 

 

　 下面，我們詳細介紹一下Annotation：
    在使用 JUnit4 中，我們可以看到在每個測試方法前面都有一個 @Test 標記，這就是傳說中的 Annotation 。
     Annotation 提供了一條與程式元素關聯任何資訊或者任何中繼資料（ metadata ）的途徑。從某些方面看，annotation 就像修飾符一樣被使用，並應用於包、類型、構造方法、方法、成 員變數、參數、本地變數的聲明中。這些資訊被儲存在 annotation 的 “name=value” 結構對中。 annotation 類型是一種接 口，能夠通過 java反射 API 的方式提供對其資訊的訪問。
     annotation 能被用來為某個程式元素（類、方法、成員變數等）關聯任何的信 息。需要注意的是，這裡存在著一個基本的潛規則： annotaion 不能影響程式碼的執行，無論增加、刪除 annotation ，代碼都始終如一的執行。另外，儘管一些 annotation 通 過 java 的反射 api 方法在運行時被訪問，而 java 語言解譯器在工作時忽略了這些 annotation 。正是由於 java 虛擬機器忽略了 annotation ，導致了 annotation 類型在代碼中是 “ 不起作用 ” 的；只有通過某種配套的工具才會對 annotation 類型中的資訊進行訪問和處理。
      annotation 是與一個程式元素相關聯資訊或者中繼資料的標註。它從不影響
ava 程式的執行，但是對例如編譯器警告或者像文檔產生器等協助工具輔助產 生影響。
     我的理解是： Annotation 是繼承自 java.lang.annotation.Annotation 的類，用於向程式分析工具或虛擬機器提供 package class field methed 等方面的資訊，它和其他類沒什麼區別 , 除了使用方式。 
    下面寫了一個簡單的Annotation：WorkerPOJOAnnotation.java

package com.xpec.landon.trainjava.annotation;import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * 修飾WorkerPOJO類方法的一個Annotation * @author lvwenyong * */@Target(ElementType.METHOD)@Retention(RetentionPolicy.RUNTIME)@Documentedpublic @interface WorkerPOJOAnnotation { String name(); int age();}

 

    其 中 @Target 裡面的 ElementType 是用來指定 Annotation 類型可以用在哪一些元素上的，包括 TYPE（類型）， METHOD （方法）， FIELD （欄位）， PARAMETER （參數）等。其中 TYPE 是指可以用在Class,Interface 等類型上。下面給出用 jad 反編譯 出的 ElementType 中的靜態變數的：

    另外 @Retention 中的 RetentionPolicy 是指 Annotation 中的資訊保留方式， 分別是 SOURCE,CLASS和 RUNTIME. SOURCE 代表的是這個 Annotation 類型的資訊只會保留在程式源碼裡，源碼如果經過了編譯之後， Annotation 的資料就會消失 , 並不會保留在編譯好的 .class 檔案裡面。 ClASS 的意思是這個 Annotation類型的資訊保留在程式源碼裡 , 同時也會保留在編譯好的 .class 檔案裡面 , 在執行的時候，並不會把這一些資訊載入到虛擬機器 (JVM) 中去 . 注意一下，當你沒有設定一個 Annotation 類型的 Retention 值時，系統預設值是CLASS. 第三個 , 是 RUNTIME, 表示在源碼、編譯好的 .class 檔案中保留資訊，在執行的時候會把這一些資訊載入到 JVM 中去的．
    下面給出用 jad 反編譯出的 RetentionPolicy 中的靜態變數的 
    
    最後的一個 [email protected] 是指目的就是讓這一個 Annotation 類型的資訊能夠顯示在 Java API 說明文檔上。

    下面將上面自己設計的 WorkerPOJOAnnotation 應用在了 WorkerPOJO 類的一個方法前面：

    然後在控制台輸出了沒有被 Annotation 注釋的欄位和方法，運行後可以看到不包括 getName 方法。 
    最後我們可以用Junit4 書寫一個測試案例： POJOReflectionJunit4Test .java

package com.xpec.landon.trainjava.annotation;import java.lang.reflect.Field;import java.lang.reflect.Method;import javax.activation.FileDataSource;import junit.framework.Assert;import org.junit.After;import org.junit.Before;import org.junit.Test;/** * 關於Java反射以及Annotation的一個TestCase * @author lvwenyong * */public class POJOReflectionJunit4Test { private Class pojo; private Field []fieldList; private Method[] methodList; @Before public void setUp() throws Exception {  //載入類WorkPOJO  pojo = Class.forName("com.xpec.landon.trainjava.annotation.WorkerPOJO");  //擷取域的數組  fieldList = pojo.getDeclaredFields();  //擷取方法的數組  methodList = pojo.getDeclaredMethods(); }  //測試欄位和方法的個數 @Test public void testSize() {  Assert.assertEquals(2, fieldList.length);  Assert.assertEquals(4, methodList.length); } //測試欄位是否帶有annotations @Test public void isFieldAnnotation() {  for(int i = 0;i < fieldList.length;i++)  {   Assert.assertEquals(false, fieldList[i].isAnnotationPresent(WorkerPOJOAnnotation.class));  } }  //測試方法是否帶有annotations @Test public void isMethodAnnotation() {  for(int i = 0;i < methodList.length;i++)  {   Assert.assertEquals(false, methodList[i].isAnnotationPresent(WorkerPOJOAnnotation.class));  } }  @After  public void tearDown() throws Exception { }}