|
Annotation在java的世界正鋪天蓋地展開(kāi),有空寫(xiě)這一篇簡(jiǎn)單的annotations的文章,算是關(guān)于Annotation入門(mén)的文章吧,希望能各位們能拋磚,共同學(xué)習(xí)......
不講廢話了,實(shí)踐才是硬道理.
第一部分:了解一下java1.5起默認(rèn)的三個(gè)annotation類型:
一個(gè)是@Override:只能用在方法之上的，用來(lái)告訴別人這一個(gè)方法是改寫(xiě)父類的。
一個(gè)是@Deprecated:建議別人不要使用舊的API的時(shí)候用的,編譯的時(shí)候會(huì)用產(chǎn)生警告信息,可以設(shè)定在程序里的所有的元素上.
一個(gè)是@SuppressWarnings:這一個(gè)類型可以來(lái)暫時(shí)把一些警告信息消息關(guān)閉.
如果不清楚上面三個(gè)類型的具體用法，各位可以baidu或google一下的,很簡(jiǎn)單的。
第二部分:講一下annotation的概念先，再來(lái)講一下怎樣設(shè)計(jì)自己的annotation.
首先在jdk自帶的java.lang.annotation包里,打開(kāi)如下幾個(gè)源文件:
1、源文件Target.java
代碼
- @Documented
- @Retention(RetentionPolicy.RUNTIME)
- @Target(ElementType.ANNOTATION_TYPE)
- public @interface Target {
- ElementType[] value();
- }
其中的@interface是一個(gè)關(guān)鍵字，在設(shè)計(jì)annotations的時(shí)候必須把一個(gè)類型定義為@interface，而不能用class或interface關(guān)鍵字(會(huì)不會(huì)覺(jué)得sun有點(diǎn)吝嗇,偏偏搞得與interface這么像).
2、源文件Retention.java
代碼
- @Documented
- @Retention(RetentionPolicy.RUNTIME)
- @Target(ElementType.ANNOTATION_TYPE)
- public @interface Retention {
- RetentionPolicy value();
- }
看到這里，大家可能都模糊了,都不知道在說(shuō)什么，別急，往下看一下.
在上面的文件都用到了RetentionPolicy，ElementType這兩個(gè)字段,你可能就會(huì)猜到這是兩個(gè)java文件.的確，這兩個(gè)文件的源代碼如下：
3、源文件RetentionPolicy.java
代碼
- public enum RetentionPolicy {
- SOURCE,
- CLASS,
- RUNTIME
- }
這是一個(gè)enum類型,共有三個(gè)值，分別是SOURCE,CLASS 和 RUNTIME.
SOURCE代表的是這個(gè)Annotation類型的信息只會(huì)保留在程序源碼里，源碼如果經(jīng)過(guò)了編譯之后，Annotation的數(shù)據(jù)就會(huì)消失,并不會(huì)保留在編譯好的.class文件里面。
ClASS的意思是這個(gè)Annotation類型的信息保留在程序源碼里,同時(shí)也會(huì)保留在編譯好的.class文件里面,在執(zhí)行的時(shí)候，并不會(huì)把這一些信息加載到虛擬機(jī)(JVM)中去.注意一下，當(dāng)你沒(méi)有設(shè)定一個(gè)Annotation類型的Retention值時(shí)，系統(tǒng)默認(rèn)值是CLASS.
第三個(gè),是RUNTIME,表示在源碼、編譯好的.class文件中保留信息，在執(zhí)行的時(shí)候會(huì)把這一些信息加載到JVM中去的．
舉一個(gè)例子，如@Override里面的Retention設(shè)為SOURCE,編譯成功了就不要這一些檢查的信息;相反,@Deprecated里面的Retention設(shè)為RUNTIME,表示除了在編譯時(shí)會(huì)警告我們使用了哪個(gè)被Deprecated的方法,在執(zhí)行的時(shí)候也可以查出該方法是否被Deprecated.
4、源文件ElementType.java
代碼
- public enum ElementType {
- TYPE, FIELD, METHOD, PARAMETER, CONSTRUCTOR,
- LOCAL_VARIABLE, ANNOTATION_TYPE,PACKAGE
- }
＠Target里面的ElementType是用來(lái)指定Annotation類型可以用在哪一些元素上的.說(shuō)明一下：TYPE(類型), FIELD(屬性), METHOD(方法), PARAMETER(參數(shù)), CONSTRUCTOR(構(gòu)造函數(shù)),LOCAL_VARIABLE(局部變量), ANNOTATION_TYPE,PACKAGE(包),其中的TYPE(類型)是指可以用在Class,Interface,Enum和Annotation類型上.
另外,從1的源代碼可以看出,@Target自己也用了自己來(lái)聲明自己,只能用在ANNOTATION_TYPE之上.
如果一個(gè)Annotation類型沒(méi)有指明@Target使用在哪些元素上,那么它可以使用在任何元素之上,這里的元素指的是上面的八種類型.
舉幾個(gè)正確的例子:
@Target(ElementType.METHOD)
@Target(value=ElementType.METHOD)
@Target(ElementType.METHOD,ElementType.CONSTRUCTOR)
具體參考一下javadoc文檔
上面一下1和2的源文件，它們都使用了@Documented,@Documented的目的就是讓這一個(gè)Annotation類型的信息能夠顯示在javaAPI說(shuō)明文檔上;沒(méi)有添加的話，使用javadoc生成API文檔的時(shí)候就會(huì)找不到這一個(gè)類型生成的信息.
另外一點(diǎn)，如果需要把Annotation的數(shù)據(jù)繼承給子類，那么就會(huì)用到@Inherited這一個(gè)Annotation類型.
第三部分:下面講的設(shè)計(jì)一個(gè)最簡(jiǎn)單的Annotation例子,這一例子共用四個(gè)文件;
1、Description.java
代碼
- package lighter.;
-
- 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();
- }
說(shuō)明:所有的Annotation會(huì)自動(dòng)繼承java.lang.annotation這一個(gè)接口,所以不能再去繼承別的類或是接口.
最重要的一點(diǎn),Annotation類型里面的參數(shù)該怎么設(shè)定:
第一,只能用public或默認(rèn)(default)這兩個(gè)訪問(wèn)權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型.
第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String.
第三,如果只有一個(gè)參數(shù)成員,參數(shù)名稱一定要為"value",后加小括號(hào).例:上面的例子就只胡一個(gè)參數(shù)成員.
2、Name.java
代碼
- package lighter.;
-
- 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.METHOD)
- @Retention(RetentionPolicy.RUNTIME)
- @Documented
- public @interface Name {
- String originate();
- String community();
- }
3、JavaEyer.java
代碼
- package lighter.;
-
- @Description("javaeye,做最棒的軟件開(kāi)發(fā)交流社區(qū)")
- public class JavaEyer {
- @Name(originate="創(chuàng)始人:robbin",community="javaEye")
- public String getName()
- {
- return null;
- }
-
- @Name(originate="創(chuàng)始人:江南白衣",community="springside")
- public String getName2()
- {
- return "借用兩位老大的id,寫(xiě)這一個(gè)例子,請(qǐng)見(jiàn)諒!";
- }
- }
4、最后，寫(xiě)一個(gè)可以運(yùn)行提取JavaEyer信息的類TestAnnotation
代碼
- package lighter.;
-
- import java.lang.reflect.Method;
- import java.util.HashSet;
- import java.util.Set;
-
- public class TestAnnotation {
-
-
-
-
- public static void main(String[] args) throws Exception {
- String CLASS_NAME = "lighter..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("-----------------");
- }
-
-
- 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("創(chuàng)建的社區(qū):"+name.community());
- }
- }
- }
5、運(yùn)行結(jié)果：
描述:javaeye,做最棒的軟件開(kāi)發(fā)交流社區(qū)
-----------------
創(chuàng)始人:robbin
創(chuàng)建的社區(qū):javaEye
創(chuàng)始人:江南白衣
創(chuàng)建的社區(qū):springside
這一篇文章寫(xiě)了兩個(gè)小時(shí)有多啦，也算是一篇關(guān)于設(shè)計(jì)自定的Annotation的入門(mén)篇啦；另外，特在處聲明，如果轉(zhuǎn)載請(qǐng)注明出處：http://lighter.。
參考資料:
1、http://java./j2se/1.5.0/docs/guide/language/annotations.html
2、http://caterpillar./Gossip/
3、http://calvin./blog/33210
|
