Java中的註解是如何工作的

• 什麼是註解？

• 爲什麼要引入註解？

• Annotation是如何工作的？怎麼編寫自定義的Annotation？

• 註解用例

• ADF (應用程序框架)和註解

自Java5.0版本引入註解之後，它就成爲了Java平臺中非常重要的一部分。開發過程中，我們也時常在應用代碼中會看到諸如@Override，@Deprecated這樣的註解。這篇文章中，我將向大家講述到底什麼是註解，爲什麼要引入註解，註解是如何工作的，如何編寫自定義的註解(通過例子)，什麼情況下可以使用註解以及最新註解和ADF(應用開發框架)。這會花點兒時間，所以爲自己準備一杯咖啡，讓我們來進入註解的世界吧。

什麼是註解？

用一個詞就可以描述註解，那就是元數據，即一種描述數據的數據。所以，可以說註解就是源代碼的元數據。比如，下面這段代碼：

1 2 3 4

@Override public String toString() {     return "This is String Representation of current object."; }

上面的代碼中，我重寫了toString()方法並使用了@Override註解。但是，即使我不使用@Override註解標記代碼，程序也能夠正常執行。那麼，該註解表示什麼？這麼寫有什麼好處嗎？事實上，@Override告訴編譯器這個方法是一個重寫方法(描述方法的元數據)，如果父類中不存在該方法，編譯器便會報錯，提示該方法沒有重寫父類中的方法。如果我不小心拼寫錯誤，例如將toString()寫成了toStrring(){double r}，而且我也沒有使用@Override註解，那程序依然能編譯運行。但運行結果會和我期望的大不相同。現在我們瞭解了什麼是註解，並且使用註解有助於閱讀程序。

Annotation是一種應用於類、方法、參數、變量、構造器及包聲明中的特殊修飾符。它是一種由JSR-175標準選擇用來描述元數據的一種工具。

爲什麼要引入註解？

使用Annotation之前(甚至在使用之後)，XML被廣泛的應用於描述元數據。不知何時開始一些應用開發人員和架構師發現XML的維護越來越糟糕了。他們希望使用一些和代碼緊耦合的東西，而不是像XML那樣和代碼是鬆耦合的(在某些情況下甚至是完全分離的)代碼描述。如果你在Google中搜索“XML vs. annotations”，會看到許多關於這個問題的辯論。最有趣的是XML配置其實就是爲了分離代碼和配置而引入的。上述兩種觀點可能會讓你很疑惑，兩者觀點似乎構成了一種循環，但各有利弊。下面我們通過一個例子來理解這兩者的區別。

假如你想爲應用設置很多的常量或參數，這種情況下，XML是一個很好的選擇，因爲它不會同特定的代碼相連。如果你想把某個方法聲明爲服務，那麼使用Annotation會更好一些，因爲這種情況下需要註解和方法緊密耦合起來，開發人員也必須認識到這點。

另一個很重要的因素是Annotation定義了一種標準的描述元數據的方式。在這之前，開發人員通常使用他們自己的方式定義元數據。例如，使用標記interfaces，註釋，transient關鍵字等等。每個程序員按照自己的方式定義元數據，而不像Annotation這種標準的方式。

目前，許多框架將XML和Annotation兩種方式結合使用，平衡兩者之間的利弊。

Annotation是如何工作的？怎麼編寫自定義的Annotation？

在講述這部分之前，建議你首先下載Annotation的示例代碼AnnotationsSample.zip 。下載之後放在你習慣使用的IDE中，這些代碼會幫助你更好的理解Annotation機制。

編寫Annotation非常簡單，可以將Annotation的定義同接口的定義進行比較。我們來看兩個例子：一個是標準的註解@Override，另一個是用戶自定義註解@Todo。

1 2 3 4

@Target(ElementType.METHOD) @Retention(RetentionPolicy.SOURCE) public @interface Override { }

對於@Override註釋你可能有些疑問，它什麼都沒做，那它是如何檢查在父類中有一個同名的函數呢。當然，不要驚訝，我是逗你玩的。@Override註解的定義不僅僅只有這麼一點代碼。這部分內容很重要，我不得不再次重複：Annotations僅僅是元數據，和業務邏輯無關。理解起來有點困難，但就是這樣。如果Annotations不包含業務邏輯，那麼必須有人來實現這些邏輯。元數據的用戶來做這個事情。Annotations僅僅提供它定義的屬性(類/方法/包/域)的信息。Annotations的用戶(同樣是一些代碼)來讀取這些信息並實現必要的邏輯。

當我們使用Java的標註Annotations(例如@Override)時，JVM就是一個用戶，它在字節碼層面工作。到這裏，應用開發人員還不能控制也不能使用自定義的註解。因此，我們講解一下如何編寫自定義的Annotations。

