java註解是在JDK5時引入的新特性，鑑於目前大部分框架(如Spring)都使用了註解簡化程式碼並提高編碼的效率，因此掌握並深入理解註解對於一個Java工程師是來說是很有必要的事。本篇我們將通過以下幾個角度來分析註解的相關知識點

• 理解Java註解
• 基本語法
• 宣告註解與元註解
• 註解元素及其資料型別
• 編譯器對預設值的限制
• 註解不支援繼承
• 快捷方式
• Java內建註解與其它元註解
• 註解與反射機制
• 執行時註解處理器
• Java 8中註解增強
• 元註解Repeatable
• 新增的兩種ElementType

理解Java註解

實際上Java註解與普通修飾符(public、static、void等)的使用方式並沒有多大區別，下面的例子是常見的註解：

通過在方法上使用@Test註解後，在執行該方法時，測試框架會自動識別該方法並單獨呼叫，@Test實際上是一種標記註解，起標記作用，執行時告訴測試框架該方法為測試方法。而對於@Deprecated和@SuppressWarnings(“uncheck”)，則是Java本身內建的註解，在程式碼中，可以經常看見它們，但這並不是一件好事，畢竟當方法或是類上面有@Deprecated註解時，說明該方法或是類都已經過期不建議再用，@SuppressWarnings 則表示忽略指定警告，比如@SuppressWarnings(“uncheck”)，這就是註解的最簡單的使用方式，那麼下面我們就來看看註解定義的基本語法

基本語法

宣告註解與元註解

我們先來看看前面的Test註解是如何宣告的：

我們使用了@interface聲明瞭Test註解，並使用@Target註解傳入ElementType.METHOD引數來標明@Test只能用於方法上，@Retention(RetentionPolicy.RUNTIME)則用來表示該註解生存期是執行時，從程式碼上看註解的定義很像介面的定義，確實如此，畢竟在編譯後也會生成Test.class檔案。對於@Target和@Retention是由Java提供的元註解，所謂元註解就是標記其他註解的註解，下面分別介紹

@Target 用來約束註解可以應用的地方（如方法、類或欄位），其中ElementType是列舉型別，其定義如下，也代表可能的取值範圍

請注意，當註解未指定Target值時，則此註解可以用於任何元素之上，多個值使用{}包含並用逗號隔開，如下：

@Target(value={CONSTRUCTOR, FIELD, LOCAL_VARIABLE, METHOD, PACKAGE, PARAMETER, TYPE})

@Retention用來約束註解的生命週期，分別有三個值，原始碼級別（source），類檔案級別（class）或者執行時級別（runtime），其含有如下：

• SOURCE：註解將被編譯器丟棄（該型別的註解資訊只會保留在原始碼裡，原始碼經過編譯後，註解資訊會被丟棄，不會保留在編譯好的class檔案裡）
• CLASS：註解在class檔案中可用，但會被VM丟棄（該型別的註解資訊會保留在原始碼裡和class檔案裡，在執行的時候，不會載入到虛擬機器中），請注意，當註解未定義Retention值時，預設值是CLASS，如Java內建註解，@Override、@Deprecated、@SuppressWarnning等
• RUNTIME：註解資訊將在執行期(JVM)也保留，因此可以通過反射機制讀取註解的資訊（原始碼、class檔案和執行的時候都有註解的資訊），如SpringMvc中的@Controller、@Autowired、@RequestMapping等。

註解元素及其資料型別

通過上述對@Test註解的定義，我們瞭解了註解定義的過程，由於@Test內部沒有定義其他元素，所以@Test也稱為標記註解（marker annotation），但在自定義註解中，一般都會包含一些元素以表示某些值，方便處理器使用，這點在下面的例子將會看到：

上述定義一個名為DBTable的註解，該用於主要用於資料庫表與Bean類的對映（稍後會有完整案例分析），與前面Test註解不同的是，我們宣告一個String型別的name元素，其預設值為空字元，但是必須注意到對應任何元素的宣告應採用方法的宣告方式，同時可選擇使用default提供預設值，@DBTable使用方式如下：

關於註解支援的元素資料型別除了上述的String，還支援如下資料型別

• 所有基本型別（int,float,boolean,byte,double,char,long,short）
• String
• Class
• enum
• Annotation
• 上述型別的陣列

