Java 注解學習筆記

轉自：http://wanqiufeng.blog.51cto.com/409430/458883

一、什么是java注解

注解，顧名思義，注解,就是對某一事物進行添加注釋說明，會存放一些信息，這些信息可能對以后某個時段來說是很有用處的。 Java注解又叫java標注，java提供了一套機制，使得我們可以對方法、類、參數、包、域以及變量等添加標準(即附上某些信息)。且在以后某個時段通過反射將標注的信息提取出來以供使用。二、自定義Java標注

1 為什么要自定義注解

　　Java從1.5版本以后默認內置三個標注：

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

　　但是，僅僅這三個標注是不能滿足我們開發時一些需求的。所以java允許我們自定義注解來使用。

2 如何自定義注解

　　自定義步驟大致分為兩步：

1. 通過@interface關鍵字(注意，不是interface，是@interace)聲明注解名稱，以及注解的成員屬性或者叫做注解的參數。
2. 使用java內置的四個元注解對這個自定義標注的功能和范圍進行一些限制

問題來了，什么是元注解？

3 什么是元注解

元注解，就是定義注解的注解，也就是說這些元注解是的作用就是專門用來約束其它注解的注解。

請區別上面那三個注解，他們也是通過元注解定義而來的。

元注解有哪些呢，主要有四個@Target,@Retention,@Documented,@Inherited？

 1 　　　　 元注解有：@Target,@Retention,@Documented,@Inherited 2  3         @Target 表示該注解用于什么地方，可能的 ElemenetType 參數包括： 4         ElemenetType.CONSTRUCTOR 構造器聲明 5         ElemenetType.FIELD 域聲明（包括 enum 實例） 6         ElemenetType.LOCAL_VARIABLE 局部變量聲明 7         ElemenetType.METHOD 方法聲明 8         ElemenetType.PACKAGE 包聲明 9         ElemenetType.PARAMETER 參數聲明 
10         ElemenetType.TYPE 類，接口（包括注解類型）或enum聲明 
11          
12         @Retention 表示在什么級別保存該注解信息。可選的 RetentionPolicy 參數包括： 
13         RetentionPolicy.SOURCE 注解將被編譯器丟棄 
14         RetentionPolicy.CLASS 注解在class文件中可用，但會被VM丟棄 
15         RetentionPolicy.RUNTIME VM將在運行期也保留注釋，因此可以通過反射機制讀取注解的信息。 
16          
17         @Documented 將此注解包含在 javadoc 中 
18  
19         @Inherited 允許子類繼承父類中的注解 

4 自定義及使用注解示例

自定義一個類級別的標注Description

   package lighter.javaeye.com;
   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;
 
   @Target(ElementType.TYPE)//這個標注應用于類
   @Retention(RetentionPolicy.RUNTIME)//標注會一直保留到運行時
   @Documented//將此注解包含在javadoc中
   public @interface Description {
       String value();
   }

再定義個方法級別的注解Name

package lighter.javaeye.com;
   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;
 
    //注意這里的@Target與@Description里的不同,參數成員也不同
   @Target(ElementType.METHOD)
   @Retention(RetentionPolicy.RUNTIME)
   @Documented
   public @interface Name {
       String originate();
       String community();
   }

然后使用以上兩個注解

package lighter.javaeye.com;
 
@Description(value="javaeye,做最棒的軟件開發交流社區")
public class JavaEyer {
         @Name(originate="創始人:robbin",community="javaEye")
         public String getName()
         {
                   return null;
         }
        
         @Name(originate="創始人:江南白衣",community="springside")
         public String getName2()
         {
                   return "借用兩位的id一用,寫這一個例子,請見諒!";
         }
}
 
說明：其中標注“@Description(value="javaeye,做最棒的軟件開發交流社區")”，可以寫成“@Description("javaeye,做最棒的軟件開發交流社區") ”，結果也是一樣的。
　　因為Description標注定義的時候其參數(或者說屬性)為value。
　　而value比較特殊，它在被指定參數的時候可以不用顯示的寫出來。
　　當然如果定義的時候參數名不是value而是其它的比如des，那么使用注解的時候，必須顯示寫出參數名，然后再賦值：@Description(Des=”xxx”)*/

提取出注解的信息

 package lighter.javaeye.com;
 
 import java.lang.reflect.Method;
 import java.util.HashSet;
 import java.util.Set;
 
 public class TestAnnotation {
         /**
          * author lighter
          * 說明:具體關天Annotation的API的用法請參見javaDoc文檔
          */
       public static void main(String[] args) throws Exception {
       String CLASS_NAME = "lighter.javaeye.com.JavaEyer";
       Class test = Class.forName(CLASS_NAME);
       Method[] method = test.getMethods();
       boolean flag = test.isAnnotationPresent(Description.class);
        if(flag)
        {
                 Description des = (Description)test.getAnnotation(Description.class);
                 System.out.println("描述:"+des.value());
                 System.out.println("-----------------");
        }
       
        //把JavaEyer這一類有利用到@Name的全部方法保存到Set中去
        Set<Method> set = new HashSet<Method>();
        for(int i=0;i<method.length;i++)
        {
                 boolean otherFlag = method[i].isAnnotationPresent(Name.class);
                 if(otherFlag) set.add(method[i]);
        }
        for(Method m: set)
        {
                 Name name = m.getAnnotation(Name.class);
                  System.out.println(name.originate());
                 System.out.println("創建的社區:"+name.community());
        }
     }
}

注意事項：

所有的Annotation會自動繼承java.lang.annotation這一個接口,所以不能再去繼承別的類或是接口.

???　　最重要的一點,Annotation類型里面的參數該怎么設定:

??　　?第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型.

??　　?第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String,Enum,Class,annotations等數據類型,

以及這一些類型的數組.例如,String value();這里的參數成員就為String.

參考資料：?http://www.javaeye.com/topic/36659#

http://www.javaeye.com/topic/400085

?