自Java5.0版本引入注解之后,它就成為了Java平臺(tái)中非常重要的一部分。開(kāi)發(fā)過(guò)程中,我們也時(shí)常在應(yīng)用代碼中會(huì)看到諸如@Override,@Deprecated這樣的注解。這篇文章中,我將向大家講述到底什么是注解,為什么要引入注解,注解是如何工作的,如何編寫(xiě)自定義的注解(通過(guò)例子),什么情況下可以使用注解以及最新注解和ADF(應(yīng)用開(kāi)發(fā)框架)。這會(huì)花點(diǎn)兒時(shí)間,所以為自己準(zhǔn)備一杯咖啡,讓我們來(lái)進(jìn)入注解的世界吧。
什么是注解?
用一個(gè)詞就可以描述注解,那就是元數(shù)據(jù),即一種描述數(shù)據(jù)的數(shù)據(jù)。所以,可以說(shuō)注解就是源代碼的元數(shù)據(jù)。比如,下面這段代碼:
1
2
3
4
|
@Override public String toString() { return "This is String Representation of current object." ; } |
上面的代碼中,我重寫(xiě)了toString()方法并使用了@Override注解。但是,即使我不使用@Override注解標(biāo)記代碼,程序也能夠正常執(zhí)行。那么,該注解表示什么?這么寫(xiě)有什么好處嗎?事實(shí)上,@Override告訴編譯器這個(gè)方法是一個(gè)重寫(xiě)方法(描述方法的元數(shù)據(jù)),如果父類(lèi)中不存在該方法,編譯器便會(huì)報(bào)錯(cuò),提示該方法沒(méi)有重寫(xiě)父類(lèi)中的方法。如果我不小心拼寫(xiě)錯(cuò)誤,例如將toString()寫(xiě)成了toStrring(){double r},而且我也沒(méi)有使用@Override注解,那程序依然能編譯運(yùn)行。但運(yùn)行結(jié)果會(huì)和我期望的大不相同。現(xiàn)在我們了解了什么是注解,并且使用注解有助于閱讀程序。
Annotation是一種應(yīng)用于類(lèi)、方法、參數(shù)、變量、構(gòu)造器及包聲明中的特殊修飾符。它是一種由JSR-175標(biāo)準(zhǔn)選擇用來(lái)描述元數(shù)據(jù)的一種工具。
為什么要引入注解?
使用Annotation之前(甚至在使用之后),XML被廣泛的應(yīng)用于描述元數(shù)據(jù)。不知何時(shí)開(kāi)始一些應(yīng)用開(kāi)發(fā)人員和架構(gòu)師發(fā)現(xiàn)XML的維護(hù)越來(lái)越糟糕了。他們希望使用一些和代碼緊耦合的東西,而不是像XML那樣和代碼是松耦合的(在某些情況下甚至是完全分離的)代碼描述。如果你在Google中搜索“XML vs. annotations”,會(huì)看到許多關(guān)于這個(gè)問(wèn)題的辯論。最有趣的是XML配置其實(shí)就是為了分離代碼和配置而引入的。上述兩種觀(guān)點(diǎn)可能會(huì)讓你很疑惑,兩者觀(guān)點(diǎn)似乎構(gòu)成了一種循環(huán),但各有利弊。下面我們通過(guò)一個(gè)例子來(lái)理解這兩者的區(qū)別。
假如你想為應(yīng)用設(shè)置很多的常量或參數(shù),這種情況下,XML是一個(gè)很好的選擇,因?yàn)樗粫?huì)同特定的代碼相連。如果你想把某個(gè)方法聲明為服務(wù),那么使用Annotation會(huì)更好一些,因?yàn)檫@種情況下需要注解和方法緊密耦合起來(lái),開(kāi)發(fā)人員也必須認(rèn)識(shí)到這點(diǎn)。
另一個(gè)很重要的因素是Annotation定義了一種標(biāo)準(zhǔn)的描述元數(shù)據(jù)的方式。在這之前,開(kāi)發(fā)人員通常使用他們自己的方式定義元數(shù)據(jù)。例如,使用標(biāo)記interfaces,注釋?zhuān)瑃ransient關(guān)鍵字等等。每個(gè)程序員按照自己的方式定義元數(shù)據(jù),而不像Annotation這種標(biāo)準(zhǔn)的方式。
目前,許多框架將XML和Annotation兩種方式結(jié)合使用,平衡兩者之間的利弊。
Annotation是如何工作的?怎么編寫(xiě)自定義的Annotation?
在講述這部分之前,建議你首先下載Annotation的示例代碼AnnotationsSample.zip 。下載之后放在你習(xí)慣使用的IDE中,這些代碼會(huì)幫助你更好的理解Annotation機(jī)制。
編寫(xiě)Annotation非常簡(jiǎn)單,可以將Annotation的定義同接口的定義進(jìn)行比較。我們來(lái)看兩個(gè)例子:一個(gè)是標(biāo)準(zhǔn)的注解@Override,另一個(gè)是用戶(hù)自定義注解@Todo。
1
2
3
4
|
@Target (ElementType.METHOD) @Retention (RetentionPolicy.SOURCE) public @interface Override { } |
對(duì)于@Override注釋你可能有些疑問(wèn),它什么都沒(méi)做,那它是如何檢查在父類(lèi)中有一個(gè)同名的函數(shù)呢。當(dāng)然,不要驚訝,我是逗你玩的。@Override注解的定義不僅僅只有這么一點(diǎn)代碼。這部分內(nèi)容很重要,我不得不再次重復(fù):Annotations僅僅是元數(shù)據(jù),和業(yè)務(wù)邏輯無(wú)關(guān)。理解起來(lái)有點(diǎn)困難,但就是這樣。如果Annotations不包含業(yè)務(wù)邏輯,那么必須有人來(lái)實(shí)現(xiàn)這些邏輯。元數(shù)據(jù)的用戶(hù)來(lái)做這個(gè)事情。Annotations僅僅提供它定義的屬性(類(lèi)/方法/包/域)的信息。Annotations的用戶(hù)(同樣是一些代碼)來(lái)讀取這些信息并實(shí)現(xiàn)必要的邏輯。
當(dāng)我們使用Java的標(biāo)注Annotations(例如@Override)時(shí),JVM就是一個(gè)用戶(hù),它在字節(jié)碼層面工作。到這里,應(yīng)用開(kāi)發(fā)人員還不能控制也不能使用自定義的注解。因此,我們講解一下如何編寫(xiě)自定義的Annotations。
我們來(lái)逐個(gè)講述編寫(xiě)自定義Annotations的要點(diǎn)。上面的例子中,你看到一些注解應(yīng)用在注解上。
J2SE5.0版本在 java.lang.annotation提供了四種元注解,專(zhuān)門(mén)注解其他的注解:
- @Documented –注解是否將包含在JavaDoc中
- @Retention –什么時(shí)候使用該注解
- @Target? –注解用于什么地方
- @Inherited – 是否允許子類(lèi)繼承該注解
@Documented–一個(gè)簡(jiǎn)單的Annotations標(biāo)記注解,表示是否將注解信息添加在java文檔中。
@Retention– 定義該注解的生命周期。
RetentionPolicy.SOURCE – 在編譯階段丟棄。這些注解在編譯結(jié)束之后就不再有任何意義,所以它們不會(huì)寫(xiě)入字節(jié)碼。@Override, @SuppressWarnings都屬于這類(lèi)注解。
RetentionPolicy.CLASS – 在類(lèi)加載的時(shí)候丟棄。在字節(jié)碼文件的處理中有用。注解默認(rèn)使用這種方式。
RetentionPolicy.RUNTIME– 始終不會(huì)丟棄,運(yùn)行期也保留該注解,因此可以使用反射機(jī)制讀取該注解的信息。我們自定義的注解通常使用這種方式。
@Target – 表示該注解用于什么地方。如果不明確指出,該注解可以放在任何地方。以下是一些可用的參數(shù)。需要說(shuō)明的是:屬性的注解是兼容的,如果你想給7個(gè)屬性都添加注解,僅僅排除一個(gè)屬性,那么你需要在定義target包含所有的屬性。
- ElementType.TYPE:用于描述類(lèi)、接口或enum聲明
- ElementType.FIELD:用于描述實(shí)例變量
- ElementType.METHOD
- ElementType.PARAMETER
- ElementType.CONSTRUCTOR
- ElementType.LOCAL_VARIABLE
- ElementType.ANNOTATION_TYPE 另一個(gè)注釋
- ElementType.PACKAGE 用于記錄java文件的package信息
@Inherited – 定義該注釋和子類(lèi)的關(guān)系
那么,注解的內(nèi)部到底是如何定義的呢?Annotations只支持基本類(lèi)型、String及枚舉類(lèi)型。注釋中所有的屬性被定義成方法,并允許提供默認(rèn)值。
1
2
3
4
5
6
7
8
9
|
@Target (ElementType.METHOD) @Retention (RetentionPolicy.RUNTIME) @interface Todo { public enum Priority {LOW, MEDIUM, HIGH} public enum Status {STARTED, NOT_STARTED} String author() default "Yash" ; Priority priority() default Priority.LOW; Status status() default Status.NOT_STARTED; } |
下面的例子演示了如何使用上面的注解。
1
2
3
4
5
|
@Todo (priority = Todo.Priority.MEDIUM, author = "Yashwant" , status = Todo.Status.STARTED) public void incompleteMethod1() { //Some business logic is written //But it's not complete yet } |
如果注解中只有一個(gè)屬性,可以直接命名為“value”,使用時(shí)無(wú)需再標(biāo)明屬性名。
1
2
3
4
5
6
|
@interface Author{ String value(); } @Author ( "Yashwant" ) public void someMethod() { } |
但目前為止一切看起來(lái)都還不錯(cuò)。我們定義了自己的注解并將其應(yīng)用在業(yè)務(wù)邏輯的方法上。現(xiàn)在我們需要寫(xiě)一個(gè)用戶(hù)程序調(diào)用我們的注解。這里我們需要使用反射機(jī)制。如果你熟悉反射代碼,就會(huì)知道反射可以提供類(lèi)名、方法和實(shí)例變量對(duì)象。所有這些對(duì)象都有g(shù)etAnnotation()這個(gè)方法用來(lái)返回注解信息。我們需要把這個(gè)對(duì)象轉(zhuǎn)換為我們自定義的注釋(使用 instanceOf()檢查之后),同時(shí)也可以調(diào)用自定義注釋里面的方法。看看以下的實(shí)例代碼,使用了上面的注解:
1
2
3
4
5
6
7
8
9
10
|
Class businessLogicClass = BusinessLogic. class ; for (Method method : businessLogicClass.getMethods()) { Todo todoAnnotation = (Todo)method.getAnnotation(Todo. class ); if (todoAnnotation != null ) { System.out.println( " Method Name : " + method.getName()); System.out.println( " Author : " + todoAnnotation.author()); System.out.println( " Priority : " + todoAnnotation.priority()); System.out.println( " Status : " + todoAnnotation.status()); } } |
注解用例
注解的功能很強(qiáng)大,Spring和Hebernate這些框架在日志和有效性中大量使用了注解功能。注解可以應(yīng)用在使用標(biāo)記接口的地方。不同的是標(biāo)記接口用來(lái)定義完整的類(lèi),但你可以為單個(gè)的方法定義注釋?zhuān)缡欠駥⒁粋€(gè)方法暴露為服務(wù)。
在最新的servlet3.0中引入了很多新的注解,尤其是和servlet安全相關(guān)的注解。
HandlesTypes –該注解用來(lái)表示一組傳遞給ServletContainerInitializer的應(yīng)用類(lèi)。
HttpConstraint – 該注解代表所有HTTP方法的應(yīng)用請(qǐng)求的安全約束,和ServletSecurity注釋中定義的HttpMethodConstraint安全約束不同。
HttpMethodConstraint – 指明不同類(lèi)型請(qǐng)求的安全約束,和ServletSecurity 注解中描述HTTP協(xié)議方法類(lèi)型的注釋不同。
MultipartConfig –該注解標(biāo)注在Servlet上面,表示該Servlet希望處理的請(qǐng)求的 MIME 類(lèi)型是 multipart/form-data。
ServletSecurity 該注解標(biāo)注在Servlet繼承類(lèi)上面,強(qiáng)制該HTTP協(xié)議請(qǐng)求遵循安全約束。
WebFilter – 該注解用來(lái)聲明一個(gè)Server過(guò)濾器;
WebInitParam – 該注解用來(lái)聲明Servlet或是過(guò)濾器的中的初始化參數(shù),通常配合 @WebServlet 或者 @WebFilter 使用。
WebListener –該注解為Web應(yīng)用程序上下文中不同類(lèi)型的事件聲明監(jiān)聽(tīng)器。
WebServlet –該注解用來(lái)聲明一個(gè)Servlet的配置。
ADF (應(yīng)用程序框架)和注解
現(xiàn)在我們開(kāi)始討論文章的最后一部分了。應(yīng)用程序框架,被稱(chēng)為ADF,由Oracle開(kāi)發(fā)用來(lái)創(chuàng)建Oracle融合應(yīng)用。我們已經(jīng)了解了注解的優(yōu)缺點(diǎn),也知道如何編寫(xiě)自定義的注解,但我們應(yīng)該將注解應(yīng)用在ADF的哪部分呢?ADF是否提供了一些樸素的注解?很好的問(wèn)題,確實(shí)在ADF中大量使用注解有一些限制。之前提到的應(yīng)用框架如Spring和Hibernate使用AOP(面向側(cè)面的程序設(shè)計(jì))。在AOP中,框架提供了一種機(jī)制,在事件的預(yù)處理和后續(xù)處理中注入代碼。例如:你有一個(gè)鉤子用來(lái)在方法執(zhí)行之前和之后添加代碼,所以你可以在這些地方編寫(xiě)你的用戶(hù)代碼。ADF不使用AOP。如果我們有任何注解的用例可用,我們可能需要通過(guò)繼承的方式實(shí)現(xiàn)。
希望你喜歡這篇文章,幫助大家更好的理解注解的意義!