【本文轉載于http://www.open-open.com/lib/view/open1423558996951.html】
從jdk5開始，java增加了annotation(注解)，annotation是代碼裡的特殊标記，這些标記可以在編譯、類加載、運作時被讀取，并執行相應的處理。通過使用annotation，開發人員可以在不改變原有邏輯的情況下，在源檔案中嵌入一些補充的資訊。代碼分析工具、開發工具和部署工具可以通過這些補充資訊進行驗證、處理或者進行部署。
annotation提供了一種為程式元素（包、類、構造器、方法、成員變量、參數、局域變量）設定中繼資料的方法。annotation不能運作，它隻有成員變量，沒有方法。annotation跟public、final等修飾符的地位一樣，都是程式元素的一部分，annotation不能作為一個程式元素使用。
1 定義annotation
定義新的annotation類型使用@interface關鍵字（在原有interface關鍵字前增加@符号）。定義一個新的annotation類型與定義一個接口很像，例如：
<a target="_blank" href="http://www.open-open.com/lib/view/open1423558996951.html#">?</a>
1
2
<code>public</code> <code>@interface</code> <code>test{</code>
<code>}</code>
定義完該annotation後，就可以在程式中使用該annotation。使用annotation，非常類似于public、final這樣的修飾符，通常，會把annotation另放一行，并且放在所有修飾符之前。例如：
3
4
<code>@test</code>
<code>public</code> <code>class</code> <code>myclass{</code>
<code>....</code>
1.1 成員變量
annotation隻有成員變量，沒有方法。annotation的成員變量在annotation定義中以“無形參的方法”形式來聲明，其方法名定義了該成員變量的名字，其傳回值定義了該成員變量的類型。例如：
<code>public</code> <code>@interface</code> <code>mytag{</code>
<code> </code><code>string name();</code>
<code> </code><code>int</code> <code>age();</code>
示例中定義了2個成員變量，這2個成員變量以方法的形式來定義。
一旦在annotation裡定義了成員變量後，使用該annotation時就應該為該annotation的成員變量指定值。例如：
5
6
<code>public</code> <code>class</code> <code>test{</code>
<code> </code><code>@mytag</code><code>(name=</code><code>"蕃薯"</code><code>，age=</code><code>30</code><code>)</code>
<code> </code><code>public</code> <code>void</code> <code>info(){</code>
<code> </code><code>......</code>
<code> </code><code>}</code>
也可以在定義annotation的成員變量時，為其指定預設值，指定成員變量預設值使用default關鍵字。示例：
<code> </code><code>string name() </code><code>default</code> <code>"我蘭"</code><code>;</code>
<code> </code><code>int</code> <code>age() </code><code>default</code> <code>18</code><code>;</code>
如果annotation的成員變量已經指定了預設值，使用該annotation時可以不為這些成員變量指定值，而是直接使用預設值。例如：
<code> </code><code>@mytag</code>
根據annotation是否包含成員變量，可以把annotation分為如下兩類：
标記annotation：沒有成員變量的annotation被稱為标記。這種annotation僅用自身的存在與否來為我們提供資訊，例如@override等。
中繼資料annotation：包含成員變量的annotation。因為它們可以接受更多的中繼資料，是以被稱為中繼資料annotation。
1.2 元注解
在定義annotation時，也可以使用jdk提供的元注解來修飾annotation定義。jdk提供了如下4個元注解（注解的注解，不是上述的”中繼資料annotation“）：
@retention
@target
@documented
@inherited
1.2.1 @retention
@retention用于指定annotation可以保留多長時間。
@retention包含一個名為“value”的成員變量，該value成員變量是retentionpolicy枚舉類型。使用@retention時，必須為其value指定值。value成員變量的值隻能是如下3個：
retentionpolicy.source：annotation隻保留在源代碼中，編譯器編譯時，直接丢棄這種annotation。
retentionpolicy.class：編譯器把annotation記錄在class檔案中。當運作java程式時，jvm中不再保留該annotation。
retentionpolicy.runtime：編譯器把annotation記錄在class檔案中。當運作java程式時，jvm會保留該annotation，程式可以通過反射擷取該annotation的資訊。
示例：
7
8
9
10
11
12
13
<code>package</code> <code>com.demo1;</code>
<code>import</code> <code>java.lang.annotation.retention;</code>
<code>import</code> <code>java.lang.annotation.retentionpolicy;</code>
<code>//name=value形式</code>
<code>//@retention(value=retentionpolicy.runtime)</code>
<code>//直接指定</code>
<code>@retention</code><code>(retentionpolicy.runtime)</code>
如果annotation裡有一個名為“value“的成員變量，使用該annotation時，可以直接使用xxx(val)形式為value成員變量指派，無須使用name=val形式。
1.2.2 @target
@target指定annotation用于修飾哪些程式元素。@target也包含一個名為”value“的成員變量，該value成員變量類型為elementtype[ ]，elementtype為枚舉類型，值有如下幾個：
elementtype.type：能修飾類、接口或枚舉類型
elementtype.field：能修飾成員變量
elementtype.method：能修飾方法
elementtype.parameter：能修飾參數
elementtype.constructor：能修飾構造器
elementtype.local_variable：能修飾局部變量
elementtype.annotation_type：能修飾注解
elementtype.package：能修飾包
示例1（單個elementtype）：
<code>import</code> <code>java.lang.annotation.elementtype;</code>
<code>import</code> <code>java.lang.annotation.target;</code>
<code>@target</code><code>(elementtype.field)</code>
<code>public</code> <code>@interface</code> <code>anntest {</code>
<code> </code><code>string name() </code><code>default</code> <code>"sunchp"</code><code>;</code>
示例2（多個elementtype）：
<code>@target</code><code>({ elementtype.field, elementtype.method })</code>
1.2.3 @documented
如果定義注解a時，使用了@documented修飾定義，則在用javadoc指令生成api文檔後，所有使用注解a修飾的程式元素，将會包含注解a的說明。
<code>@documented</code>
<code>public</code> <code>@interface</code> <code>testable {</code>
<code>public</code> <code>class</code> <code>test {</code>
<code> </code><code>@testable</code>
<code> </code><code>public</code> <code>void</code> <code>info() {</code>
1.2.4 @inherited
@inherited指定annotation具有繼承性。
14
<code>package</code> <code>com.demo2;</code>
<code>import</code> <code>java.lang.annotation.inherited;</code>
<code>@target</code><code>(elementtype.type)</code>
<code>@inherited</code>
<code>@mytag</code>
<code>public</code> <code>class</code> <code>base {</code>
<code>//subclass隻是繼承了base類</code>
<code>//并未直接使用@mytag注解修飾</code>
<code>public</code> <code>class</code> <code>subclass </code><code>extends</code> <code>base {</code>
<code> </code><code>public</code> <code>static</code> <code>void</code> <code>main(string[] args) {</code>
<code> </code><code>system.out.println(subclass.</code><code>class</code><code>.isannotationpresent(mytag.</code><code>class</code><code>));</code>
示例中base使用@mytag修飾，subclass繼承base，而且沒有直接使用@mytag修飾，但是因為mytag定義時，使用了@inherited修飾，具有了繼承性，是以運作結果為true。
如果mytag注解沒有被@inherited修飾，則運作結果為：false。
1.3 基本annotation
jdk預設提供了如下幾個基本annotation：
@override
限定重寫父類方法。對于子類中被@override 修飾的方法，如果存在對應的被重寫的父類方法，則正确；如果不存在，則報錯。@override 隻能作用于方法，不能作用于其他程式元素。
@deprecated
用于表示某個程式元素（類、方法等）已過時。如果使用被@deprecated修飾的類或方法等，編譯器會發出警告。
@suppresswarning
抑制編譯器警告。訓示被@suppresswarning修飾的程式元素（以及該程式元素中的所有子元素，例如類以及該類中的方法.....）取消顯示指定的編譯器警告。例如，常見的@suppresswarning（value="unchecked"）
@safevarargs
@safevarargs是jdk 7 專門為抑制“堆污染”警告提供的。
2 提取annotation資訊（反射）
當開發者使用了annotation修飾了類、方法、field等成員之後，這些annotation不會自己生效，必須由開發者提供相應的代碼來提取并處理annotation資訊。這些處理提取和處理annotation的代碼統稱為apt（annotation processing tool）。
jdk主要提供了兩個類，來完成annotation的提取：
java.lang.annotation.annotation接口：這個接口是所有annotation類型的父接口（後面會分析annotation的本質，annotation本質是接口，而java.lang.annotation.annotation接口是這些接口的父接口）。
java.lang.reflect.annotatedelement接口：該接口代表程式中可以被注解的程式元素。
2.1 java.lang.annotation.annotation
java.lang.annotation.annotation接口源碼:
<code>package</code> <code>java.lang.annotation;</code>
<code>public</code> <code>interface</code> <code>annotation {</code>
<code> </code><code>boolean</code> <code>equals(object obj);</code>
<code> </code><code>int</code> <code>hashcode();</code>
<code> </code><code>string tostring();</code>
<code> </code><code>class<? </code><code>extends</code> <code>annotation> annotationtype();</code>
java.lang.annotation.annotation接口的主要方法是annotationtype( )，用于傳回該注解的java.lang.class。
2.2 java.lang.reflect.annotatedelement
java.lang.reflect.annotatedelement接口源碼：
<code>package</code> <code>java.lang.reflect;</code>
<code>import</code> <code>java.lang.annotation.annotation;</code>
<code>public</code> <code>interface</code> <code>annotatedelement {</code>
<code> </code><code>boolean</code> <code>isannotationpresent(class<? </code><code>extends</code> <code>annotation> annotationclass);</code>
<code> </code><code><t </code><code>extends</code> <code>annotation> t getannotation(class<t> annotationclass);</code>
<code> </code><code>annotation[] getannotations();</code>
<code> </code><code>annotation[] getdeclaredannotations();</code>
主要方法有：
isannotationpresent(class<? extends annotation> annotationclass)：判斷該程式元素上是否存在指定類型的注解，如果存在則傳回true，否則傳回false。
getannotation(class<t> annotationclass)：傳回該程式元素上存在的指定類型的注解，如果該類型的注解不存在，則傳回null
annotation[] getannotations()：傳回該程式元素上存在的所有注解。
java.lang.reflect.annotatedelement接口是所有程式元素（例如java.lang.class、java.lang.reflect.method、java.lang.reflect.constructor等）的父接口。類圖結構如下：
是以程式通過反射擷取了某個類的annotatedelement對象（例如，a類method1()方法的java.lang.reflect.method對象）後，就可以調用該對象的isannotationpresent(
)、getannotation( )等方法來通路注解資訊。
為了擷取注解資訊，必須使用反射知識。
ps：如果想要在運作時提取注解資訊，在定義注解時，該注解必須使用@retention(retentionpolicy.runtime)修飾。
2.3 示例
2.3.1 标記annotation
給定一個類的全額限定名，加載類，并列出該類中被注解@mytag修飾的方法和沒被修飾的方法。
注解定義：
<code>@target</code><code>(elementtype.method)</code>
<code>public</code> <code>@interface</code> <code>mytag {</code>
注解處理：
15
16
17
18
19
20
21
22
23
<code>import</code> <code>java.lang.reflect.method;</code>
<code>public</code> <code>class</code> <code>processtool {</code>
<code> </code><code>public</code> <code>static</code> <code>void</code> <code>process(string clazz) {</code>
<code> </code><code>class targetclass = </code><code>null</code><code>;</code>
<code> </code><code>try</code> <code>{</code>
<code> </code><code>targetclass = class.forname(clazz);</code>
<code> </code><code>} </code><code>catch</code> <code>(classnotfoundexception e) {</code>
<code> </code><code>e.printstacktrace();</code>
<code> </code><code>}</code>
<code> </code><code>for</code> <code>(method m : targetclass.getmethods()) {</code>
<code> </code><code>if</code> <code>(m.isannotationpresent(mytag.</code><code>class</code><code>)) {</code>
<code> </code><code>system.out.println(</code><code>"被mytag注解修飾的方法名："</code> <code>+ m.getname());</code>
<code> </code><code>} </code><code>else</code> <code>{</code>
<code> </code><code>system.out.println(</code><code>"沒被mytag注解修飾的方法名："</code> <code>+ m.getname());</code>
<code> </code><code>}</code>
測試類：
<code>public</code> <code>class</code> <code>demo {</code>
<code> </code><code>public</code> <code>static</code> <code>void</code> <code>m1() {</code>
<code> </code><code>public</code> <code>static</code> <code>void</code> <code>m2() {</code>
<code> </code><code>processtool.process(</code><code>"com.demo1.demo"</code><code>);</code>
運作結果：
<code>沒被mytag注解修飾的方法名：m1</code>
<code>被mytag注解修飾的方法名：m2</code>
<code>沒被mytag注解修飾的方法名：wait</code>
<code>沒被mytag注解修飾的方法名：equals</code>
<code>沒被mytag注解修飾的方法名：tostring</code>
<code>沒被mytag注解修飾的方法名：hashcode</code>
<code>沒被mytag注解修飾的方法名：getclass</code>
<code>沒被mytag注解修飾的方法名：notify</code>
<code>沒被mytag注解修飾的方法名：notifyall</code>
2.3.2 中繼資料annotation
給定一個類的全額限定名，加載類，找出被注解mytag修飾的方法，并輸出每個方法的mytag注解的屬性。
<code> </code><code>mytag tag = m.getannotation(mytag.</code><code>class</code><code>);</code>
<code> </code><code>system.out.println(</code><code>"方法"</code> <code>+ m.getname() + </code><code>"的mytag注解内容為："</code> <code>+ tag.name() + </code><code>"，"</code> <code>+ tag.age());</code>
<code> </code><code>@mytag</code><code>(name = </code><code>"蕃薯"</code><code>)</code>
<code> </code><code>public</code> <code>static</code> <code>void</code> <code>m3() {</code>
<code> </code><code>@mytag</code><code>(name = </code><code>"蕃薯"</code><code>, age = </code><code>30</code><code>)</code>
<code> </code><code>public</code> <code>static</code> <code>void</code> <code>m4() {</code>
<code>方法m2的mytag注解内容為：我蘭，</code><code>18</code>
<code>方法m3的mytag注解内容為：蕃薯，</code><code>18</code>
<code>方法m4的mytag注解内容為：蕃薯，</code><code>30</code>
若要擷取注解中的成員變量值，直接調用注解對象的"成員變量民( )"形式的方法就行，例如示例中的tag.name()等。
ps：在編譯器編譯注解定義時，自動在class檔案中，添加與成員變量同名的抽象方法，用于反射時擷取成員變量的值。
通過上面的示例可以看出，其實annotation十分簡單，它是對源代碼增加的一些特殊标記，這些特殊标記可通過反射擷取，當程式擷取這些特殊标記後，程式可以做出相應的處理（當然也可以完全忽略這些annotation）。
3 注解本質
對于示例”2.3.2 中繼資料annotation“中的mytag注解，在編譯後，生成一個mytag.class檔案。反編譯該class檔案：
<code>javap -verbose -c mytag.</code><code>class</code> <code>> m.txt</code>
mytag注解的位元組碼為：
通過分析位元組碼可知：
注解實質上會被編譯器編譯為接口，并且繼承java.lang.annotation.annotation接口。
注解的成員變量會被編譯器編譯為同名的抽象方法。
根據java的class檔案規範，class檔案中會在程式元素的屬性位置記錄注解資訊。例如，runtimevisibleannotations屬性位置，記錄修飾該類的注解有哪些；flags屬性位置，記錄該類是不是注解；在方法的annotationdefault屬性位置，記錄注解的成員變量預設值是多少。
我們再反編譯下示例”2.3.2 中繼資料annotation“中的demo測試類，檢視下”被注解修飾的方法是怎樣記錄自己被注解修飾的“：
<code>javap -verbose -c demo.</code><code>class</code> <code>> d.txt</code>
反編譯結果如下：
通過位元組碼可知：
在位元組碼檔案中，每個方法都有runtimevisibleannotations屬性位置，用來放置注解和注解的成員變量指派。jvm在解析class檔案時，會解析runtimevisibleannotations屬性，并建立相應類型的注解對象，并将成員變量指派。
4 注解的意義
為編譯器提供輔助資訊 — annotations可以為編譯器提供而外資訊，以便于檢測錯誤，抑制警告等.
編譯源代碼時進行而外操作 — 軟體工具可以通過處理annotation資訊來生成原代碼，xml檔案等等.
運作時處理 — 有一些annotation甚至可以在程式運作時被檢測，使用.
總之，注解是一種中繼資料，起到了”描述，配置“的作用。