倘若使用了其他資料型別，編譯器將會丟出一個編譯錯誤，注意，宣告註解元素時可以使用基本型別但不允許使用任何包裝型別，同時還應該注意到註解也可以作為元素的型別，也就是巢狀註解，下面的程式碼演示了上述型別的使用過程：

編譯器對預設值的限制

編譯器對元素的預設值有些過分挑剔。首先，元素不能有不確定的值。也就是說，元素必須要麼具有預設值，要麼在使用註解時提供元素的值。其次，對於非基本型別的元素，無論是在原始碼中宣告，還是在註解介面中定義預設值，都不能以null作為值，這就是限制，沒有什麼利用可言，但造成一個元素的存在或缺失狀態，因為每個註解的宣告中，所有的元素都存在，並且都具有相應的值，為了繞開這個限制，只能定義一些特殊的值，例如空字串或負數，表示某個元素不存在。

註解不支援繼承

註解是不支援繼承的，因此不能使用關鍵字extends來繼承某個@interface，但註解在編譯後，編譯器會自動繼承java.lang.annotation.Annotation介面，這裡我們反編譯前面定義的DBTable註解

雖然反編譯後發現DBTable註解繼承了Annotation介面，請記住，即使Java的介面可以實現多繼承，但定義註解時依然無法使用extends關鍵字繼承@interface。

快捷方式

所謂的快捷方式就是註解中定義了名為value的元素，並且在使用該註解時，如果該元素是唯一需要賦值的一個元素，那麼此時無需使用key=value的語法，而只需在括號內給出value元素所需的值即可。這可以應用於任何合法型別的元素，記住，這限制了元素名必須為value，簡單案例如下

Java內建註解與其它元註解

接著看看Java提供的內建註解，主要有3個，如下：

@Override：用於標明此方法覆蓋了父類的方法，原始碼如下

@Deprecated：用於標明已經過時的方法或類，原始碼如下，關於@Documented稍後分析：

@SuppressWarnnings:用於有選擇的關閉編譯器對類、方法、成員變數、變數初始化的警告，其實現原始碼如下：

其內部有一個String陣列，主要接收值如下：

deprecation：使用了不贊成使用的類或方法時的警告；unchecked：執行了未檢查的轉換時的警告，例如當使用集合時沒有用泛型 (Generics) 來指定集合儲存的型別; fallthrough：當 Switch 程式塊直接通往下一種情況而沒有 Break 時的警告;path：在類路徑、原始檔路徑等中有不存在的路徑時的警告; serial：當在可序列化的類上缺少 serialVersionUID 定義時的警告; finally：任何 finally 子句不能正常完成時的警告; all：關於以上所有情況的警告。

這個三個註解比較簡單，看個簡單案例即可：

前面我們分析了兩種元註解，@Target和@Retention，除了這兩種元註解，Java還提供了另外兩種元註解，@Documented和@Inherited，下面分別介紹：

@Documented 被修飾的註解會生成到javadoc中

使用javadoc命令生成文件：

[email protected] annotationdemo$ javadoc DocumentDemo.java DocumentA.java DocumentB.java 

• 如下：

可以發現使用@Documented元註解定義的註解(@DocumentA)將會生成到javadoc中,而@DocumentB則沒有在doc文件中出現，這就是元註解@Documented的作用。

@Inherited 可以讓註解被繼承，但這並不是真的繼承，只是通過使用@Inherited，可以讓子類Class物件使用getAnnotations()獲取父類被@Inherited修飾的註解，如下：

註解與反射機制

前面經過反編譯後，我們知道Java所有註解都繼承了Annotation介面，也就是說　Java使用Annotation介面代表註解元素，該介面是所有Annotation型別的父介面。同時為了執行時能準確獲取到註解的相關資訊，Java在java.lang.reflect 反射包下新增了AnnotatedElement介面，它主要用於表示目前正在 VM 中執行的程式中已使用註解的元素，通過該介面提供的方法可以利用反射技術地讀取註解的資訊，如反射包的Constructor類、Field類、Method類、Package類和Class類都實現了AnnotatedElement介面，它簡要含義如下

Class：類的Class物件定義

Constructor：代表類的構造器定義

Field：代表類的成員變數定義

Method：代表類的方法定義

Package：代表類的包定義

下面是AnnotatedElement中相關的API方法，以上5個類都實現以下的方法

簡單案例演示如下：

執行時註解處理器

瞭解完註解與反射的相關API後，現在通過一個例項（該例子是博主改編自《Tinking in Java》）來演示利用執行時註解來組裝資料庫SQL的構建語句的過程

