Java注解提供了關(guān)于代碼的一些信息，但并不直接作用于它所注解的代碼內(nèi)容。在這個(gè)教程當(dāng)中，我們將學(xué)習(xí)Java的注解，如何定制注解，注解的使用以及如何通過(guò)反射解析注解。
Java1.5引入了注解，當(dāng)前許多java框架中大量使用注解，如hibernate、Jersey、spring。注解作為程序的元數(shù)據(jù)嵌入到程序當(dāng)中。注解可以被一些解析工具或者是編譯工具進(jìn)行解析。我們也可以聲明注解在編譯過(guò)程或執(zhí)行時(shí)產(chǎn)生作用。
在使用注解之前，程序源數(shù)據(jù)只是通過(guò)java注釋和javadoc，但是注解提供的功能要遠(yuǎn)遠(yuǎn)超過(guò)這些。注解不僅包含了元數(shù)據(jù)，它還可以作用于程序運(yùn)行過(guò)程中、注解解釋器可以通過(guò)注解決定程序的執(zhí)行順序。例如，在Jersey webservice 我們?yōu)榉椒ㄌ砑覷RI字符串的形式的**PATH**注解，那么在程序運(yùn)行過(guò)程中jerser解釋程序?qū)Q定該方法去調(diào)用所給的URI。
創(chuàng)建Java自定義注解
創(chuàng)建自定義注解和創(chuàng)建一個(gè)接口相似，但是注解的interface關(guān)鍵字需要以@符號(hào)開頭。我們可以為注解聲明方法。我們先來(lái)看看注解的例子，然后我們將討論他的一些特性。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
package com.journaldev.annotations; import java.lang.annotation.Documented;import java.lang.annotation.ElementType;import java.lang.annotation.Inherited;import java.lang.annotation.Retention;import java.lang.annotation.RetentionPolicy;import java.lang.annotation.Target; @Documented@Target(ElementType.METHOD)@Inherited@Retention(RetentionPolicy.RUNTIME) public @interface MethodInfo{ String author() default 'Pankaj'; String date(); int revision() default 1; String comments();} |
- 注解方法不能帶有參數(shù)；
- 注解方法返回值類型限定為：基本類型、String、Enums、Annotation或者是這些類型的數(shù)組；
- 注解方法可以有默認(rèn)值；
- 注解本身能夠包含元注解，元注解被用來(lái)注解其它注解。
這里有四種類型的元注解：
1. @Documented —— 指明擁有這個(gè)注解的元素可以被javadoc此類的工具文檔化。這種類型應(yīng)該用于注解那些影響客戶使用帶注釋的元素聲明的類型。如果一種聲明使用Documented進(jìn)行注解，這種類型的注解被作為被標(biāo)注的程序成員的公共API。
2. @Target——指明該類型的注解可以注解的程序元素的范圍。該元注解的取值可以為TYPE,METHOD,CONSTRUCTOR,FIELD等。如果Target元注解沒(méi)有出現(xiàn)，那么定義的注解可以應(yīng)用于程序的任何元素。
3. @Inherited——指明該注解類型被自動(dòng)繼承。如果用戶在當(dāng)前類中查詢這個(gè)元注解類型并且當(dāng)前類的聲明中不包含這個(gè)元注解類型，那么也將自動(dòng)查詢當(dāng)前類的父類是否存在Inherited元注解，這個(gè)動(dòng)作將被重復(fù)執(zhí)行知道這個(gè)標(biāo)注類型被找到，或者是查詢到頂層的父類。
4.@Retention——指明了該Annotation被保留的時(shí)間長(zhǎng)短。RetentionPolicy取值為SOURCE,CLASS,RUNTIME。
Java內(nèi)建注解
Java提供了三種內(nèi)建注解。
1. @Override——當(dāng)我們想要復(fù)寫父類中的方法時(shí)，我們需要使用該注解去告知編譯器我們想要復(fù)寫這個(gè)方法。這樣一來(lái)當(dāng)父類中的方法移除或者發(fā)生更改時(shí)編譯器將提示錯(cuò)誤信息。
2. @Deprecated——當(dāng)我們希望編譯器知道某一方法不建議使用時(shí)，我們應(yīng)該使用這個(gè)注解。Java在javadoc 中推薦使用該注解，我們應(yīng)該提供為什么該方法不推薦使用以及替代的方法。
3. @SuppressWarnings——這個(gè)僅僅是告訴編譯器忽略特定的警告信息，例如在泛型中使用原生數(shù)據(jù)類型。它的保留策略是SOURCE（譯者注：在源文件中有效）并且被編譯器丟棄。
我們來(lái)看一個(gè)java內(nèi)建注解的例子參照上邊提到的自定義注解。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
|
package com.journaldev.annotations; import java.io.FileNotFoundException;import java.util.ArrayList;import java.util.List; public class AnnotationExample { public static void main(String[] args) {} @Override@MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 1)public String toString() { return 'Overriden toString method';} @Deprecated@MethodInfo(comments = 'deprecated method', date = 'Nov 17 2012')public static void oldMethod() { System.out.println('old method, don't use it.');} @SuppressWarnings({ 'unchecked', 'deprecation' })@MethodInfo(author = 'Pankaj', comments = 'Main method', date = 'Nov 17 2012', revision = 10)public static void genericsTest() throws FileNotFoundException { List l = new ArrayList(); l.add('abc'); oldMethod();} } |
相信這個(gè)例子可以不言自明并能展示在不同場(chǎng)景下的應(yīng)用。
Java注解解析
我們將使用反射技術(shù)來(lái)解析java類的注解。那么注解的RetentionPolicy應(yīng)該設(shè)置為RUNTIME否則java類的注解信息在執(zhí)行過(guò)程中將不可用那么我們也不能從中得到任何和注解有關(guān)的數(shù)據(jù)。
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
|
package com.journaldev.annotations; import java.lang.annotation.Annotation;import java.lang.reflect.Method; public class AnnotationParsing { public static void main(String[] args) { try { for (Method method : AnnotationParsing.class .getClassLoader() .loadClass(('com.journaldev.annotations.AnnotationExample')) .getMethods()) { // checks if MethodInfo annotation is present for the method if (method.isAnnotationPresent(com.journaldev.annotations.MethodInfo.class)) { try { // iterates all the annotations available in the method for (Annotation anno : method.getDeclaredAnnotations()) { System.out.println('Annotation in Method ''+ method + '' : ' + anno); } MethodInfo methodAnno = method.getAnnotation(MethodInfo.class); if (methodAnno.revision() == 1) { System.out.println('Method with revision no 1 = '+ method); } } catch (Throwable ex) { ex.printStackTrace(); } } } } catch (SecurityException | ClassNotFoundException e) { e.printStackTrace(); } } } |
運(yùn)行上面程序?qū)⑤敵觯?/p>
|
1
2
3
4
5
6
7
|
Annotation in Method 'public java.lang.String com.journaldev.annotations.AnnotationExample.toString()' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=Main method, date=Nov 17 2012)Method with revision no 1 = public java.lang.String com.journaldev.annotations.AnnotationExample.toString()Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @java.lang.Deprecated()Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.oldMethod()' : @com.journaldev.annotations.MethodInfo(author=Pankaj, revision=1, comments=deprecated method, date=Nov 17 2012)Method with revision no 1 = public static void com.journaldev.annotations.AnnotationExample.oldMethod()Annotation in Method 'public static void com.journaldev.annotations.AnnotationExample.genericsTest |
以上就是java 自定義注解的實(shí)例詳解，如有疑問(wèn)請(qǐng)留言或者到本站社區(qū)交流討論，感謝閱讀，希望能幫助到大家，謝謝大家對(duì)本站的支持！
原文鏈接：http://blog.csdn.net/zmx729618/article/details/73163438
