打開注解的大門丧蘸，你準(zhǔn)備好了嗎？ OK， Let's Go !
注解一直是 Java 的一個(gè)非常重要的部分翅睛，它從 J2SE 5.0 開始就已經(jīng)存在了。在我們的應(yīng)用程序代碼中黑竞，經(jīng)巢斗ⅲ看到 @Override 和 @Deprecated 這樣的注解。在本文中很魂，我將討論注解到底是什么扎酷，為什么引入注解，它們是如何工作的遏匆，如何編寫自定義注解(有示例代碼)法挨，注解的有效場景是什么，最后是注解和 ADF拉岁。這將是一個(gè)很長的帖子坷剧，所以來一點(diǎn)咖啡，準(zhǔn)備好進(jìn)入注解的世界喊暖。
1. 注解是什么?
用一個(gè)詞來可以解釋：注解即是元數(shù)據(jù)惫企。元數(shù)據(jù)是關(guān)于數(shù)據(jù)的數(shù)據(jù)。所以注解是代碼的元數(shù)據(jù)陵叽。舉個(gè)例子狞尔，查看下面的代碼。
@Override
public String toString() {
return "This is String Representation of current object.";
}
我在以上代碼中重寫 toString() 方法時(shí)使用了 @Override 注解巩掺。即使我不使用 @Override偏序，代碼仍然能夠正常工作，沒有任何問題胖替。那么研儒，這個(gè)注解的優(yōu)點(diǎn)是什么？又代表了什么独令？@Override 告訴編譯器端朵，此方法是一個(gè)重寫的方法(有關(guān)該方法的元數(shù)據(jù))，如果父類中不存在此類方法燃箭，則引發(fā)編譯器錯(cuò)誤(超類中沒有被覆蓋其的方法)〕迥兀現(xiàn)在，如果我犯了一個(gè)排版錯(cuò)誤招狸，并使用方法名為 toStrring() {double r} 如果我沒有使用 @Override敬拓，我的代碼會(huì)成功地編譯和執(zhí)行邻薯，但是結(jié)果將會(huì)與預(yù)期不同。現(xiàn)在乘凸，我們理解了注解是什么厕诡，閱讀正式的定義是很有用處的。
注解是一種特殊的 Java 構(gòu)造翰意，用于修飾類木人、方法、字段冀偶、參數(shù)、變量渔嚷、構(gòu)造函數(shù)或包进鸠。這是 JSR-175 選擇的提供元數(shù)據(jù)的工具。
2. 為什么引入注解形病？
在注解出現(xiàn)之前(甚至之后)客年，XML 被廣泛地用于元數(shù)據(jù)，但是漠吻，一部分特定的應(yīng)用程序開發(fā)人員和架構(gòu)師認(rèn)為 XML 維護(hù)變得麻煩了量瓜。他們希望能夠通過某種方式與代碼緊密耦合，來代替 XML途乃，因?yàn)?XML 與代碼非常松散地耦合(在某些情況下绍傲，幾乎是獨(dú)立的)。如果你在谷歌上搜索 “XML vs annotations”耍共，你會(huì)發(fā)現(xiàn)很多有趣的爭論烫饼。有趣的一點(diǎn)是，XML配置是為了將配置從代碼中分離出來而引入的试读。最后兩種說法可能會(huì)在你的腦海中產(chǎn)生一些疑問杠纵，即這兩種說法都在創(chuàng)造一個(gè)循環(huán)，但兩者各有優(yōu)缺點(diǎn)钩骇。讓我們試著用一個(gè)例子來理解比藻。
假設(shè)您希望設(shè)置一些應(yīng)用程序范圍的常量/參數(shù)。在這個(gè)場景中倘屹，XML將是一個(gè)更好的選擇银亲，因?yàn)檫@與任何特定的代碼段無關(guān)。如果您希望將某些方法公開為服務(wù)唐瀑，那么注解將是一個(gè)更好的選擇群凶，因?yàn)樗枰c該方法緊密耦合，并且該方法的開發(fā)人員必須知道這一點(diǎn)哄辣。
另一個(gè)重要因素是注解定義了在代碼中定義元數(shù)據(jù)的標(biāo)準(zhǔn)方法请梢。在注解之前赠尾，人們還使用自己的方法來定義元數(shù)據(jù)。一些例子是使用標(biāo)記接口毅弧、注解气嫁、臨時(shí)關(guān)鍵字等。每個(gè)開發(fā)人員都需要根據(jù)自己的方式來決定元數(shù)據(jù)够坐，但是注解是標(biāo)準(zhǔn)化的東西寸宵。
如今，大多數(shù)框架都將XML和注解結(jié)合起來元咙，充分利用兩者的優(yōu)點(diǎn)梯影。
3.注解如何工作以及如何編寫自定義注解
在開始解釋之前，我建議您下載這個(gè)注釋(AnnotationsSample.zip) 的示例代碼庶香，并在您常用的 IDE 中保持打開甲棍，因?yàn)樗鼘椭玫乩斫庀旅娴慕忉尅?/p>
編寫注解非常簡單。您可以將注解定義與接口定義進(jìn)行比較赶掖。讓我們看兩個(gè)例子 — 一個(gè)是標(biāo)準(zhǔn) @Override 第二個(gè)注解是自定義注解感猛。@Todo:
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
似乎有些可疑之處 @Override 它沒有做任何事情 — 它只是檢查是否在父類中定義了一個(gè)方法。別驚訝奢赂，我不是在開玩笑陪白。重寫注解的定義只有那么多代碼。這是需要理解的最重要的部分膳灶，我重申一遍：注解只是元數(shù)據(jù)咱士，不包含任何業(yè)務(wù)邏輯。很難理解但卻是真的袖瞻。如果注解不包含邏輯司致，那么一定有人在做一些事情，并且有人是這個(gè)注解元數(shù)據(jù)的消費(fèi)者聋迎。注解只提供有關(guān)定義的屬性(類/方法/包/字段)的信息脂矫。消費(fèi)者是一段代碼，它讀取這些信息霉晕，然后執(zhí)行必要的邏輯庭再。
當(dāng)我們談?wù)摌?biāo)準(zhǔn)注解時(shí)，比如 @Override 牺堰， JVM 是使用者拄轻，它是在字節(jié)碼級(jí)別工作的。這是應(yīng)用程序開發(fā)人員無法控制伟葫、也不能用于自定義注解的東西恨搓。因此，我們需要為我們自己的注解寫一些消費(fèi)實(shí)例。
讓我們逐一理解用于編寫注解的關(guān)鍵術(shù)語斧抱。在上面的例子中常拓，您將看到注解如何被應(yīng)用。
J2SE 5.0 在 java.lang.annotation 包中提供了四個(gè)注解辉浦，它們僅在編寫注解時(shí)使用：
@Documented – 是否將注解放在 Javadocs 中
一個(gè)簡單的標(biāo)記注解弄抬，它標(biāo)識(shí)了是否將注解添加到 Javadoc 中。
@Retention – 注解什么時(shí)候被保留
定義應(yīng)保留注解的時(shí)間宪郊。
RetentionPolicy.SOURCE 在編譯期間丟棄掂恕。這些注解在編譯完成后沒有任何意義，因此它們不會(huì)被寫入字節(jié)碼弛槐。例子：@Override, @SuppressWarnings
RetentionPolicy.CLASS – 在類加載期間丟棄懊亡。應(yīng)用在進(jìn)行字節(jié)碼級(jí)別的編譯期間。有些令人驚訝的是乎串，這是默認(rèn)的斋配。
RetentionPolicy.RUNTIME – 不會(huì)丟棄。該注解可以在運(yùn)行時(shí)進(jìn)行反射灌闺。這是我們通常用于自定義注解的內(nèi)容。
@Target – 注解可以使用的地方
如果不指定這一屬性坏瞄，注解可以應(yīng)用在任何地方桂对。以下是該注解的有效值。這里的一個(gè)要點(diǎn)鸠匀，它只有包含的形式蕉斜，這意味著如果您想要對(duì)7個(gè)屬性進(jìn)行注解，并且只想排除一個(gè)屬性缀棍，這時(shí)需要在定義目標(biāo)時(shí)包含所有7個(gè)屬性宅此。
ElementType.TYPE (類，接口爬范，枚舉)
ElementType.FIELD (實(shí)例變量)
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE (用于其他注解)
ElementType.PACKAGE (記住 package-info.java)
@Inherited – 子類是否可以繼承注解父腕。
控制注解是否應(yīng)該影響子類。
現(xiàn)在青瀑，注解定義中包含了什么璧亮？注解只支持基本類型、字符串和枚舉斥难。注解的所有屬性都定義為方法枝嘶，并且還可以提供默認(rèn)值。
@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;
}
以下是如何使用上述注解的示例：
@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è)屬性哑诊，則應(yīng)該將其命名為 “value”群扶，并且可以在使用時(shí)不使用屬性名稱。
@interface Author{
String value();
}
@Author("Yashwant")
public void someMethod() {
}
目前為止一切順利。我們已經(jīng)定義了自定義注解竞阐，并將其應(yīng)用于一些業(yè)務(wù)邏輯方法〗煞梗現(xiàn)在，是時(shí)候?qū)懸粋€(gè)消費(fèi)的實(shí)例了馁菜。為了完成這個(gè)目標(biāo)茴扁，我們需要使用到反射。如果您熟悉反射代碼汪疮，那么您就知道反射提供了類峭火、方法和字段對(duì)象。所有這些對(duì)象都有一個(gè) getAnnotation() 方法智嚷，該方法返回注解對(duì)象卖丸。我們需要將此對(duì)象轉(zhuǎn)換為自定義注解(在使用 instanceOf() 檢查之后)，然后盏道，我們可以調(diào)用自定義注解中定義的方法稍浆。讓我們看一下示例代碼，它使用了上面的注解：
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());
}
}
4. 注解用例
注解非常的強(qiáng)大猜嘱，Spring 和 Hibernate 等框架非常廣泛地使用注解進(jìn)行日志記錄和驗(yàn)證衅枫。注解可以在使用標(biāo)記接口的地方使用。標(biāo)記接口用于整個(gè)類朗伶，但您可以定義可以用于單個(gè)方法的注解弦撩，例如，某個(gè)方法是否公開為服務(wù)方法论皆。
在 servlet 3.0 規(guī)范中益楼，引入了許多注解，特別是與 servlet 安全有關(guān)的注解点晴。我們先來看看幾個(gè)：
HandlesTypes - 此注解用于聲明傳遞給 ServletContainerInitializer 的應(yīng)用程序類數(shù)組感凤。
HttpConstraint - 此注解表示應(yīng)用于所有具有HTTP協(xié)議方法類型的請(qǐng)求的安全約束，在 ServletSecurity 上沒有相應(yīng)的 HttpMethodConstraint 注解時(shí)粒督。
HttpMethodConstraint - 特定的安全約束可以應(yīng)用于不同類型的請(qǐng)求陪竿，在 ServletSecurity 上注解。
MultipartConfig - 此注解用于指示聲明它的 servlet 將使用 multiPart/form-Data MIME 類型發(fā)出請(qǐng)求坠陈。
ServletSecurity - 在 servlet 實(shí)現(xiàn)類上聲明此注解萨惑，對(duì)HTTP協(xié)議請(qǐng)求執(zhí)行安全約束。
WebFilter - 用于聲明 servlet 過濾器的注解仇矾。
WebInitParam - 用于在 servlet 或過濾器上聲明初始化參數(shù)的注解庸蔼，在WebFilter 或 WebServlet 上注解。
WebListener - 用于在給定的Web應(yīng)用程序上下文中聲明各種類型事件的偵聽器的注解贮匕。
WebServlet - 此注解用于聲明 servlet 的配置姐仅。
5. 應(yīng)用程序開發(fā)框架(ADF，Application Development Framework)和注解
現(xiàn)在，我們正在討論的最后一部分：應(yīng)用程序開發(fā)框架（ADF）掏膏。ADF 由 Oracle 開發(fā)劳翰，用于構(gòu)建 Oracle 融合應(yīng)用程序。我們已經(jīng)看到了優(yōu)點(diǎn)和缺點(diǎn)馒疹，并且知道如何編寫自定義注解佳簸，但是在 ADF 中我們可以在哪里使用自定義注解呢？ADF 是否提供本地注解颖变？
這些無疑是有趣的問題：但是是否存在某些限制來阻止在 ADF 中大規(guī)模使用注解生均？前面提到的框架(如 Spring 和 Hibernate ) 使用的 AOP (面向方面的編程)。在 AOP 中腥刹，框架提供了為任何事件的預(yù)處理和后處理注入代碼的機(jī)制马胧。例如，您有一個(gè)鉤子在方法執(zhí)行之前和之后放置代碼衔峰，因此您可以在這些地方編寫自定義代碼佩脊。ADF 不使用 AOP。如果我們有任何有效的注解用例垫卤，我們可能需要通過繼承方式威彰。
