java:注解(Annotation)自定義注解入門
why give up treatment?
應(yīng)用場(chǎng)景:框架(controller,service,dao,注入)等捌省,需要對(duì)類,屬性碉钠,方法纲缓,夠造器卷拘,進(jìn)行特殊標(biāo)識(shí),進(jìn)行特殊處理祝高。
元注解:
元注解的作用就是負(fù)責(zé)注解其他注解栗弟。java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型,它們被用來提供對(duì)其它annotation類型作說明工闺。java5.0定義的元注解:
@Target乍赫,
@Retention
@Ducumented
-
@Inherited
這些類型和它們所支持的類在java.lang.annotation包中可以找到。
使用說明:
@Target:
@Target說明了Annotation所修飾的對(duì)象范圍:Annotation可被用于packages陆蟆,type(類雷厂,接口,枚舉遍搞,Annotation)罗侯,類型成員(方法、構(gòu)造方法溪猿、成員變量、枚舉值)纫塌、方法參數(shù)和本地變量(如循環(huán)變量诊县、catch參數(shù))。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)措左。
作用:用于描述注解的使用范圍(即:被描述的注解可以用在什么地方)
取值(ElementType)有:
1.CONSTRUCTOR:用于描述構(gòu)造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部變量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述參數(shù)
7.TYPE:用于描述類依痊、接口(包括注解類型) 或enum聲明
@Retention:
@Retention定義了該Annotation被保留的時(shí)間長短:某些Annotation僅出現(xiàn)在源代碼中,而被編譯器丟棄怎披;而另一些卻被編譯在class文件中胸嘁;編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略,而另一些在class被裝載時(shí)將被讀攘构洹(請(qǐng)注意并不影響class的執(zhí)行性宏,因?yàn)锳nnotation與class在使用上是被分離的)。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制状飞。
作用:表示需要在什么級(jí)別保存該注釋信息毫胜,用于描述注解的生命周期(即:被描述的注解在什么范圍內(nèi)有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在運(yùn)行時(shí)有效(即運(yùn)行時(shí)保留)
Retention meta-annotation類型有唯一的value作為成員,它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值诬辈。
@Documented:
@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API酵使,因此可以被例如javadoc此類的工具文檔化。Documented是一個(gè)標(biāo)記注解焙糟,沒有成員口渔。
@Inherited:
@Inherited 元注解是一個(gè)標(biāo)記注解,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的穿撮。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class缺脉,則這個(gè)annotation將被用于該class的子類痪欲。
注意:@Inherited annotation類型是被標(biāo)注過的class的子類所繼承。類并不從它所實(shí)現(xiàn)的接口繼承annotation枪向,方法并不從它所重載的方法繼承annotation勤揩。
當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME,則反射API增強(qiáng)了這種繼承性秘蛔。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)陨亡,反射代碼檢查將展開工作:檢查class和其父類,直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)深员,或者到達(dá)類繼承結(jié)構(gòu)的頂層负蠕。
自定義注解:
使用@interface自定義注解時(shí),自動(dòng)繼承了java.lang.annotation.Annotation接口倦畅,由編譯程序自動(dòng)完成其他細(xì)節(jié)遮糖。在定義注解時(shí),不能繼承其他的注解或接口叠赐。@interface用來聲明一個(gè)注解欲账,其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱芭概,返回值類型就是參數(shù)的類型(返回值類型只能是基本類型赛不、Class、String罢洲、enum)踢故。可以通過default來聲明參數(shù)的默認(rèn)值惹苗。
定義注解格式:
public @interface 注解名 {定義體}
注解參數(shù)的可支持?jǐn)?shù)據(jù)類型:
1.所有基本數(shù)據(jù)類型(int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數(shù)組
Annotation類型里面的參數(shù)該怎么設(shè)定:
- 只能用public或默認(rèn)(default)這兩個(gè)訪問權(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ù)名稱設(shè)為"value",后加小括號(hào).例:下面的例子FruitName注解就只有一個(gè)參數(shù)成員。
例:
package realize.core.annotation;
import java.lang.annotation.*;
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Route {
String value();
}