Java 註解Annotation初解

時間 2019-11-19

標籤 java 註解 annotation 欄目 Java 简体版

原文原文鏈接

Annotation在java的世界正鋪天蓋地展開,有空寫這一篇簡單的annotations的文章,算是關於Annotation入門的文章吧,但願能各位們能拋磚,共同窗習......
   不講廢話了,實踐纔是硬道理.

   第一部分:瞭解一下java1.5起默認的三個annotation類型:
   一個是@Override:只能用在方法之上的，用來告訴別人這一個方法是改寫父類的。
   一個是@Deprecated:建議別人不要使用舊的API的時候用的,編譯的時候會用產生警告信息,能夠設定在程序裏的全部的元素上.
   一個是@SuppressWarnings:這一個類型能夠來暫時把一些警告信息消息關閉.
   若是不清楚上面三個類型的具體用法，各位能夠baidu或google一下的,很簡單的。

   第二部分:講一下annotation的概念先，再來說一下怎樣設計本身的annotation.
   首先在jdk自帶的java.lang.annotation包裏,打開以下幾個源文件:

   一、源文件Target.java

java

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

其中的@interface是一個關鍵字，在設計annotations的時候必須把一個類型定義爲@interface，而不能用class或interface關鍵字(會不會以爲sun有點吝嗇,恰恰搞得與interface這麼像).

二、源文件Retention.java

spring

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

   看到這裏，你們可能都模糊了,都不知道在說什麼，別急，往下看一下.
   在上面的文件都用到了RetentionPolicy，ElementType這兩個字段,你可能就會猜到這是兩個java文件.的確，這兩個文件的源代碼以下：

   三、源文件RetentionPolicy.java數組

 public enum RetentionPolicy {  
     SOURCE,  
     CLASS,  
     RUNTIME  
    }

   這是一個enum類型,共有三個值，分別是SOURCE,CLASS 和 RUNTIME.
   SOURCE表明的是這個Annotation類型的信息只會保留在程序源碼裏，源碼若是通過了編譯以後，Annotation的數據就會消失,並不會保留在編譯好的.class文件裏面。
   ClASS的意思是這個Annotation類型的信息保留在程序源碼裏,同時也會保留在編譯好的.class文件裏面,在執行的時候，並不會把這一些信息加載到虛擬機(JVM)中去.注意一下，當你沒有設定一個Annotation類型的Retention值時，系統默認值是CLASS.
   第三個,是RUNTIME,表示在源碼、編譯好的.class文件中保留信息，在執行的時候會把這一些信息加載到JVM中去的．
　舉一個例子，如@Override裏面的Retention設爲SOURCE,編譯成功了就不要這一些檢查的信息;相反,@Deprecated裏面的Retention設爲RUNTIME,表示除了在編譯時會警告咱們使用了哪一個被Deprecated的方法,在執行的時候也能夠查出該方法是否被Deprecated.

   四、源文件ElementType.javaide

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

   ＠Target裏面的ElementType是用來指定Annotation類型能夠用在哪一些元素上的.說明一下：TYPE(類型), FIELD(屬性), METHOD(方法), PARAMETER(參數), CONSTRUCTOR(構造函數),LOCAL_VARIABLE(局部變量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(類型)是指能夠用在Class,Interface,Enum和Annotation類型上.
   另外,從1的源代碼能夠看出,@Target本身也用了本身來聲明本身,只能用在ANNOTATION_TYPE之上.
   若是一個Annotation類型沒有指明@Target使用在哪些元素上,那麼它可使用在任何元素之上,這裏的元素指的是上面的八種類型.
   舉幾個正確的例子:函數

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

   具體參考一下javadoc文檔

   上面一下1和2的源文件，它們都使用了@Documented,@Documented的目的就是讓這一個Annotation類型的信息可以顯示在javaAPI說明文檔上;沒有添加的話，使用javadoc生成API文檔的時候就會找不到這一個類型生成的信息.
   另一點，若是須要把Annotation的數據繼承給子類，那麼就會用到@Inherited這一個Annotation類型.

   第三部分:下面講的設計一個最簡單的Annotation例子,這一例子共用四個文件;
   一、Description.java學習

    package lighter.iteye.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  
    public @interface Description {  
        String value();  
    }

   說明:全部的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.
   第三,若是隻有一個參數成員,最好把參數名稱設爲"value",後加小括號.例:上面的例子就只有一個參數成員.

   二、Name.javagoogle

    package lighter.iteye.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();  
    }

三、JavaEyer.javaspa

    package lighter.iteye.com;  
      
    @Description("javaeye,作最棒的軟件開發交流社區")  
    public class JavaEyer {  
        @Name(originate="創始人:robbin",community="javaEye")  
        public String getName()  
        {  
            return null;  
        }  
          
        @Name(originate="創始人:江南白衣",community="springside")  
        public String getName2()  
        {  
            return "借用兩位的id一用,寫這一個例子,請見諒!";  
        }  
    }

四、最後，寫一個能夠運行提取JavaEyer信息的類TestAnnotation設計

     package lighter.iteye.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.iteye.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());  
            }  
         }  
    }