1、概述
Annotation(注解)是JDK5.0及以后版本引入的。它用來修飾編程元素，如：包、類、構(gòu)造方法、方法、成員變量、參數(shù)、局域變量等。Annotation是代碼里的特殊標(biāo)記，這些標(biāo)記可以再編譯、類加載、運行時被讀取、并執(zhí)行相應(yīng)的處理。通過使用Annotation(注解)，開發(fā)人員可以在不改變原有邏輯的情況下，在源文件中嵌入一些補充的信息。Annotation不能運行，它只有成員變量，沒有方法。Annotation跟public、final等修飾符地位一樣，都是程序元素的一部分，不能作為單獨的程序元素使用。
2、注解的分類
注解分為兩類，一類是元注解，另外一類是普通注解。
2.1 元注解
所謂元注解就是修飾注解的注解。拿到一個注解，如何知道它是否是元注解呢？需要看它的元注解（無論是元注解還是普通注解都是有元注解的），如果看到這樣的元注解：@Target(ElementType.ANNOTATION_TYPE)，那么此時這個注解一定是元注解。JDK提供了4種元注解：
2.1.1 @Documneted
如果定義注解A時，使用了@Documented修飾定義，則在用javadoc命令生成API文檔后，所有使用注解A修飾的程序元素，將會包含注解A的說明。
2.1.2 @Inherited
@Inherited指定Annotation具有繼承性。
2.1.3 @Retention
注解需要標(biāo)明注解的生命周期，用于指定Annotation可以保留多長時間,這些信息是通過元注解實現(xiàn)。而這個元注解是：
public @interface Retention
{
RetentionPolicy value();
}
Retention注解包含一個enum枚舉類型的RetentionPolicy成員變量。使用@Retention時，必須為其value制定具體的值，包括如下幾種情況：
- SOURCE: 注解只保留在源文件，當(dāng)Java文件編譯成class文件的時候，注解被遺棄。
Annotations are to be discarded by the compiler. - CLASS: 注解被保留到class文件，jvm加載class文件時候被遺棄。這是默認(rèn)的生命周期。
Annotations are to be recorded in the class file by the compiler but need not be retained by the VM at run time. This is the default behavior. - RUNTIME: 注解不僅被保存到class文件中，jvm加載class文件之后，仍然存在，保存到class對象中，可以通過反射來獲取。
Annotations are to be recorded in the class file by the compiler and retained by the VM at run time, so they may be read reflectively.
示例如下：
package com.demo1;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
@Retention(value=RetentionPolicy.RUNTIME) //name=value形式
@Retention(RetentionPolicy.RUNTIME) //直接指定
public @interface MyTag{
String name() default "admin";
}
2.1.4 @Target
注解需要標(biāo)明注解的修飾目標(biāo)，這些信息是通過元注解實現(xiàn)。@Target指定Annotation用于修飾哪些程序元素。@Target也包含一個名為”value“的成員變量，該value成員變量類型為ElementType[ ]，ElementType為枚舉類型,這個元注解是：
public @interface Target
{
ElementType[] value();
}
這個注解的成員變量值是enum類型ElementType。包括以下幾種情況：
TYPE:指的是在類，接口（包括注解）或者enum上使用的注解。
FIELD:指的在field屬性，也包括enum常量使用的注解。
METHOD:指的是在方法聲明上使用的注解。
PARAMETER:指的是在參數(shù)上使用的注解，
CONSTRUCTOR: 指的是在構(gòu)造器使用的注解。
LOCAL_VARIABLE:指的是在局部變量上使用的注解。
ANNOTATION_TYPE:指的是在注解上使用的元注解
PACKAGE:指的是在包上使用的注解。
示例如下：
package com.demo1;
import java.lang.annotation.ElementType;
import java.lang.annotation.Target;
@Target({ ElementType.FIELD, ElementType.METHOD }) //修飾成員變量和方法
public @interface MyTag {
String name() default "admin";
}
2.2 普通注解
JDK默認(rèn)提供了如下幾個基本Annotation：
2.2.1 @Override
限定重寫父類方法。對于子類中被@Override 修飾的方法，如果存在對應(yīng)的被重寫的父類方法，則正確；如果不存在，則報錯。@Override 只能作用于方法，不能作用于其他程序元素
2.2.2 @Deprecated
用于表示某個程序元素（類、方法等）已過時。如果使用被@Deprecated修飾的類或方法等，編譯器會發(fā)出警告。
2.2.3 @SuppressWarning
抑制編譯器警告。指示被@SuppressWarning修飾的程序元素（以及該程序元素中的所有子元素，例如類以及該類中的方法.....）取消顯示指定的編譯器警告。例如，常見的@SuppressWarning（value="unchecked"）
2.2.4 @SafeVarargs
@SafeVarargs是JDK 7 專門為抑制“堆污染”警告提供的。
3、自定義注解
定義新的Annotation類型使用@interface關(guān)鍵字（在原有interface關(guān)鍵字前增加@符號）。定義一個新的Annotation類型與定義一個接口很像，例如：
定義一個注解：
public @interface MyTag{
string name() default "Lucy";
int age() default 18;
}
使用自定義注解：
public class Test{
@MyTag
public void info(){
......
}
}
使用自定義注解時，會把Annotation單獨放一行。并且放在所有修飾符之前，Annotation只有成員變量，沒有方法。Annotation的成員變量在定義時以“無形參的方法”形式來聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。一旦在Annotation中定義了成員變量后，使用該Annotation時就必須為該Annotation的成員變量指定值。也可以在定義Annotation時為其成員變量指定默認(rèn)值，使用該Annotation時可以不為這些成員變量指定值，而是直接使用默認(rèn)值。
綜上，自定義注解的語法與定義形式如下：
- 以@interface關(guān)鍵字定義；
- 注解包含成員，成員以無參數(shù)的方法的形式被聲明。其方法名和返回值定義了該成員的名字和類型。
- 成員賦值是通過@Annotation(name=value)的形式。
- 注解需要標(biāo)明注解的生命周期，注解的修飾目標(biāo)等信息，這些信息是通過元注解實現(xiàn)。
通過分析@Target元注解源碼可以加深對自定義注解語法的理解：
@Retention(value = RetentionPolicy.RUNTIME)
@Target(value = { ElementType.ANNOTATION_TYPE } )
public @interface Target
{
ElementType[] value();
}
源碼分析如下：
- 元注解@Retention，成員value的值為RetentionPolicy.RUNTIME。
- 元注解@Target，成員value是個數(shù)組，用{}形式賦值，值為ElementType.ANNOTATION_TYPE。
- 成員名稱為value，類型為ElementType[]。
另外，需要注意一下，如果成員名稱是value，在賦值過程中可以簡寫。如果成員類型為數(shù)組，但是只賦值一個元素，則也可以簡寫。如上面的簡寫形式為：@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.ANNOTATION_TYPE)。
4、應(yīng)用
當(dāng)開發(fā)者使用了Annotation修飾了類、方法、Field等成員之后，這些Annotation不會自己生效，必須由開發(fā)者提供相應(yīng)的代碼來提取并處理Annotation信息。這些處理提取和處理Annotation的代碼統(tǒng)稱為APT（Annotation Processing Tool）。JDK主要提供了兩個類，來完成Annotation的提?。?/p>
4.1 注解相關(guān)的類
4.1.1 java.lang.annotation.Annotation
這個接口是所有Annotation類型的父接口（Annotation本質(zhì)是接口，而java.lang.annotation.Annotation接口是這些接口的父接口）。java.lang.annotation.Annotation接口部分源碼如下：
package java.lang.annotation;
public interface Annotation {
boolean equals(Object obj);
int hashCode();
String toString();
Class<? extends Annotation> annotationType();
}
java.lang.annotation.Annotation接口的主要方法是annotationType()，用于返回該注解的java.lang.Class。
4.1.2 java.lang.reflect.AnnotatedElement
該接口代表程序中可以被注解的程序元素。java.lang.reflect.AnnotatedElement接口部分源碼如下：
package java.lang.reflect;
import java.lang.annotation.Annotation;
public interface AnnotatedElement {
boolean isAnnotationPresent(Class<? extends Annotation> annotationClass);
<T extends Annotation> T getAnnotation(Class<T> annotationClass);
Annotation[] getAnnotations();
Annotation[] getDeclaredAnnotations();
}
主要方法有：
- isAnnotationPresent(Class<? extends Annotation> annotationClass)：判斷該程序元素上是否存在指定類型的注解，如果存在則返回true，否則返回false。
- getAnnotation(Class<T> annotationClass)：返回該程序元素上存在的指定類型的注解，如果該類型的注解不存在，則返回null。
- Annotation[] getAnnotations()：返回該程序元素上存在的所有注解。
特別強調(diào)：java.lang.reflect.AnnotatedElement接口是所有程序元素（例如java.lang.Class、java.lang.reflect.Method、java.lang.reflect.Constructor等）的父接口。
所以程序通過反射獲取了某個類的AnnotatedElement對象（例如，A類method1()方法的java.lang.reflect.Method對象）后，就可以調(diào)用該對象的isAnnotationPresent9)、getAnnotation()等方法來訪問注解信息。
也就是說，為了獲取注解信息，必須使用反射知識。如果想要在運行時提取注解信息，在定義注解時，該注解必須使用@Retention(RetentionPolicy.RUNTIME)修飾。
5、注解本質(zhì)
- 注解實質(zhì)上會被編譯器編譯為接口，并且繼承java.lang.annotation.Annotation接口。
- 注解的成員變量會被編譯器編譯為同名的抽象方法。
- 根據(jù)Java的class文件規(guī)范，class文件中會在程序元素的屬性位置記錄注解信息。例如，RuntimeVisibleAnnotations屬性位置，記錄修飾該類的注解有哪些；flags屬性位置，記錄該類是不是注解；在方法的AnnotationDefault屬性位置，記錄注解的成員變量默認(rèn)值是多少。
6、注解的意義
為編譯器提供輔助信息 — Annotations可以為編譯器提供而外信息，以便于檢測錯誤，抑制警告等.
編譯源代碼時進(jìn)行而外操作 — 軟件工具可以通過處理Annotation信息來生成原代碼，xml文件等等.
運行時處理 — 有一些annotation甚至可以在程序運行時被檢測，使用.
總之，注解是一種元數(shù)據(jù)，起到了”描述，配置“的作用。
