Java注释(Annotation)详解
注釋:在一個類中可以有多個,類似于一個類可以有多個實例;
?????注釋類型:是注釋使用的結構,類似于類,僅有一個版本,因此多個注釋可能使用相同的注釋類型
?????jdk默認的三個注釋:
???????1.Override注釋:僅用于方法(不可用于類、包的生命或其他),指明注釋的方法將覆蓋超類中的方法(如果覆蓋父類的方法而沒有注
釋就無法編譯該類),注釋還能確保注釋父類方法的拼寫是正確(錯誤的編寫,編譯器不認為是子類的新方法,而會報錯)
???????2.@Deprecated注釋:對不應再使用的方法進行注釋,與正在聲明為過時的方法放在同一行。使用被?????Deprecated注釋的方法,編譯器會
提示方法過時警告(”Warring”)
???????3.@SuppressWarnings注釋:單一注釋,可以通過數組提供變量,變量值指明要阻止的特定類型警告(忽略某些警告)。數組中的變量指明要阻止的警告@SuppressWarnings(value={“unchecked”,”fallthrough”}))
?????上面提到“單一注釋”這個概念,他表示注釋的類型,java中有三種類型的注釋:
???????1.標記注釋:由名稱標記,未提供數據,@MarkerAnnotation
???????2.單一注釋:與標記注釋類似,但提供了一段很少一點的數據,很類似普通的java方法調用(@SingleValueAnnotation(“my data”)
???????3.完整注釋:有多個數據成員,必須提供完整的語法(@FullAnnotation(var=”data value”,var2=”data value2″,var3=”data value3″))除了通過默認語法向注釋提供值,還可以通過花括號為注釋變量提供值數組,數組用”,”分割
自定義注釋:
?????@interface:注釋聲明,定義注釋類型(與默認的Override等三種注釋類型類似),使用時與內置注釋類型類似。使用定制注釋類型時,要將注釋定義類導入,或者直接引入包名。(定義注釋類型和定義類非常類似,僅在注釋類型名稱前多了@interface),自定義注釋類型中的變量如同類中的方法定義需要”()”,并以”;”結束
?????在使用有變量的注釋類型時,需要制定數據類型的名稱,但是如果注釋類型中只有一個變量,最好將參數名稱設為value,賦值時不用指定定名稱而直接賦值如:變量名稱(@AnnotationType(var value)),否則需要制定變量的名稱(@Annotation(varname=varvalue))
?????注釋類型的默認值:在定義注釋的成員變量,需要在成員的聲明后添加關鍵字(default)并對其賦值(默認值),注意默認值的類型必須和成員變量的類型一致。在使用該注釋類型時,如果沒有給該注釋類型的成員變量賦值即用默認值
?????現在自定義注釋來演示:
?????1.在eclipse中新建一個Annotation類:FirstAnno.java
?????2.再新建一個Annotation類:SecondAnnotation:
package cn.hrmzone.anno;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;@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface SecondAnno { // 注釋中含有兩個參數String name() default "Hrmzone";String url() default "hrmzone.cn"; } ?????這個時候,估計對
?????@Documented
?????@Retention(RetentionPolicy.RUNTIME)
?????@Target(ElementType.METHOD)
?????這三個注釋有很多疑問了吧,先將演示完成在解釋:
?????3.新建一個使用以上定義的兩個注釋的類:Anno.java
?????4.測試注釋:AnnoTest.class
package cn.hrmzone.anno;import java.io.File; import java.lang.reflect.Method; import java.util.ArrayList; import java.util.List;public class AnnoTest {public static void main(String[] args) throws ClassNotFoundException { // 要使用到反射中的相關內容Class c=Class.forName("cn.hrmzone.anno.Anno");Method[] method=c.getMethods();boolean flag=c.isAnnotationPresent(FirstAnno.class);if(flag) {FirstAnno first=(FirstAnno) c.getAnnotation(FirstAnno.class);System.out.println("First Annotation:"+first.value()+"\n");}List<Method> list=new ArrayList<Method>();for(int i=0;i<method.length;i++) {boolean f=method[i].isAnnotationPresent(SecondAnno.class);if(f) {list.add(method[i]);} }for(Method m:list) {SecondAnno anno=m.getAnnotation(SecondAnno.class);System.out.println("second annotation's\nname:\t"+anno.name()+"\nurl:\t"+anno.url());}} }?????測試的輸出結果為:
First Annotation:http://hrmzone.cnsecond annotation's name: desktophrm url: desktophrm.com second annotation's name: Hrmzone url: hrmzone.cn ?????結合源文件中注釋,想必對注釋的應用有所了解。下面深入了解。
?????深入注釋:
?????上面的兩個Annotation類中有三個奇怪的注釋,他們是元注釋。
?????元注釋:注釋的注釋,對注釋進行注釋,下面分別介紹這三個注釋:
?????@Target:指定程序元定義的注釋所使用的地方,它使用了另一個類:ElementType,是一個枚舉類定義了注釋類型可以應用到不同的程序元素以免使用者誤用。看看java.lang.annotation 下的源代碼:
?????ElementType是一個枚舉類型,指明注釋可以使用的地方,看看ElementType類:
public enum ElementType { TYPE, // 指定適用點為 class, interface, enum FIELD, // 指定適用點為 field METHOD, // 指定適用點為 method PARAMETER, // 指定適用點為 method 的 parameter CONSTRUCTOR, // 指定適用點為 constructor LOCAL_VARIABLE, // 指定使用點為 局部變量 ANNOTATION_TYPE, //指定適用點為 annotation 類型 PACKAGE // 指定適用點為 package }?????@Retention:這個元注釋和java編譯器處理注釋的注釋類型方式相關,告訴編譯器在處理自定義注釋類型的幾種不同的選擇,需要使用RetentionPolicy枚舉類。此枚舉類只有一個成員變量,可以不用指明成名名稱而賦值,看Retention的源代碼:
@Documented @Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE) public @interface Retention { RetentionPolicy value(); }?????類中有個RetentionPolicy類,也是一個枚舉類,具體看代碼:
public enum RetentionPolicy { SOURCE, // 編譯器處理完Annotation后不存儲在class中 CLASS, // 編譯器把Annotation存儲在class中,這是默認值 RUNTIME // 編譯器把Annotation存儲在class中,可以由虛擬機讀取,反射需要 } ?????@Documented:是一個標記注釋,表示注釋應該出現在類的javadoc中,因為在默認情況下注釋時不包括在javadoc中的。所以如果花費了大量的時間定義一個注釋類型,并想描述注釋類型的作用,可以使用它。注意他與@Retention(RetentionPolicy.RUNTIME)配合使用,因為只有將注釋保留在編譯后的類文件中由虛擬機加載,然后javadoc才能將其抽取出來添加至javadoc中。
?????@Inherited:將注釋同樣繼承至使用了該注釋類型的方法中(表達有點問題,就是如果一個方法使用了的注釋用了@inherited,那么其子類的該方法同樣繼承了該注釋)
注意事項:
?????1.所有的Annotation自動繼承java.lang.annotation接口
?????2.自定義注釋的成員變量訪問類型只能是public、default;
?????3.成員變量的只能使用基本類型(byte、short、int、char、long、double、float、boolean和String、Enum、Class、annotations以及該類型的數據)
?????4.如果只有一個成員變量,最好將參數名稱設為value,賦值時不用制定名稱而直接賦值
?????5.在實際應用中,還可以使用注釋讀取和設置Bean中的變量。
總結
以上是生活随笔為你收集整理的Java注释(Annotation)详解的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 自己动手写Tomcat
- 下一篇: 学习笔记2——对象初始化和面向对象特性