1河狐、Annotation的工作原理:
JDK5.0中提供了注解的功能舱馅,允許開發(fā)者定義和使用自己的注解類型积糯。該功能由一個定義注解類型的語法和描述一個注解聲明的語法,讀取注解的API护戳,一個使用注解修飾的class文件和一個注解處理工具組成。
Annotation并不直接影響代碼的語義垂睬,但是他可以被看做是程序的工具或者類庫灸异。它會反過來對正在運(yùn)行的程序語義有所影響。
Annotation可以沖源文件羔飞、class文件或者在運(yùn)行時通過反射機(jī)制多種方式被讀取肺樟。
2、@Override注解:
java.lang注釋類型 Override@Target(value=METHOD)@Retention(value=SOURCE)public @interfaceOverride
表示一個方法聲明打算重寫超類中的另一個方法聲明逻淌。如果方法利用此注釋類型進(jìn)行注解但沒有重寫超類方法么伯,則編譯器會生成一條錯誤消息。
@Override注解表示子類要重寫父類的對應(yīng)方法卡儒。
Override是一個Marker annotation田柔,用于標(biāo)識的Annotation,Annotation名稱本身表示了要給工具程序的信息骨望。
下面是一個使用@Override注解的例子:
classA {privateString id;? ? A(String id){this.id = id;? ? }@OverridepublicString toString() {returnid;? ? }}
3硬爆、@Deprecated注解:
java.lang注釋類型 Deprecated@Documented@Retention(value=RUNTIME)public @interfaceDeprecated
用 @Deprecated 注釋的程序元素,不鼓勵程序員使用這樣的元素擎鸠,通常是因?yàn)樗芪kU或存在更好的選擇缀磕。在使用不被贊成的程序元素或在不被贊成的代碼中執(zhí)行重寫時,編譯器會發(fā)出警告。
@Deprecated注解表示方法是不被建議使用的袜蚕。
Deprecated是一個Marker annotation糟把。
下面是一個使用@Deprecated注解的例子:
classA?
{
privateString id;? ? A(String id){this.id = id;? ? }@Deprecatedpublicvoidexecute(){? ? ? ? System.out.println(id);? ? }publicstaticvoidmain(String[] args) {? ? ? ? A a =newA("a123");? ? ? ? a.execute();? ? }}
4、@SuppressWarnings注解:
java.lang注釋類型 SuppressWarnings@Target(value={TYPE,FIELD,METHOD,PARAMETER,CONSTRUCTOR,LOCAL_VARIABLE})@Retention(value=SOURCE)public @interfaceSuppressWarnings
指示應(yīng)該在注釋元素(以及包含在該注釋元素中的所有程序元素)中取消顯示指定的編譯器警告牲剃。注意遣疯,在給定元素中取消顯示的警告集是所有包含元素中取消顯示的警告的超集。例如凿傅,如果注釋一個類來取消顯示某個警告缠犀,同時注釋一個方法來取消顯示另一個警告,那么將在此方法中同時取消顯示這兩個警告聪舒。
根據(jù)風(fēng)格不同夭坪,程序員應(yīng)該始終在最里層的嵌套元素上使用此注釋,在那里使用才有效过椎。如果要在特定的方法中取消顯示某個警告室梅,則應(yīng)該注釋該方法而不是注釋它的類。
@SuppressWarnings注解表示抑制警告疚宇。
下面是一個使用@SuppressWarnings注解的例子:
@SuppressWarnings("unchecked")publicstaticvoidmain(String[] args) {? ? List list =newArrayList();? ? list.add("abc");}
5亡鼠、自定義注解:
使用@interface自定義注解時,自動繼承了java.lang.annotation.Annotation接口敷待,由編譯程序自動完成其他細(xì)節(jié)间涵。在定義注解時,不能繼承其他的注解或接口榜揖。
自定義最簡單的注解:
public@interfaceMyAnnotation {}
使用自定義注解:
publicclassAnnotationTest2 {@MyAnnotationpublicvoidexecute(){? ? ? ? System.out.println("method");? ? }}
5.1勾哩、添加變量:
public@interfaceMyAnnotation {? ? String value1();}
使用自定義注解:
publicclassAnnotationTest2 {@MyAnnotation(value1="abc")publicvoidexecute(){? ? ? ? System.out.println("method");? ? }}
當(dāng)注解中使用的屬性名為value時,對其賦值時可以不指定屬性的名稱而直接寫上屬性值接口举哟;除了value意外的變量名都需要使用name=value的方式賦值思劳。
5.2、添加默認(rèn)值:
public@interfaceMyAnnotation {? ? String value1()default"abc";}
5.3妨猩、多變量使用枚舉:
public@interfaceMyAnnotation {? ? String value1()default"abc";? ? MyEnum value2()defaultMyEnum.Sunny;}enum MyEnum{? ? Sunny,Rainy}
使用自定義注解:
publicclassAnnotationTest2 {@MyAnnotation(value1="a", value2=MyEnum.Sunny)publicvoidexecute(){? ? ? ? System.out.println("method");? ? }}
5.4潜叛、數(shù)組變量:
public@interfaceMyAnnotation {? ? String[] value1()default"abc";}
使用自定義注解:
publicclassAnnotationTest2 {@MyAnnotation(value1={"a","b"})publicvoidexecute(){? ? ? ? System.out.println("method");? ? }}
6、設(shè)置注解的作用范圍:
@Documented@Retention(value=RUNTIME)@Target(value=ANNOTATION_TYPE)public @interfaceRetention
指示注釋類型的注釋要保留多久壶硅。如果注釋類型聲明中不存在 Retention 注釋威兜,則保留策略默認(rèn)為 RetentionPolicy.CLASS。
只有元注釋類型直接用于注釋時庐椒,Target 元注釋才有效椒舵。如果元注釋類型用作另一種注釋類型的成員,則無效约谈。
public enumRetentionPolicyextends Enum
注釋保留策略笔宿。此枚舉類型的常量描述保留注釋的不同策略犁钟。它們與 Retention 元注釋類型一起使用,以指定保留多長的注釋措伐。
CLASS編譯器將把注釋記錄在類文件中特纤,但在運(yùn)行時 VM 不需要保留注釋军俊。RUNTIME編譯器將把注釋記錄在類文件中侥加,在運(yùn)行時 VM 將保留注釋,因此可以反射性地讀取粪躬。SOURCE編譯器要丟棄的注釋担败。
@Retention注解可以在定義注解時為編譯程序提供注解的保留策略。
屬于CLASS保留策略的注解有@SuppressWarnings镰官,該注解信息不會存儲于.class文件提前。
6.1、在自定義注解中的使用例子:
@Retention(RetentionPolicy.CLASS)public@interfaceMyAnnotation {? ? String[] value1()default"abc";}
7泳唠、使用反射讀取RUNTIME保留策略的Annotation信息的例子:
java.lang.reflect? ? ? ? 接口AnnotatedElement所有已知實(shí)現(xiàn)類:? ? ? ? AccessibleObject, Class, Constructor, Field, Method, Package
表示目前正在此 VM 中運(yùn)行的程序的一個已注釋元素狈网。該接口允許反射性地讀取注釋。由此接口中的方法返回的所有注釋都是不可變并且可序列化的笨腥。調(diào)用者可以修改已賦值數(shù)組枚舉成員的訪問器返回的數(shù)組拓哺;這不會對其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響。
如果此接口中的方法返回的注釋(直接或間接地)包含一個已賦值的 Class 成員脖母,該成員引用了一個在此 VM 中不可訪問的類士鸥,則試圖通過在返回的注釋上調(diào)用相關(guān)的類返回的方法來讀取該類,將導(dǎo)致一個 TypeNotPresentException谆级。
isAnnotationPresentbooleanisAnnotationPresent(Class annotationClass)
如果指定類型的注釋存在于此元素上烤礁,則返回 true,否則返回 false肥照。此方法主要是為了便于訪問標(biāo)記注釋而設(shè)計(jì)的脚仔。
參數(shù):
annotationClass - 對應(yīng)于注釋類型的 Class 對象
返回:
如果指定注釋類型的注釋存在于此對象上,則返回 true舆绎,否則返回 false
拋出:
NullPointerException - 如果給定的注釋類為 null
從以下版本開始:
1.5
getAnnotation TgetAnnotation(Class annotationClass)
如果存在該元素的指定類型的注釋玻侥,則返回這些注釋,否則返回 null亿蒸。
參數(shù):
annotationClass - 對應(yīng)于注釋類型的 Class 對象
返回:
如果該元素的指定注釋類型的注釋存在于此對象上凑兰,則返回這些注釋,否則返回 null
拋出:
NullPointerException - 如果給定的注釋類為 null
從以下版本開始:
1.5
getAnnotationsAnnotation[]getAnnotations()
返回此元素上存在的所有注釋边锁。(如果此元素沒有注釋姑食,則返回長度為零的數(shù)組。)該方法的調(diào)用者可以隨意修改返回的數(shù)組茅坛;這不會對其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響音半。
返回:
此元素上存在的所有注釋
從以下版本開始:
1.5
getDeclaredAnnotationsAnnotation[]getDeclaredAnnotations()
返回直接存在于此元素上的所有注釋则拷。與此接口中的其他方法不同,該方法將忽略繼承的注釋曹鸠。(如果沒有注釋直接存在于此元素上煌茬,則返回長度為零的一個數(shù)組。)該方法的調(diào)用者可以隨意修改返回的數(shù)組彻桃;這不會對其他調(diào)用者返回的數(shù)組產(chǎn)生任何影響坛善。
返回:
直接存在于此元素上的所有注釋
從以下版本開始:
1.5
下面是使用反射讀取RUNTIME保留策略的Annotation信息的例子:
自定義注解:
@Retention(RetentionPolicy.RUNTIME)public@interfaceMyAnnotation {? ? String[] value1()default"abc";}
使用自定義注解:
publicclassAnnotationTest2 {@MyAnnotation(value1={"a","b"})@Deprecatedpublicvoidexecute(){? ? ? ? System.out.println("method");? ? }}
讀取注解中的信息:
publicstaticvoidmain(String[] args)throwsSecurityException, NoSuchMethodException, IllegalArgumentException, IllegalAccessException, InvocationTargetException {? ? AnnotationTest2 annotationTest2 =newAnnotationTest2();//獲取AnnotationTest2的Class實(shí)例Class c = AnnotationTest2.class;//獲取需要處理的方法Method實(shí)例Method method = c.getMethod("execute",newClass[]{});//判斷該方法是否包含MyAnnotation注解if(method.isAnnotationPresent(MyAnnotation.class)){//獲取該方法的MyAnnotation注解實(shí)例MyAnnotation myAnnotation = method.getAnnotation(MyAnnotation.class);//執(zhí)行該方法method.invoke(annotationTest2,newObject[]{});//獲取myAnnotationString[] value1 = myAnnotation.value1();? ? ? ? System.out.println(value1[0]);? ? }//獲取方法上的所有注解Annotation[] annotations = method.getAnnotations();for(Annotation annotation : annotations){? ? ? ? System.out.println(annotation);? ? }}
8、限定注解的使用:
限定注解使用@Target邻眷。
@Documented@Retention(value=RUNTIME)@Target(value=ANNOTATION_TYPE)public @interfaceTarget
指示注釋類型所適用的程序元素的種類眠屎。如果注釋類型聲明中不存在 Target 元注釋,則聲明的類型可以用在任一程序元素上肆饶。如果存在這樣的元注釋改衩,則編譯器強(qiáng)制實(shí)施指定的使用限制。 例如驯镊,此元注釋指示該聲明類型是其自身葫督,即元注釋類型。它只能用在注釋類型聲明上:
@Target(ElementType.ANNOTATION_TYPE)public@interfaceMetaAnnotationType {? ? ? ? ...? ? }
此元注釋指示該聲明類型只可作為復(fù)雜注釋類型聲明中的成員類型使用板惑。它不能直接用于注釋:
@Target({})public@interfaceMemberType {? ? ? ? ...? ? }
這是一個編譯時錯誤橄镜,它表明一個 ElementType 常量在 Target 注釋中出現(xiàn)了不只一次。例如洒放,以下元注釋是非法的:
@Target({ElementType.FIELD, ElementType.METHOD, ElementType.FIELD})public@interfaceBogus {? ? ? ? ...? ? }
public enumElementTypeextends Enum
程序元素類型蛉鹿。此枚舉類型的常量提供了 Java 程序中聲明的元素的簡單分類。
這些常量與 Target 元注釋類型一起使用往湿,以指定在什么情況下使用注釋類型是合法的妖异。
ANNOTATION_TYPE注釋類型聲明CONSTRUCTOR構(gòu)造方法聲明FIELD字段聲明(包括枚舉常量)LOCAL_VARIABLE局部變量聲明METHOD方法聲明PACKAGE包聲明PARAMETER參數(shù)聲明TYPE類、接口(包括注釋類型)或枚舉聲明
注解的使用限定的例子:
@Target(ElementType.METHOD)public@interfaceMyAnnotation {? ? String[] value1()default"abc";}
9领追、在幫助文檔中加入注解:
要想在制作JavaDoc文件的同時將注解信息加入到API文件中他膳,可以使用java.lang.annotation.Documented。
在自定義注解中聲明構(gòu)建注解文檔:
@Documentedpublic@interfaceMyAnnotation {? ? String[] value1()default"abc";}
使用自定義注解:
publicclassAnnotationTest2 {@MyAnnotation(value1={"a","b"})publicvoidexecute(){? ? ? ? System.out.println("method");? ? }}
10绒窑、在注解中使用繼承:
默認(rèn)情況下注解并不會被繼承到子類中棕孙,可以在自定義注解時加上java.lang.annotation.Inherited注解聲明使用繼承些膨。
@Documented@Retention(value=RUNTIME)@Target(value=ANNOTATION_TYPE)public @interfaceInherited
指示注釋類型被自動繼承蟀俊。如果在注釋類型聲明中存在 Inherited 元注釋,并且用戶在某一類聲明中查詢該注釋類型订雾,同時該類聲明中沒有此類型的注釋肢预,則將在該類的超類中自動查詢該注釋類型。此過程會重復(fù)進(jìn)行洼哎,直到找到此類型的注釋或到達(dá)了該類層次結(jié)構(gòu)的頂層 (Object) 為止烫映。如果沒有超類具有該類型的注釋沼本,則查詢將指示當(dāng)前類沒有這樣的注釋。
注意锭沟,如果使用注釋類型注釋類以外的任何事物抽兆,此元注釋類型都是無效的。還要注意族淮,此元注釋僅促成從超類繼承注釋辫红;對已實(shí)現(xiàn)接口的注釋無效。