先看看Annotation的架構圖:java
從中,咱們能夠看出:編程
(01) Java5.0定義了4個標準的meta-annotation類型,它們被用來提供對其它 annotation類型做說明: Document、Inherited、Retention、Target是元註解( 元註解的做用就是負責註解其餘註解 )架構
(02) 1個Annotation 和 1個RetentionPolicy關聯。
能夠理解爲:每1個Annotation對象,都會有惟一的RetentionPolicy屬性。框架
(03) 1個Annotation 和 1~n個ElementType關聯。
能夠理解爲:對於每1個Annotation對象,能夠有若干個ElementType屬性。eclipse
(04) Annotation 有許多實現類,包括:Deprecated, Documented, Inherited, Override等等。
Annotation 的每個實現類,都「和1個RetentionPolicy關聯」而且「和1~n個ElementType關聯」。
下面,我先介紹框架圖的左半邊(以下圖),即Annotation, RetentionPolicy, ElementType;而後在就Annotation的實現類進行舉例說明。ide
java annotation 的組成中,有3個很是重要的主幹類。它們分別是:函數
package java.lang.annotation; public interface Annotation { boolean equals(Object obj); int hashCode(); String toString(); Class<? extends Annotation> annotationType(); }
package java.lang.annotation; public enum ElementType { TYPE, /* 類、接口(包括註釋類型)或枚舉聲明 */ FIELD, /* 字段聲明(包括枚舉常量) */ METHOD, /* 方法聲明 */ PARAMETER, /* 參數聲明 */ CONSTRUCTOR, /* 構造方法聲明 */ LOCAL_VARIABLE, /* 局部變量聲明 */ ANNOTATION_TYPE, /* 註釋類型聲明 */ PACKAGE /* 包聲明 */ }
package java.lang.annotation; public enum RetentionPolicy { SOURCE, /* Annotation信息僅存在於編譯器處理期間,編譯器處理完以後就沒有該Annotation信息了 */ CLASS, /* 編譯器將Annotation存儲於類對應的.class文件中。默認行爲 */ RUNTIME /* 編譯器將Annotation存儲於class文件中,而且可由JVM讀入 */ }
說明:
(01) Annotation 就是個接口。
「每1個Annotation」 都與 「1個RetentionPolicy」關聯,而且與 「1~n個ElementType」關聯。能夠通俗的理解爲:每1個Annotation對象,都會有惟一的RetentionPolicy屬性;至於 ElementType屬性,則有1~n個。工具
(02) ElementType 是Enum枚舉類型,它用來指定Annotation的類型。
「每1個Annotation」 都與 「1~n個ElementType」關聯。當Annotation與某個ElementType關聯時,就意味着:Annotation有了某種用途。
例如,若一個Annotation對象是METHOD類型,則該Annotation只能用來修飾方法。測試
(03) RetentionPolicy 是Enum枚舉類型,它用來指定Annotation的策略。通俗點說,就是不一樣RetentionPolicy類型的Annotation的做用域不一樣。
「每1個Annotation」 都與 「1個RetentionPolicy」關聯。
a) 若Annotation的類型爲 SOURCE,則意味着:Annotation僅存在於編譯器處理期間,編譯器處理完以後,該Annotation就沒用了。
例如,「 @Override 」標誌就是一個Annotation。當它修飾一個方法的時候,就意味着該方法覆蓋父類的方法;而且在編譯期間會進行語法檢查!編譯器處理完後,「@Override」就沒有任何做用了。
b) 若Annotation的類型爲 CLASS,則意味着:編譯器將Annotation存儲於類對應的.class文件中,它是Annotation的默認行爲。
c) 若Annotation的類型爲 RUNTIME,則意味着:編譯器將Annotation存儲於class文件中,而且可由JVM讀入。ui
這時,只須要記住「每1個Annotation」 都與 「1個RetentionPolicy」關聯,而且與 「1~n個ElementType」關聯。學完後面的內容以後,再回頭看這些內容,會更容易理解。
第3部分 java自帶的Annotation
理解了上面的3個類的做用以後,咱們接下來能夠講解Annotation實現類的語法定義了。
@Documented @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface MyAnnotation1 { }
說明:
上面的做用是定義一個Annotation,它的名字是MyAnnotation1。定義了MyAnnotation1以後,咱們能夠在代碼中經過「@MyAnnotation1」來使用它。
其它的,@Documented, @Target, @Retention, @interface都是來修飾MyAnnotation1的。下面分別說說它們的含義:
(01) @interface
使用@interface定義註解時,意味着它實現了java.lang.annotation.Annotation接口,即該註解就是一個Annotation。
定義Annotation時,@interface是必須的。
注意:它和咱們一般的implemented實現接口的方法不一樣。Annotation接口的實現細節都由編譯器完成。經過@interface定義註解後,該註解不能繼承其餘的註解或接口。
(02) @Documented
類和方法的Annotation在缺省狀況下是不出如今javadoc中的。若是使用@Documented修飾該Annotation,則表示它能夠出如今javadoc中。
定義Annotation時,@Documented無關緊要;若沒有定義,則Annotation不會出如今javadoc中。
(03) @Target(ElementType.TYPE)
前面咱們說過,ElementType 是Annotation的類型屬性。而@Target的做用,就是來指定Annotation的類型屬性。
@Target(ElementType.TYPE) 的意思就是指定該Annotation的類型是ElementType.TYPE。這就意味着,MyAnnotation1是來修飾「類、接口(包括註釋類型)或枚舉聲明」的註解。
定義Annotation時,@Target無關緊要。如有@Target,則該Annotation只能用於它所指定的地方;若沒有@Target,則該Annotation能夠用於任何地方。
(04) @Retention(RetentionPolicy.RUNTIME)
前面咱們說過,RetentionPolicy 是Annotation的策略屬性,而@Retention的做用,就是指定Annotation的策略屬性。
@Retention(RetentionPolicy.RUNTIME) 的意思就是指定該Annotation的策略是RetentionPolicy.RUNTIME。這就意味着,編譯器會將該Annotation信息保留 在.class文件中,而且能被虛擬機讀取。
定義Annotation時,@Retention無關緊要。若沒有@Retention,則默認是RetentionPolicy.CLASS。
經過上面的示例,咱們能理解:@interface用來聲明Annotation,@Documented用來表示該Annotation是否會出如今javadoc中, @Target用來指定Annotation的類型,@Retention用來指定Annotation的策略。
理解這一點以後,咱們就很容易理解java中自帶的Annotation的實現類,即Annotation架構圖的右半邊。以下圖:
@Deprecated -- @Deprecated 所標註內容,再也不被建議使用。 @Override -- @Override 只能標註方法,表示該方法覆蓋父類中的方法。 @Documented -- @Documented 所標註內容,能夠出如今javadoc中。 @Inherited -- @Inherited只能被用來標註「Annotation類型」,它所標註的Annotation具備繼承性。 @Retention -- @Retention只能被用來標註「Annotation類型」,並且它被用來指定Annotation的RetentionPolicy屬性。 @Target -- @Target只能被用來標註「Annotation類型」,並且它被用來指定Annotation的ElementType屬性。 @SuppressWarnings -- @SuppressWarnings 所標註內容產生的警告,編譯器會對這些警告保持靜默。
因爲「@Deprecated和@Override」相似,「@Documented, @Inherited, @Retention, @Target」相似;下面,咱們只對@Deprecated, @Inherited, @SuppressWarnings 這3個Annotation進行說明。
@Deprecated 的定義以下:
@Documented @Retention(RetentionPolicy.RUNTIME) public @interface Deprecated { }
說明:
(01) @interface -- 它的用來修飾Deprecated,意味着Deprecated實現了java.lang.annotation.Annotation接口;即Deprecated就是一個註解。
(02) @Documented -- 它的做用是說明該註解能出如今javadoc中。
(03) @Retention(RetentionPolicy.RUNTIME) -- 它的做用是指定Deprecated的策略是RetentionPolicy.RUNTIME。這就意味着,編譯器會將Deprecated的信息保留 在.class文件中,而且能被虛擬機讀取。
(04) @Deprecated 所標註內容,再也不被建議使用。
例如,若某個方法被 @Deprecated 標註,則該方法再也不被建議使用。若是有開發人員試圖使用或重寫被@Deprecated標示的方法,編譯器會給相應的提示信息。示例以下:
源碼以下(DeprecatedTest.java):
1 package com.skywang.annotation; 2 3 import java.util.Date; 4 import java.util.Calendar; 5 6 public class DeprecatedTest { 7 // @Deprecated 修飾 getString1(),表示 它是建議不被使用的函數 8 @Deprecated 9 private static void getString1(){ 10 System.out.println("Deprecated Method"); 11 } 12 13 private static void getString2(){ 14 System.out.println("Normal Method"); 15 } 16 17 // Date是日期/時間類。java已經不建議使用該類了 18 private static void testDate() { 19 Date date = new Date(113, 8, 25); 20 System.out.println(date.getYear()); 21 } 22 // Calendar是日期/時間類。java建議使用Calendar取代Date表示「日期/時間」 23 private static void testCalendar() { 24 Calendar cal = Calendar.getInstance(); 25 System.out.println(cal.get(Calendar.YEAR)); 26 } 27 28 public static void main(String[] args) { 29 getString1(); 30 getString2(); 31 testDate(); 32 testCalendar(); 33 } 34 }
說明:
上面是eclipse中的截圖,比較類中 「getString1() 和 getString2()」 以及 「testDate() 和 testCalendar()」 。
(01) getString1() 被@Deprecated標註,意味着建議再也不使用getString1();因此getString1()的定義和調用時,都會一橫線。這一橫線是eclipse()對@Deprecated方法的處理。
getString2() 沒有被@Deprecated標註,它的顯示正常。
(02) testDate() 調用了Date的相關方法,而java已經建議再也不使用Date操做日期/時間。所以,在調用Date的API時,會產生警告信息,途中的warnings。
testCalendar() 調用了Calendar的API來操做日期/時間,java建議用Calendar取代Date。所以,操做Calendar不回產生warning。
@Inherited 的定義以下:
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Inherited { }
說明:
@Inherited 元註解是一個標記註解,@Inherited闡述了某個被標註的類型是被繼承的。若是一個使用了@Inherited修飾的annotation類型被用於一個class,則這個annotation將被用於該class的子類。
注意:@Inherited annotation類型是被標註過的class的子類所繼承。類並不從它所實現的接口繼承annotation,方法並不從它所重載的方法繼承annotation。
當@Inherited annotation類型標註的annotation的Retention是RetentionPolicy.RUNTIME,則反射API加強了這種繼 承性。若是咱們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時,反射代碼檢查將展開工做:檢查class和其父類,直到發現指定的annotation類型被發現, 或者到達類繼承結構的頂層。
(01) @interface -- 它的用來修飾Inherited,意味着Inherited實現了java.lang.annotation.Annotation接口;即Inherited就是一個註解。
(02) @Documented -- 它的做用是說明該註解能出如今javadoc中。
(03) @Retention(RetentionPolicy.RUNTIME) -- 它的做用是指定Inherited的策略是RetentionPolicy.RUNTIME。這就意味着,編譯器會將Inherited的信息保留 在.class文件中,而且能被虛擬機讀取。
(04) @Target(ElementType.ANNOTATION_TYPE) -- 它的做用是指定Inherited的類型是ANNOTATION_TYPE。這就意味着,@Inherited只能被用來標註「Annotation類型」。
(05) @Inherited 的含義是,它所標註的Annotation將具備繼承性。
假設,咱們定義了某個Annotaion,它的名稱是MyAnnotation,而且MyAnnotation被標註爲@Inherited。如今,某 個類Base使用了MyAnnotation,則Base具備了「具備了註解MyAnnotation」;如今,Sub繼承了Base,因爲 MyAnnotation是@Inherited的(具備繼承性),因此,Sub也「具備了註解MyAnnotation」。
@Inherited的使用示例
源碼以下(InheritableSon.java):
1 /** 2 * @Inherited 演示示例 3 * 4 * @author skywang 5 * @email kuiwu-wang@163.com 6 */ 7 package com.skywang.annotation; 8 9 import java.lang.annotation.Target; 10 import java.lang.annotation.ElementType; 11 import java.lang.annotation.Retention; 12 import java.lang.annotation.RetentionPolicy; 13 import java.lang.annotation.Inherited; 14 15 /** 16 * 自定義的Annotation。 17 */ 18 @Target(ElementType.TYPE) 19 @Retention(RetentionPolicy.RUNTIME) 20 @Inherited 21 @interface Inheritable 22 { 23 } 24 25 @Inheritable 26 class InheritableFather 27 { 28 public InheritableFather() { 29 // InheritableBase是否具備 Inheritable Annotation 30 System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class)); 31 } 32 } 33 34 /** 35 * InheritableSon 類只是繼承於 InheritableFather, 36 */ 37 public class InheritableSon extends InheritableFather 38 { 39 public InheritableSon() { 40 super(); // 調用父類的構造函數 41 // InheritableSon類是否具備 Inheritable Annotation 42 System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class)); 43 } 44 45 public static void main(String[] args) 46 { 47 InheritableSon is = new InheritableSon(); 48 } 49 }
運行結果:
InheritableFather:true
InheritableSon:true
如今,咱們對InheritableSon.java進行修改:註釋掉「Inheritable的@Inherited註解」。
源碼以下(InheritableSon.java):
1 /** 2 * @Inherited 演示示例 3 * 4 * @author skywang 5 * @email kuiwu-wang@163.com 6 */ 7 package com.skywang.annotation; 8 9 import java.lang.annotation.Target; 10 import java.lang.annotation.ElementType; 11 import java.lang.annotation.Retention; 12 import java.lang.annotation.RetentionPolicy; 13 import java.lang.annotation.Inherited; 14 15 /** 16 * 自定義的Annotation。 17 */ 18 @Target(ElementType.TYPE) 19 @Retention(RetentionPolicy.RUNTIME) 20 //@Inherited 21 @interface Inheritable 22 { 23 } 24 25 @Inheritable 26 class InheritableFather 27 { 28 public InheritableFather() { 29 // InheritableBase是否具備 Inheritable Annotation 30 System.out.println("InheritableFather:"+InheritableFather.class.isAnnotationPresent(Inheritable.class)); 31 } 32 } 33 34 /** 35 * InheritableSon 類只是繼承於 InheritableFather, 36 */ 37 public class InheritableSon extends InheritableFather 38 { 39 public InheritableSon() { 40 super(); // 調用父類的構造函數 41 // InheritableSon類是否具備 Inheritable Annotation 42 System.out.println("InheritableSon:"+InheritableSon.class.isAnnotationPresent(Inheritable.class)); 43 } 44 45 public static void main(String[] args) 46 { 47 InheritableSon is = new InheritableSon(); 48 } 49 }
運行結果:
InheritableFather:true
InheritableSon:false
對比上面的兩個結果,咱們發現:當註解Inheritable被@Inherited標註時,它具備繼承性。不然,沒有繼承性。
@SuppressWarnings 的定義以下:
@Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) @Retention(RetentionPolicy.SOURCE) public @interface SuppressWarnings { String[] value(); }
說明:
(01) @interface -- 它的用來修飾SuppressWarnings,意味着SuppressWarnings實現了java.lang.annotation.Annotation接口;即SuppressWarnings就是一個註解。
(02) @Retention(RetentionPolicy.SOURCE) -- 它的做用是指定SuppressWarnings的策略是RetentionPolicy.SOURCE。這就意味着,SuppressWarnings 信息僅存在於編譯器處理期間,編譯器處理完以後SuppressWarnings就沒有做用了。
(03) @Target({TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE}) -- 它的做用是指定SuppressWarnings的類型同時包括TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR, LOCAL_VARIABLE。
TYPE意味着,它能標註「類、接口(包括註釋類型)或枚舉聲明」。
FIELD意味着,它能標註「字段聲明」。
METHOD意味着,它能標註「方法」。
PARAMETER意味着,它能標註「參數」。
CONSTRUCTOR意味着,它能標註「構造方法」。
LOCAL_VARIABLE意味着,它能標註「局部變量」。
(04) String[] value(); 意味着,SuppressWarnings能指定參數
(05) SuppressWarnings 的做用是,讓編譯器對「它所標註的內容」的某些警告保持靜默。例如,"@SuppressWarnings(value={"deprecation", "unchecked"})" 表示對「它所標註的內容」中的 「SuppressWarnings再也不建議使用警告」和「未檢查的轉換時的警告」保持沉默。示例以下:
源碼以下(SuppressWarningTest.java):
1 package com.skywang.annotation; 2 3 import java.util.Date; 4 5 public class SuppressWarningTest { 6 7 //@SuppressWarnings(value={"deprecation"}) 8 public static void doSomething(){ 9 Date date = new Date(113, 8, 26); 10 System.out.println(date); 11 } 12 13 public static void main(String[] args) { 14 doSomething(); 15 } 16 }
說明:
(01) 左邊的圖中,沒有使用 @SuppressWarnings(value={"deprecation"}) , 而Date屬於java再也不建議使用的類。所以,調用Date的API時,會產生警告。
而右邊的途中,使用了 @SuppressWarnings(value={"deprecation"})。所以,編譯器對「調用Date的API產生的警告」保持沉默。
補充:SuppressWarnings 經常使用的關鍵字的表格
deprecation -- 使用了不同意使用的類或方法時的警告 unchecked -- 執行了未檢查的轉換時的警告,例如當使用集合時沒有用泛型 (Generics) 來指定集合保存的類型。 fallthrough -- 當 Switch 程序塊直接通往下一種狀況而沒有 Break 時的警告。 path -- 在類路徑、源文件路徑等中有不存在的路徑時的警告。 serial -- 當在可序列化的類上缺乏 serialVersionUID 定義時的警告。 finally -- 任何 finally 子句不能正常完成時的警告。 all -- 關於以上全部狀況的警告。
Annotation 是一個輔助類,它在Junit、Struts、Spring等工具框架中被普遍使用。
咱們在編程中常常會使用到的Annotation做用有:
Annotation具備「讓編譯器進行編譯檢查的做用」。
例如,@SuppressWarnings, @Deprecated和@Override都具備編譯檢查做用。
(01) 關於@SuppressWarnings和@Deprecated,已經在「第3部分」中詳細介紹過了。這裏就再也不舉例說明了。
(02) 若某個方法被 @Override的 標註,則意味着該方法會覆蓋父類中的同名方法。若是有方法被@Override標示,但父類中卻沒有「被@Override標註」的同名方法,則編譯器會報錯。示例以下:
源碼(OverrideTest.java):
1 package com.skywang.annotation; 2 3 /** 4 * @Override測試程序 5 * 6 * @author skywang 7 * @email kuiwu-wang@163.com 8 */ 9 public class OverrideTest { 10 11 /** 12 * toString() 在java.lang.Object中定義; 13 * 所以,這裏用 @Override 標註是對的。 14 */ 15 @Override 16 public String toString(){ 17 return "Override toString"; 18 } 19 20 /** 21 * getString() 沒有在OverrideTest的任何父類中定義; 22 * 可是,這裏卻用 @Override 標註,所以會產生編譯錯誤! 23 */ 24 @Override 25 public String getString(){ 26 return "get toString"; 27 } 28 29 public static void main(String[] args) { 30 } 31 }
上面是該程序在eclipse中的截圖。從中,咱們能夠發現「getString()」函數會報錯。這是由於「getString() 被@Override所標註,但在OverrideTest的任何父類中都沒有定義getString1()函數」。
「將getString() 上面的@Override註釋掉」,便可解決該錯誤。
在反射的Class, Method, Field等函數中,有許多於Annotation相關的接口。
這也意味着,咱們能夠在反射中解析並使用Annotation。
源碼以下(AnnotationTest.java):
package com.skywang.annotation; import java.lang.annotation.Annotation; import java.lang.annotation.Target; import java.lang.annotation.ElementType; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; import java.lang.annotation.Inherited; import java.lang.reflect.Method; /** * Annotation在反射函數中的使用示例 * * @author skywang * @email kuiwu-wang@163.com */ @Retention(RetentionPolicy.RUNTIME) @interface MyAnnotation { String[] value() default "unknown"; } /** * Person類。它會使用MyAnnotation註解。 */ class Person { /** * empty()方法同時被 "@Deprecated" 和 「@MyAnnotation(value={"a","b"})」所標註 * (01) @Deprecated,意味着empty()方法,再也不被建議使用 * (02) @MyAnnotation, 意味着empty() 方法對應的MyAnnotation的value值是默認值"unknown" */ @MyAnnotation @Deprecated public void empty(){ System.out.println("\nempty"); } /** * sombody() 被 @MyAnnotation(value={"girl","boy"}) 所標註, * @MyAnnotation(value={"girl","boy"}), 意味着MyAnnotation的value值是{"girl","boy"} */ @MyAnnotation(value={"girl","boy"}) public void somebody(String name, int age){ System.out.println("\nsomebody: "+name+", "+age); } } public class AnnotationTest { public static void main(String[] args) throws Exception { // 新建Person Person person = new Person(); // 獲取Person的Class實例 Class<Person> c = Person.class; // 獲取 somebody() 方法的Method實例 Method mSomebody = c.getMethod("somebody", new Class[]{String.class, int.class}); // 執行該方法 mSomebody.invoke(person, new Object[]{"lily", 18}); iteratorAnnotations(mSomebody); // 獲取 somebody() 方法的Method實例 Method mEmpty = c.getMethod("empty", new Class[]{}); // 執行該方法 mEmpty.invoke(person, new Object[]{}); iteratorAnnotations(mEmpty); } public static void iteratorAnnotations(Method method) { // 判斷 somebody() 方法是否包含MyAnnotation註解 if(method.isAnnotationPresent(MyAnnotation.class)){ // 獲取該方法的MyAnnotation註解實例 MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class); // 獲取 myAnnotation的值,並打印出來 String[] values = myAnnotation.value(); for (String str:values) System.out.printf(str+", "); System.out.println(); } // 獲取方法上的全部註解,並打印出來 Annotation[] annotations = method.getAnnotations(); for(Annotation annotation : annotations){ System.out.println(annotation); } } }
運行結果:
somebody: lily, 18
girl, boy,
@com.skywang.annotation.MyAnnotation(value=[girl, boy])
empty
unknown,
@com.skywang.annotation.MyAnnotation(value=[unknown])
@java.lang.Deprecated()
經過給Annotation註解加上@Documented標籤,能使該Annotation標籤出如今javadoc中。
經過@Override, @Deprecated等,咱們能很方便的瞭解程序的大體結構。 另外,咱們也能夠經過自定義Annotation來實現一些功能