注解：
從JDK5開始,Java增加對元數據的支持，也就是注解，注解與注釋是有一定區別的，可以把注解理解為代碼里的特殊標記，這些標記可以在編譯，類加載，運行時被讀取，並執行相應的處理。通過注解開發人員可以在不改變原有代碼和邏輯的情況下在源代碼中嵌入補充信息。SSM項目中存在各種注解，因為后續會手寫這幾個框架，所有需要先打好基礎，將這幾個框架中要用到的知識點寫學習。
注解的定義
注解通過 @interface關鍵字進行定義。
public @interface TestAnnotation { String value() default ""; }
注解的應用
上面創建了一個注解，那么注解的的使用方法是什么呢。
@TestAnnotation public class Test{
}
創建一個類 Test,然后在類定義的地方加上 @TestAnnotation就可以用 Test注解這個類了。
不過，要想注解能夠正常工作，還需要介紹一下一個新的概念那就是元注解。
元注解
元注解是可以注解到注解上的注解，或者說元注解是一種基本注解，但是它能夠應用到其它的注解上面。
元注解標簽有 @Retention、@Documented、@Target、@Inherited、@Repeatable 5 種。
@Retention
Retention 的英文意為保留期的意思。當 @Retention 應用到一個注解上的時候，它解釋說明了這個注解的的存活時間。
它的取值如下：
RetentionPolicy.SOURCE 注解只在源碼階段保留，在編譯器進行編譯時它將被丟棄忽視。
RetentionPolicy.CLASS 注解只被保留到編譯進行的時候，它並不會被加載到 JVM 中。注解默認使用這種方式。
RetentionPolicy.RUNTIME 注解可以保留到程序運行的時候，它會被加載進入到 JVM 中，所以在程序運行時可以獲取到它們。因此可以使用反射機制讀取該注解的信息。
@Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation { String value() default ""; }
@Documented
顧名思義，這個元注解肯定是和文檔有關。它的作用是能夠將注解中的元素包含到 Javadoc 中去。
@Target
Target 是目標的意思，@Target 指定了注解運用的地方。
你可以這樣理解，當一個注解被 @Target 注解時，這個注解就被限定了運用的場景。
@Target 有下面的取值
ElementType.ANNOTATION_TYPE 可以給一個注解進行注解
ElementType.CONSTRUCTOR 可以給構造方法進行注解
ElementType.FIELD 可以給屬性進行注解
ElementType.LOCAL_VARIABLE 可以給局部變量進行注解
ElementType.METHOD 可以給方法進行注解
ElementType.PACKAGE 可以給一個包進行注解
ElementType.PARAMETER 可以給一個方法內的參數進行注解
ElementType.TYPE 可以給一個類型進行注解，比如類、接口、枚舉
@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.TYPE)//類、接口（包括注解類型）或枚舉 public @interface TestAnnotation { String value() default ""; }
@Inherited
Inherited 是繼承的意思，但是它並不是說注解本身可以繼承，而是說如果一個超類被 @Inherited 注解過的注解進行注解的話，那么如果它的子類沒有被任何注解應用的話，那么這個子類就繼承了超類的注解。
@Repeatable
Repeatable 自然是可重復的意思。@Repeatable 是 Java 1.8 才加進來的，所以算是一個新的特性。
什么樣的注解會多次應用呢？通常是注解的值可以同時取多個。
注解的屬性
注解的屬性也叫做成員變量。注解只有成員變量，沒有方法。注解的成員變量在注解的定義中以“無形參的方法”形式來聲明，其方法名定義了該成員變量的名字，其返回值定義了該成員變量的類型。
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation{ int id(); String msg(); }
上面代碼定義了 @TestAnnotation 這個注解中擁有 id 和 msg 兩個屬性。在使用的時候，我們應該給它們進行賦值。
賦值的方式是在注解的括號內以 value="" 形式，多個屬性之前用 ，隔開。
@TestAnnotation(id=3,msg="hello annotation") public class Test { }
需要注意的是，使用@interface自定義注解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義注解時，不能繼承其他的注解或接口。@interface用來聲明一個注
解，其中的每一個方法實際上是聲明了一個屬性。方法的名稱就是屬性的名稱，返回值類型就是參數的類型（返回值類型只能是8 種基本數據類型、Class、String、enum及它們的數組）。
定義注解格式：
public @interface 注解名 {定義體}
注解參數的可支持數據類型：
1.所有基本數據類型（int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數組
Annotation類型里面的參數該怎么設定:
第一,只能用public或默認(default)這兩個訪問權修飾.例如,String value();這里把方法設為defaul默認類型；
第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這里的參數成員就為String;
第三,如果只有一個參數成員,最好把參數名稱設為"value",后加小括號。
@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 }
注解中屬性可以有默認值，默認值需要用 default 關鍵值指定。
@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface TestAnnotation{ int id() default -1; String msg() defaul "hi"t; }
因為有默認值，所以無需要再在 @TestAnnotation 后面的括號里面進行賦值了，這一步可以省略。
@TestAnnotation() public class Test { }
另外，還有一種情況。如果一個注解內僅僅只有一個名字為 value 的屬性時，應用這個注解時可以直接接屬性值填寫到括號內。
java 預置的注解
學習了上面相關的知識，我們已經可以自己定義一個注解了。其實 Java 語言本身已經提供了幾個現成的注解。
@Deprecated
這個元素是用來標記過時的元素，想必大家在日常開發中經常碰到。編譯器在編譯階段遇到這個注解時會發出提醒警告，告訴開發者正在調用一個過時的元素比如過時的方法、過時的類、過時的成員變量。
@Override
這個大家應該很熟悉了，提示子類要復寫父類中被 @Override 修飾的方法
@SuppressWarnings
阻止警告的意思。之前說過調用被 @Deprecated 注解的方法后，編譯器會警告提醒，而有時候開發者會忽略這種警告，他們可以在調用的地方通過 @SuppressWarnings 達到目的。
@SafeVarargs
參數安全類型注解。它的目的是提醒開發者不要用參數做一些不安全的操作,它的存在會阻止編譯器產生 unchecked 這樣的警告。它是在 Java 1.7 的版本中加入的。
@FunctionalInterface
函數式接口注解，這個是 Java 1.8 版本引入的新特性。函數式編程很火，所以 Java 8 也及時添加了這個特性。
函數式接口 (Functional Interface) 就是一個具有一個方法的普通接口。
我們進行線程開發中常用的 Runnable 就是一個典型的函數式接口，源碼可以看到它就被 @FunctionalInterface 注解。
注解的提取
博文前面的部分講了注解的基本語法，現在是時候檢測我們所學的內容了。
要想正確檢閱注解的內容信息，離不開一個手段，那就是反射。
注解與反射。
注解通過反射獲取。首先可以通過 Class 對象的 isAnnotationPresent() 方法判斷它是否應用了某個注解
public boolean isAnnotationPresent(Class<? extends Annotation> annotationClass) {}
然后通過 getAnnotation() 方法來獲取 Annotation 對象。
public <A extends Annotation> A getAnnotation(Class<A> annotationClass) {}
或者是 getAnnotations() 方法。
public Annotation[] getAnnotations() {}
前一種方法返回指定類型的注解，后一種方法返回注解到這個元素上的所有注解。
如果獲取到的 Annotation 如果不為 null，則就可以調用它們的屬性方法了。比如
@TestAnnotation() public class Test { public static void main(String[] args) { boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class); if ( hasAnnotation ) { TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class); System.out.println("id:"+testAnnotation.id()); System.out.println("msg:"+testAnnotation.msg()); } } }
程序的運行結果是：
id:-1
msg:
這個正是 TestAnnotation 中 id 和 msg 的默認值。
上面的例子中，只是檢閱出了注解在類上的注解，其實屬性、方法上的注解照樣是可以的。同樣還是要假手於反射。
@TestAnnotation(msg="hello") public class Test { @Check(value="hi") int a; @Perform public void testMethod(){} @SuppressWarnings("deprecation") public void test1(){ Hero hero = new Hero(); hero.say(); hero.speak(); } public static void main(String[] args) { boolean hasAnnotation = Test.class.isAnnotationPresent(TestAnnotation.class); if ( hasAnnotation ) { TestAnnotation testAnnotation = Test.class.getAnnotation(TestAnnotation.class); //獲取類的注解 System.out.println("id:"+testAnnotation.id()); System.out.println("msg:"+testAnnotation.msg()); } try { Field a = Test.class.getDeclaredField("a"); a.setAccessible(true); //獲取一個成員變量上的注解 Check check = a.getAnnotation(Check.class); if ( check != null ) { System.out.println("check value:"+check.value()); } Method testMethod = Test.class.getDeclaredMethod("testMethod"); if ( testMethod != null ) { // 獲取方法中的注解 Annotation[] ans = testMethod.getAnnotations(); for( int i = 0;i < ans.length;i++) { System.out.println("method testMethod annotation:"+ans[i].annotationType().getSimpleName()); } } } catch (NoSuchFieldException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } catch (SecurityException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } catch (NoSuchMethodException e) { // TODO Auto-generated catch block e.printStackTrace(); System.out.println(e.getMessage()); } } }
它們的結果如下：
id:-1
msg:hello
check value:hi
method testMethod annotation:Perform
需要注意的是，如果一個注解要在運行時被成功提取，那么 @Retention(RetentionPolicy.RUNTIME) 是必須的。
注解的使用場景
Java 官方文檔寫明：
注解是一系列元數據，它提供數據用來解釋程序代碼，但是注解並非是所解釋的代碼本身的一部分。注解對於代碼的運行效果沒有直接影響。
注解有許多用處，主要如下：
提供信息給編譯器： 編譯器可以利用注解來探測錯誤和警告信息
編譯階段時的處理： 軟件工具可以用來利用注解信息來生成代碼、Html文檔或者做其它相應處理。
運行時的處理： 某些注解可以在程序運行的時候接受代碼的提取
值得注意的是，注解不是代碼本身的一部分。
注解同樣無法改變代碼本身，注解只是某些工具的的工具。
還是回到官方文檔的解釋上，注解主要針對的是編譯器和其它工具軟件(SoftWare tool)。
當開發者使用了Annotation 修飾了類、方法、Field 等成員之后，這些 Annotation 不會自己生效，必須由開發者提供相應的代碼來提取並處理 Annotation 信息。這些處理提取和處理 Annotation 的代碼統稱為 APT（Annotation Processing Tool)。
現在，我們可以給自己答案了，注解有什么用？給誰用？給 編譯器或者 APT 用的。
親手自定義注解完成某個目的
我要寫一個測試框架，測試程序員的代碼有無明顯的異常。
—— 程序員 A : 我寫了一個類，它的名字叫做 NoBug，因為它所有的方法都沒有錯誤。
—— 我：自信是好事，不過為了防止意外，讓我測試一下如何？
—— 程序員 A: 怎么測試？
—— 我：把你寫的代碼的方法都加上 @Jiecha 這個注解就好了。
—— 程序員 A: 好的。
package ceshi; import ceshi.Jiecha; public class NoBug { @Jiecha public void suanShu(){ System.out.println("1234567890"); } @Jiecha public void jiafa(){ System.out.println("1+1="+1+1); } @Jiecha public void jiefa(){ System.out.println("1-1="+(1-1)); } @Jiecha public void chengfa(){ System.out.println("3 x 5="+ 3*5); } @Jiecha public void chufa(){ System.out.println("6 / 0="+ 6 / 0); } public void ziwojieshao(){ System.out.println("我寫的程序沒有 bug!"); } }
package ceshi; import java.lang.annotation.Retention; import java.lang.annotation.RetentionPolicy; @Retention(RetentionPolicy.RUNTIME) public @interface Jiecha { }
然后，我再編寫一個測試類 TestTool 就可以測試 NoBug 相應的方法了。
package ceshi; import java.lang.reflect.InvocationTargetException; import java.lang.reflect.Method; public class TestTool { public static void main(String[] args) { // TODO Auto-generated method stub NoBug testobj = new NoBug(); Class clazz = testobj.getClass(); Method[] method = clazz.getDeclaredMethods(); //用來記錄測試產生的 log 信息 StringBuilder log = new StringBuilder(); // 記錄異常的次數 int errornum = 0; for ( Method m: method ) { // 只有被 @Jiecha 標注過的方法才進行測試 if ( m.isAnnotationPresent( Jiecha.class )) { try { m.setAccessible(true); m.invoke(testobj, null); } catch (Exception e) { // TODO Auto-generated catch block //e.printStackTrace(); errornum++; log.append(m.getName()); log.append(" "); log.append("has error:"); log.append("\n\r caused by "); //記錄測試過程中，發生的異常的名稱 log.append(e.getCause().getClass().getSimpleName()); log.append("\n\r"); //記錄測試過程中，發生的異常的具體信息 log.append(e.getCause().getMessage()); log.append("\n\r"); } } } log.append(clazz.getSimpleName()); log.append(" has "); log.append(errornum); log.append(" error."); // 生成測試報告 System.out.println(log.toString()); } }
測試的結果是：
1234567890 1+1=11 1-1=0 3 x 5=15 chufa has error: caused by ArithmeticException / by zero NoBug has 1 error.
提示 NoBug 類中的 chufa() 這個方法有異常，這個異常名稱叫做 ArithmeticException，原因是運算過程中進行了除 0 的操作。
所以，NoBug 這個類有 Bug。
這樣，通過注解我完成了我自己的目的，那就是對別人的代碼進行測試。
注解應用實例
注解的功能很強大，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的配置。
總結：
- 如果注解難於理解，你就把它類同於標簽，標簽為了解釋事物，注解為了解釋代碼。
- 注解的基本語法，創建如同接口，但是多了個 @ 符號。
- 注解的元注解。
- 注解的屬性。
- 注解主要給編譯器及工具類型的軟件用的。
- 注解的提取需要借助於 Java 的反射技術，反射比較慢，所以注解使用時也需要謹慎計較時間成本。