概念
注解（Annotation），也叫元數(shù)據(jù)。一種代碼級(jí)別的說明。
它是JDK1.5及以后版本引入的一個(gè)特性，與類、接口、枚舉是在同一個(gè)層次。它可以聲明在包、類、字段、方法、局部變量、方法參數(shù)等的前面，用來對(duì)這些元素進(jìn)行說明，注釋。
它是一種由JSR-175標(biāo)準(zhǔn)選擇用來描述元數(shù)據(jù)的一種工具。
作用
使用Annotation之前(甚至在使用之后)，XML被廣泛的應(yīng)用于描述元數(shù)據(jù)。不知何時(shí)開始一些應(yīng)用開發(fā)人員和架構(gòu)師發(fā)現(xiàn)XML的維護(hù)越來越糟糕了。他們希望使用一些和代碼緊耦合的東西，而不是像XML那樣和代碼是松耦合的(在某些情況下甚至是完全分離的)代碼描述。如果你在Google中搜索“XML vs. annotations”，會(huì)看到許多關(guān)于這個(gè)問題的辯論。最有趣的是XML配置其實(shí)就是為了分離代碼和配置而引入的。上述兩種觀點(diǎn)可能會(huì)讓你很疑惑，兩者觀點(diǎn)似乎構(gòu)成了一種循環(huán)，但各有利弊。下面我們通過一個(gè)例子來理解這兩者的區(qū)別。
假如你想為應(yīng)用設(shè)置很多的常量或參數(shù)，這種情況下，XML是一個(gè)很好的選擇，因?yàn)樗粫?huì)同特定的代碼相連。如果你想把某個(gè)方法聲明為服務(wù)，那么使用Annotation會(huì)更好一些，因?yàn)檫@種情況下需要注解和方法緊密耦合起來，開發(fā)人員也必須認(rèn)識(shí)到這點(diǎn)。
另一個(gè)很重要的因素是Annotation定義了一種標(biāo)準(zhǔn)的描述元數(shù)據(jù)的方式。在這之前，開發(fā)人員通常使用他們自己的方式定義元數(shù)據(jù)。例如，使用標(biāo)記interfaces，注釋，transient關(guān)鍵字等等。每個(gè)程序員按照自己的方式定義元數(shù)據(jù)，而不像Annotation這種標(biāo)準(zhǔn)的方式。
目前，許多框架將XML和Annotation兩種方式結(jié)合使用，平衡兩者之間的利弊。
常見注解
工作原理
Annotations僅僅是元數(shù)據(jù)，和業(yè)務(wù)邏輯無關(guān)。理解起來有點(diǎn)困難，但就是這樣。如果Annotations不包含業(yè)務(wù)邏輯，那么必須有人來實(shí)現(xiàn)這些邏輯。元數(shù)據(jù)的用戶來做這個(gè)事情。Annotations僅僅提供它定義的屬性(類/方法/包/域)的信息。Annotations的用戶(同樣是一些代碼)來讀取這些信息并實(shí)現(xiàn)必要的邏輯。
當(dāng)我們使用Java的標(biāo)注Annotations(例如@Override)時(shí)，JVM就是一個(gè)用戶，它在字節(jié)碼層面工作。到這里，應(yīng)用開發(fā)人員還不能控制也不能使用自定義的注解。
元注解
J2SE5.0版本在 java.lang.annotation提供了四種元注解，專門注解其他的注解：
- @Documented –注解是否將包含在JavaDoc中
- @Retention –什么時(shí)候使用該注解
- @Target? –注解用于什么地方
- @Inherited – 是否允許子類繼承該注解
@Retention
定義該注解的生命周期。
RetentionPolicy.SOURCE – 在編譯階段丟棄。這些注解在編譯結(jié)束之后就不再有任何意義，所以它們不會(huì)寫入字節(jié)碼。@Override, @SuppressWarnings都屬于這類注解。
RetentionPolicy.CLASS – 在類加載的時(shí)候丟棄。在字節(jié)碼文件的處理中有用。注解默認(rèn)使用這種方式。
RetentionPolicy.RUNTIME– 始終不會(huì)丟棄，運(yùn)行期也保留該注解，因此可以使用反射機(jī)制讀取該注解的信息。我們自定義的注解通常使用這種方式。
@Target
表示該注解用于什么地方。如果不明確指出，該注解可以放在任何地方。以下是一些可用的參數(shù)。需要說明的是：屬性的注解是兼容的，如果你想給7個(gè)屬性都添加注解，僅僅排除一個(gè)屬性，那么你需要在定義target包含所有的屬性。
ElementType.TYPE:用于描述類、接口或enum聲明
ElementType.FIELD:用于描述實(shí)例變量
ElementType.METHOD
ElementType.PARAMETER
ElementType.CONSTRUCTOR
ElementType.LOCAL_VARIABLE
ElementType.ANNOTATION_TYPE 另一個(gè)注釋
ElementType.PACKAGE 用于記錄java文件的package信息
自定義注解
Annotations只支持基本類型、String及枚舉類型。注釋中所有的屬性被定義成方法，并允許提供默認(rèn)值。
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@interface Todo {
public enum Priority {LOW, MEDIUM, HIGH}
public enum Status {STARTED, NOT_STARTED}
String author() default "Yash";//字符串對(duì)象author，默認(rèn)Yash
Priority priority() default Priority.LOW;//枚舉類priority，默認(rèn)LOW
Status status() default Status.NOT_STARTED;//枚舉類status，默認(rèn)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
}
如果注解中只有一個(gè)屬性，可以直接命名為“value”，使用時(shí)無需再標(biāo)明屬性名。
@interface Author{
String value();
}
@Author("Yashwant")
public void someMethod() {
}
解析注解
通過反射，可以寫一個(gè)用戶程序來調(diào)用注解。
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());
}
}
注解用例
注解的功能很強(qiáng)大，Spring和Hebernate這些框架在日志和有效性中大量使用了注解功能。注解可以應(yīng)用在使用標(biāo)記接口的地方。不同的是標(biāo)記接口用來定義完整的類，但你可以為單個(gè)的方法定義注釋，例如是否將一個(gè)方法暴露為服務(wù)。
在最新的servlet3.0中引入了很多新的注解，尤其是和servlet安全相關(guān)的注解。
HandlesTypes –該注解用來表示一組傳遞給ServletContainerInitializer的應(yīng)用類。
HttpConstraint – 該注解代表所有HTTP方法的應(yīng)用請(qǐng)求的安全約束，和ServletSecurity注釋中定義的HttpMethodConstraint安全約束不同。
HttpMethodConstraint – 指明不同類型請(qǐng)求的安全約束，和ServletSecurity 注解中描述HTTP協(xié)議方法類型的注釋不同。
MultipartConfig –該注解標(biāo)注在Servlet上面，表示該Servlet希望處理的請(qǐng)求的 MIME 類型是 multipart/form-data。
ServletSecurity 該注解標(biāo)注在Servlet繼承類上面，強(qiáng)制該HTTP協(xié)議請(qǐng)求遵循安全約束。
WebFilter – 該注解用來聲明一個(gè)Server過濾器；
WebInitParam – 該注解用來聲明Servlet或是過濾器的中的初始化參數(shù)，通常配合 @WebServlet 或者 @WebFilter 使用。
WebListener –該注解為Web應(yīng)用程序上下文中不同類型的事件聲明監(jiān)聽器。
WebServlet –該注解用來聲明一個(gè)Servlet的配置。