我們來逐個講述編寫自定義Annotations的要點。上面的例子中，你看到一些註解應用在註解上。

J2SE5.0版本在 java.lang.annotation提供了四種元註解，專門註解其他的註解：

@Documented –註解是否將包含在JavaDoc中
@Retention –什麼時候使用該註解
@Target –註解用於什麼地方
@Inherited – 是否允許子類繼承該註解

@Documented–一個簡單的Annotations標記註解，表示是否將註解信息添加在java文檔中。

@Retention– 定義該註解的生命週期。

RetentionPolicy.SOURCE – 在編譯階段丟棄。這些註解在編譯結束之後就不再有任何意義，所以它們不會寫入字節碼。@Override, @SuppressWarnings都屬於這類註解。

RetentionPolicy.CLASS – 在類加載的時候丟棄。在字節碼文件的處理中有用。註解默認使用這種方式。

RetentionPolicy.RUNTIME– 始終不會丟棄，運行期也保留該註解，因此可以使用反射機制讀取該註解的信息。我們自定義的註解通常使用這種方式。

@Target – 表示該註解用於什麼地方。如果不明確指出，該註解可以放在任何地方。以下是一些可用的參數。需要說明的是：屬性的註解是兼容的，如果你想給7個屬性都添加註解，僅僅排除一個屬性，那麼你需要在定義target包含所有的屬性。

ElementType.TYPE:用於描述類、接口或enum聲明
ElementType.FIELD:用於描述實例變量
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE 另一個註釋
ElementType.PACKAGE 用於記錄java文件的package信息

@Inherited – 定義該註釋和子類的關係

那麼，註解的內部到底是如何定義的呢？Annotations只支持基本類型、String及枚舉類型。註釋中所有的屬性被定義成方法，並允許提供默認值。

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 }

如果註解中只有一個屬性，可以直接命名爲“value”，使用時無需再標明屬性名。

1 2 3 4 5 6

@interface Author{ String value(); } @Author("Yashwant") public void someMethod() { }

但目前爲止一切看起來都還不錯。我們定義了自己的註解並將其應用在業務邏輯的方法上。現在我們需要寫一個用戶程序調用我們的註解。這裏我們需要使用反射機制。如果你熟悉反射代碼，就會知道反射可以提供類名、方法和實例變量對象。所有這些對象都有getAnnotation()這個方法用來返回註解信息。我們需要把這個對象轉換爲我們自定義的註釋(使用 instanceOf()檢查之後)，同時也可以調用自定義註釋裏面的方法。看看以下的實例代碼，使用了上面的註解:

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()); } }

註解用例

註解的功能很強大，Spring和Hebernate這些框架在日誌和有效性中大量使用了註解功能。註解可以應用在使用標記接口的地方。不同的是標記接口用來定義完整的類，但你可以爲單個的方法定義註釋，例如是否將一個方法暴露爲服務。

在最新的servlet3.0中引入了很多新的註解，尤其是和servlet安全相關的註解。

HandlesTypes –該註解用來表示一組傳遞給ServletContainerInitializer的應用類。

HttpConstraint – 該註解代表所有HTTP方法的應用請求的安全約束，和ServletSecurity註釋中定義的HttpMethodConstraint安全約束不同。

HttpMethodConstraint – 指明不同類型請求的安全約束，和ServletSecurity 註解中描述HTTP協議方法類型的註釋不同。

MultipartConfig –該註解標註在Servlet上面，表示該Servlet希望處理的請求的 MIME 類型是 multipart/form-data。

ServletSecurity 該註解標註在Servlet繼承類上面，強制該HTTP協議請求遵循安全約束。

WebFilter – 該註解用來聲明一個Server過濾器；

WebInitParam – 該註解用來聲明Servlet或是過濾器的中的初始化參數，通常配合 @WebServlet 或者 @WebFilter 使用。

WebListener –該註解爲Web應用程序上下文中不同類型的事件聲明監聽器。

WebServlet –該註解用來聲明一個Servlet的配置。

ADF (應用程序框架)和註解

現在我們開始討論文章的最後一部分了。應用程序框架，被稱爲ADF，由Oracle開發用來創建Oracle融合應用。我們已經瞭解了註解的優缺點，也知道如何編寫自定義的註解，但我們應該將註解應用在ADF的哪部分呢？ADF是否提供了一些樸素的註解？很好的問題，確實在ADF中大量使用註解有一些限制。之前提到的應用框架如Spring和Hibernate使用AOP(面向側面的程序設計)。在AOP中，框架提供了一種機制，在事件的預處理和後續處理中注入代碼。例如：你有一個鉤子用來在方法執行之前和之後添加代碼，所以你可以在這些地方編寫你的用戶代碼。ADF不使用AOP。如果我們有任何註解的用例可用，我們可能需要通過繼承的方式實現。