註解是什麼？為什麼要使用註解？
點選上方 “程式設計師小樂”關注， 星標或置頂一起成長
每天凌晨00點00分， 第一時間與你相約
每日英文
Maturity not to see how old you， but your shoulders strong enough to see multiple responsibilities。
成熟不是看你的年齡有多大，而是看你的肩膀能挑起多重的責任。
每日掏心話
每個人的性格中，都有某些無法讓人接受的部分，再美好的人也一樣。所以不要苛求別人，也不要埋怨自己。
來自：yq1012。com/myweb/2230。html | 責編：樂樂
程式設計師小樂（ID：study_tech）第 749 次推文 圖片來自 Pexels
往日回顧：萬字長文！Unix 和 Linux 你不知道的那些歷史（詳解版）
正文
自Java5。0版本引入註解之後，它就成為了Java平臺中非常重要的一部分。開發過程中，我們也時常在應用程式碼中會看到諸如@Override，@Deprecated這樣的註解。這篇文章中，我將向大家講述到底什麼是註解，為什麼要引入註解，註解是如何工作的，如何編寫自定義的註解（透過例子），什麼情況下可以使用註解以及最新註解和ADF（應用開發框架）。這會花點兒時間，所以為自己準備一杯咖啡，讓我們來進入註解的世界吧。
什麼是註解？
用一個詞就可以描述註解，那就是元資料，即一種描述資料的資料。所以，可以說註解就是原始碼的元資料。比如，下面這段程式碼：
@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機制。
示例程式碼 AnnotationsSample。zip
docs。google。com/file/d/0B1N2DVZFnNU0dVdFVjVFeTVtcXc/edit
編寫Annotation非常簡單，可以將Annotation的定義同介面的定義進行比較。我們來看兩個例子：一個是標準的註解@Override，另一個是使用者自定義註解@Todo。
@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及列舉型別。註釋中所有的屬性被定義成方法，並允許提供預設值。
@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
}
如果註解中只有一個屬性，可以直接命名為“value”，使用時無需再標明屬性名。
@interface Author{
String value（）；
}
@Author（“Yashwant”）
public void someMethod（） {
}
但目前為止一切看起來都還不錯。我們定義了自己的註解並將其應用在業務邏輯的方法上。現在我們需要寫一個使用者程式呼叫我們的註解。這裡我們需要使用反射機制。如果你熟悉反射程式碼，就會知道反射可以提供類名、方法和例項變數物件。所有這些物件都有getAnnotation（）這個方法用來返回註解資訊。我們需要把這個物件轉換為我們自定義的註釋（使用 instanceOf（）檢查之後），同時也可以呼叫自定義註釋裡面的方法。看看以下的例項程式碼，使用了上面的註解：
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。如果我們有任何註解的用例可用，我們可能需要透過繼承的方式實現。
歡迎在留言區留下你的觀點，一起討論提高。如果今天的文章讓你有新的啟發，學習能力的提升上有新的認識，歡迎轉發分享給更多人。
猜你還想看
阿里、騰訊、百度、華為、京東最新面試題彙集
前後端分離開發，六大方案全揭秘：HTTP API 認證授權術
濃縮就是精華！106頁的《Python進階》中文版（附下載）
終於明白為什麼要加 final 關鍵字了！
關注「程式設計師小樂」，收看更多精彩內容
嘿，你在看嗎？