上述定義4個註解，分別是@DBTable(用於類上)、@Constraints(用於欄位上)、 @SQLString(用於欄位上)、@SQLString(用於欄位上)並在Member類中使用這些註解，這些註解的作用的是用於幫助註解處理器生成建立資料庫表MEMBER的構建語句，在這裡有點需要注意的是，我們使用了巢狀註解@Constraints，該註解主要用於判斷欄位是否為null或者欄位是否唯一。必須清楚認識到上述提供的註解生命週期必須為@Retention(RetentionPolicy.RUNTIME)，即執行時，這樣才可以使用反射機制獲取其資訊。有了上述註解和使用，剩餘的就是編寫上述的註解處理器了，前面我們聊了很多註解，其處理器要麼是Java自身已提供、要麼是框架已提供的，我們自己都沒有涉及到註解處理器的編寫，但上述定義處理SQL的註解，其處理器必須由我們自己編寫了，如下

如果對反射比較熟悉的同學，上述程式碼就相對簡單了，我們通過傳遞Member的全路徑後通過Class.forName()方法獲取到Member的class物件，然後利用Class物件中的方法獲取所有成員欄位Field，最後利用field.getDeclaredAnnotations()遍歷每個Field上的註解再通過註解的型別判斷來構建建表的SQL語句。這便是利用註解結合反射來構建SQL語句的簡單的處理器模型，是否已回想起Hibernate？

Java 8中註解增強

元註解@Repeatable

元註解@Repeatable是JDK1.8新加入的，它表示在同一個位置重複相同的註解。在沒有該註解前，一般是無法在同一個型別上使用相同的註解的

//Java8前無法這樣使用@FilterPath("/web/update")@FilterPath("/web/add")public class A {}

Java8前如果是想實現類似的功能，我們需要在定義@FilterPath註解時定義一個數組元素接收多個值如下

但在Java8新增了@Repeatable註解後就可以採用如下的方式定義並使用了

我們可以簡單理解為通過使用@Repeatable後，將使用@FilterPaths註解作為接收同一個型別上重複註解的容器，而每個@FilterPath則負責儲存指定的路徑串。為了處理上述的新增註解，Java8還在AnnotatedElement介面新增了getDeclaredAnnotationsByType() 和 getAnnotationsByType()兩個方法並在介面給出了預設實現，在指定@Repeatable的註解時，可以通過這兩個方法獲取到註解相關資訊。

但請注意，舊版API中的getDeclaredAnnotation()和 getAnnotation()是不對@Repeatable註解的處理的(除非該註解沒有在同一個宣告上重複出現)。注意getDeclaredAnnotationsByType方法獲取到的註解不包括父類，其實當 getAnnotationsByType()方法呼叫時，其內部先執行了getDeclaredAnnotationsByType方法，只有當前類不存在指定註解時，getAnnotationsByType()才會繼續從其父類尋找，但請注意如果@FilterPath和@FilterPaths沒有使用了@Inherited的話，仍然無法獲取。下面通過程式碼來演示：

從執行結果來看如果當前類擁有該註解@FilterPath,則getAnnotationsByType方法不會從CC父類尋找，下面看看另外一種情況，即AA類上沒有@FilterPath註解

注意定義@FilterPath和@FilterPath時必須指明@Inherited，getAnnotationsByType方法否則依舊無法從父類獲取@FilterPath註解，這是為什麼呢，不妨看看getAnnotationsByType方法的實現原始碼：

新增的兩種ElementType

在Java8中 ElementType 新增兩個列舉成員，TYPE_PARAMETER 和 TYPE_USE ，在Java8前註解只能標註在一個宣告(如欄位、類、方法)上，Java8後，新增的TYPE_PARAMETER可以用於標註型別引數，而TYPE_USE則可以用於標註任意型別(不包括class)。如下所示

這裡主要說明一下TYPE_USE，型別註解用來支援在Java的程式中做強型別檢查，配合第三方外掛工具（如Checker Framework），可以在編譯期檢測出runtime error（如UnsupportedOperationException、NullPointerException異常），避免異常延續到執行期才發現，從而提高程式碼質量，這就是型別註解的主要作用。總之Java 8 新增加了兩個註解的元素型別ElementType.TYPE_USE 和ElementType.TYPE_PARAMETER ，通過它們，我們可以把註解應用到各種新場合中。

原文連結：http://blog.csdn.net/javazejian/article/details/71860633