java Annotation 註解

首先什麼是註解？

　　最常見的是，在我們使用Eclipse等工具編寫java代碼的時候，有時候會出現一些比如@Deprecated，@Override，@SuppressWarnings等東東。這個就是常見的幾種註解。

　　在開發Java程式，尤其是Java EE應用的時候，總是免不了與各種設定檔打交道。以Java EE中典型的S(pring)S(truts)H(ibernate)架構來說，Spring、Struts和Hibernate這三個架構都有自己的XML格式的設定檔。這些設定檔需要與Java原始碼儲存同步，否則的話就可能出現錯誤。而且這些錯誤有可能到了運行時刻才被發現。把同一份資訊儲存在兩個地方，總是個壞的主意。理想的情況是在一個地方維護這些資訊就好了。其它部分所需的資訊則通過自動的方式來產生。JDK 5中引入了原始碼中的註解（annotation）這一機制。註解使得Java原始碼中不但可以包含功能性的實現代碼，還可以添加中繼資料。註解的功能類似於代碼中的注釋，所不同的是註解不是提供代碼功能的說明，而是實現程式功能的重要組成部分。Java註解已經在很多架構中得到了廣泛的使用，用來簡化程式中的配置。

　　而我們最常見的可能就是上面提到的這三個註解了，簡單的介紹一下上面的這三個註解的作用：

　　  @Override:只能用在方法之上的，用來告訴別人這一個方法是改寫父類的。 
  　　@Deprecated:建議別人不要使用舊的API的時候用的,編譯的時候會用產生警告資訊,可以設定在程式裡的所有的元素上. 
        @SuppressWarnings:這一個類型可以來暫時把一些警告資訊訊息關閉. 

在jdk內建的java.lang.annotation包裡,開啟如下幾個源檔案:Target.java，Retention.java，RetentionPolicy.java，ElementType.java。

內容分別為：

@Documented  @Retention(RetentionPolicy.RUNTIME)   @Target(ElementType.ANNOTATION_TYPE)   public @interface Target {      ElementType[] value();   }  

　　

@Documented  @Retention(RetentionPolicy.RUNTIME)   @Target(ElementType.ANNOTATION_TYPE)   public @interface Retention {      RetentionPolicy value();   }  

　　

public enum RetentionPolicy {    SOURCE,    CLASS,    RUNTIME   }  

　　

public enum ElementType {   TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,   LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE  } 

　　在設計annotations的時候必須把一個類型定義為@interface。

     我們需要注意的是：SOURCE,CLASS 和 RUNTIME.這三個層級。

　　   SOURCE代表的是這個Annotation類型的資訊只會保留在程式源碼裡，源碼如果經過了編譯之後，Annotation的資料就會消失,並不會保留在編譯好的.class檔案裡面。 
         ClASS的意思是這個Annotation類型的資訊保留在程式源碼裡,同時也會保留在編譯好的.class檔案裡面,在執行的時候，並不會把這一些資訊載入到虛擬機器(JVM)中去.注意一下，當你沒有設定一個Annotation類型的Retention值時，系統預設值是CLASS. 
         RUNTIME,表示在源碼、編譯好的.class檔案中保留資訊，在執行的時候會把這一些資訊載入到JVM中去的．

　　  ＠Target裡面的ElementType是用來指定Annotation類型可以用在哪一些元素上的.說明一下：TYPE(類型), FIELD(屬性), METHOD(方法), PARAMETER(參數), CONSTRUCTOR(建構函式),LOCAL_VARIABLE(局部變數), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(類型)是指可以用在Class,Interface,Enum和Annotation類型上.
  　　 另外,@Target自己也用了自己來聲明自己。如果一個Annotation類型沒有指明@Target使用在哪些元素上,那麼它可以使用在任何元素之上,這裡的元素指的是上面的八種類型. 
   舉幾個正確的例子:

@Target(ElementType.METHOD)    @Target(value=ElementType.METHOD)    @Target(ElementType.METHOD,ElementType.CONSTRUCTOR)

　　@Documented的目的就是讓這一個Annotation類型的資訊能夠顯示在javaAPI說明文檔上;沒有添加的話，使用javadoc產生API文檔的時候就會找不到這一個類型產生的資訊.

　　另外一點，如果需要把Annotation的資料繼承給子類，那麼就會用到@Inherited這一個Annotation類型.

     本文只是簡單的說了一下註解的常規用法，至於更加深入的註解學習，請參見文章末尾的參考資料。下面我們來看自訂一個註解：原始碼有如下幾個：

源碼分別為：

package com.java.annotation;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * 類註解 * */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.TYPE)public @interface MyAnnotationClass {public String msg();}

　　

package com.java.annotation;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;/** * 方法註解 * */@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.METHOD)public @interface MyAnnotationMethod {public String common();}

　　

package com.java.annotation;import java.lang.annotation.ElementType;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target;@Retention(RetentionPolicy.RUNTIME)@Target(ElementType.FIELD)public @interface MyAnnotationField {boolean request();}

　　

package com.java.annotation;@MyAnnotationClass(msg = "這個是一個類註解")public class MyAnnotationDemo {public MyAnnotationDemo() {}public MyAnnotationDemo(String hello) {this.hello = hello;}@MyAnnotationMethod(common = "這個是一個方法註解")public void method() {System.out.println(hello);}@MyAnnotationField(request = true)private String hello;}

　　

package com.java.annotation;import java.lang.reflect.Field;import java.lang.reflect.Method;public class MyAnnotationTest {public static void main(String[] args) {MyAnnotationDemo demo = new MyAnnotationDemo("hello rollen");MyAnnotationClass annotationClass = demo.getClass().getAnnotation(MyAnnotationClass.class);System.out.println(annotationClass.msg());Method method = null;try {method = demo.getClass().getMethod("method",new Class[0]);} catch (SecurityException e) {e.printStackTrace();} catch (NoSuchMethodException e) {e.printStackTrace();}MyAnnotationMethod annotationMethod = method.getAnnotation(MyAnnotationMethod.class);System.out.println(annotationMethod.common());Field field = null;try {field = demo.getClass().getDeclaredField("hello");} catch (SecurityException e) {e.printStackTrace();} catch (NoSuchFieldException e) {e.printStackTrace();}MyAnnotationField annotationField = field.getAnnotation(MyAnnotationField.class);System.out.println(annotationField.request());}}

　　

參考資料：http://www.infoq.com/cn/articles/cf-java-annotation

              http://tiantian0521.blog.163.com/blog/static/4172088320118243436208/