public class BaseExample {
public BaseExample() {}
public void myMethod() {
System.out.println("This is the BaseExample");
}
}
現(xiàn)在，我們想要擴展BaseExample并替代myMethod。下面就是完成這一任務(wù)的Example1代碼：
public class Example1 extends BaseExample {
public Example1() {}
@Overridepublic void myMethod() {
System.out.println("This is the Example1");
}
}
這樣我們就有了第一個關(guān)于myMethod的批注
——@Override。這是一系列內(nèi)置的批注之一。@Override的意思是“方法必須替代其超類中的一個方法；如果做不到這一點，那么就會有東西出錯，使得編譯器產(chǎn)生錯誤”。沒有@Override，代碼照樣會正常工作，但是假設(shè)有人修改BaseExample，讓myMethod帶有參數(shù)。如果你沒有使用@Override批注，代碼仍然會被編譯，隱藏了子類沒有替代超類方法的問題。如果有@Override的話，你會在編譯期間看到發(fā)生錯誤。
你可能會認為“難道語言的擴展沒有解決這個問題，額外的關(guān)鍵字可能會嗎”，是的，它可能已經(jīng)實現(xiàn)了這一點，但是這不僅沒有給語言帶來任何靈活性，還會導(dǎo)致很多源代碼兼容性的問題。批注這種方式避免了改變Java語言本身(當然除了增加了@markup)，并且還能夠放在代碼的不同部分里，而不僅僅是在標記方法里。
關(guān)于批注還有一點是，你可以創(chuàng)建自己的批注標記，這正是我們馬上要討論的內(nèi)容。想一想下面這個問題：我們有一些簡單的Java Beans程序，它們都帶有不同的字符串字段。我們希望能夠有一些通用窗體顯示代碼，它們能夠用其他顯示提示(比如寬度)來正確地標示這些字段?，F(xiàn)在我們可以編寫一個超類，它能夠提取出這個數(shù)據(jù)，比如說從一個在每個類里都帶有一些靜態(tài)支持方法的靜態(tài)數(shù)組里，但是這也意味著要強制給代碼分層。利用批注做到這一點就要簡單得多了?，F(xiàn)在讓我們從定義FormLabel.java里的FormLabel的批注開始：
import java.lang.annotation.*;
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public@interface FormLabel {String label();
int width() default 40;
}
你應(yīng)該注意到的第一件事是Java使用了它自己內(nèi)置的一些批注來定批注：@Retention和@Target。@Retention用來定義通過設(shè)置 RetentionPolicy的值批注能夠在構(gòu)建-運行過程中存留多久。這里我們使用了RUNTIME，這意味著我們定義的批注將會在運行期間被保留在代碼里。RetentionPolicy.SOURCE將被用于一個我們希望被編譯器使用然后拋棄的批注。RetentionPolicy.CLASS讓它們保留在生成的類文件里，但是能夠在運行期間被Java虛擬機(JVM)訪問到。
在默認情況下，你可以在代碼里的任何地方都應(yīng)用批注。 @Target批注讓你能夠?qū)⑺拗圃诖a的特定部分里。在本文里，我們把目標瞄準了ElementType.METHOD，這意味著它只能夠與方法關(guān)聯(lián)在一起。其他ElementTypes有CONSTRUCTOR、FIELD、LOCAL_VARIABLE、PACKAGE、PARAMETER和 TYPE，每個都能夠把批注限制到該種類型的Java語言元素，所以例如，設(shè)置TYPE將只允許批注為定義過的這種類型，比如：
@OurAnnotation
public class OurAnnotatedClass {…
值得注意的是，@Target批注能夠接受單個ElementType或者一個ElementType數(shù)組，如果你想要將批注限制為一系列語言元素的話。
下面一部分是批注接口的定義；這就像是一個普通的接口聲明，除了我們用@interface將其標記為一個批注。在這個接口里，我們?nèi)缓蠖x批注的方法，就像我們希望用在與批注相關(guān)聯(lián)的信息上的抽象方法，所以我們就有了String label()，用于一個叫做label的字符串屬性。如果我們沒有方法，那么批注就只能用于“做標記”，而@Overrides注釋就是這樣一個例子。如果你只有一個屬性，它最好被命名為“value”，因為當帶有一個未命名參數(shù)的批注在設(shè)置這個值時，它工作得最好。屬性還可以有默認值，比如“int width() default 40;”就是在定義一個默認值為40的整數(shù)屬性。
這就是批注定義。我們現(xiàn)在就可以在代碼里使用它了。下面一個SimpleData類就用到了它。
public class SimpleData {
private String firstname;
private String lastname;
private String postcode;
public SimpleData() {}
@FormLabel(label="First Name")
public String getFirstname() { return firstname; }
public void
setFirstname(String firstname) {this.firstname = firstname;}
@FormLabel(label="Last Name",width=80)
public String getLastname() { return lastname; }
public void setLastname(String lastname) {
this.lastname = lastname;
}
@FormLabel(label="Postal code",width=10)
public String getPostcode() { return postcode; }
public void setPostcode(String postcode) {
this.postcode = postcode;
}
}
當然，如果我們不查找批注，那么它們對代碼的執(zhí)行就不會造成任何不同。我們所需要的是在運行期間使用批注的方式；我們通過Reflection API來達到這一目的?，F(xiàn)在就讓我們創(chuàng)建一個簡單的processForm方法，它能夠在任何對象里查找批注。
public void processForm(Object o) {
for(Method m:o.getClass().getMethods()) {
我們將在傳遞給方法的對象的類里定義所有的方法?，F(xiàn)在，我們需要檢查每個方法，看看它們是否有FormLabel批注，以及是否返回一個String(為了簡單地說明問題，我們給所有的結(jié)果多返回一些代碼)：
if(m.isAnnotationPresent(FormLabel.class) &&
m.getReturnType()==String.class) {
現(xiàn)在我們可以通過使用Method的getAnnotation()方法來提取FormLabel批注：
FormLabel formLabel=
m.getAnnotation(FormLabel.class);
現(xiàn)在我們執(zhí)行方法來取得其字符串值，并通過在批注接口里定義的方法訪問批注屬性。下面我們就把它們打印出來：
try {
String value=(String)m.invoke(o);
String label=formLabel.label();
int width=formLabel.width();
System.out.printf("%s[%d]:%s\n",label,width,value);
} catch (IllegalArgumentException ex) {
ex.printStackTrace();
}
catch (IllegalAccessException ex) {
ex.printStackTrace();}
catch (InvocationTargetException ex) {
ex.printStackTrace();
}
}
}
}
現(xiàn)在我們可以創(chuàng)建含有@FormLabel批注的新類，并把它們傳遞給processForm方法。這是在運行期間訪問你自己的批注的基礎(chǔ)。
現(xiàn)在這個時候，我們回頭看看Java 5里面其他關(guān)于批注的內(nèi)容。首先是編譯器指令——@Deprecated和
@SuppressWarnings。@Deprecated是把方法標示為被否定的增強方法；不推薦把它用在新代碼里，以防止以后刪除。用@Deprecated可以生成一個來自編譯器的相關(guān)警告。
@SuppressWarnings會阻止編譯器在封閉代碼元素里警告你，所以你可以在類定義的開始或者對特定的方法使用
@SuppressWarnings。它可以帶參數(shù)，用來指定需要取消的錯誤的類型，例如：
@SuppressWarnings("unchecked")
public List getList() {
List l=new LinkedList();
return l;
}
這里我們?nèi)∠艘粋€關(guān)于在List和List之間的“未檢查”的強制轉(zhuǎn)換。當你開始用Java編程但是沒有非一般代碼的時候，這就非常有用。在取消警告的時候，盡可能地縮小取消的范圍是值得的；在上面的例子里，我們?nèi)∠苏麄€代碼。我們可以把它變緊湊，只隱藏一個語句的錯誤：
public List
getListToo() {
@SuppressWarnings("unchecked")
List l=new LinkedList();
return l;
}
要注意的是，你需要在Java2SE 1.5.06或者以上的版本上進行這項工作；這之前的版本沒有提供對@SuppressWarning支持。
Java 5里其他內(nèi)置的批注都與對批注的支持有關(guān)
——@Documented和@Inherited。它們都可以被加到批注定義里。@Documented的作用是，批注的使用應(yīng)該在所有生成的JavaDoc文檔里都反映出來。正如你可能看到的，批注和JavaDoc標記是互補的。@Inherited的意思是，當另外一個類用類來擴展批注時，批注應(yīng)該是可繼承的；在默認情況下，批注是不能被繼承的。
你可能很希望在自己的開發(fā)項目里使用Java批注的方法。就像我在引言里講到的，批注已經(jīng)成為現(xiàn)代Java框架和應(yīng)用程序的重要一部分；就拿 JUnit4舉個例子，Java批注已經(jīng)允許JUnit的開發(fā)人員有了以更豐富的方式表示測試的方法，而不用要求測試編寫者強制使用統(tǒng)一的命名規(guī)則。還有 Grails，這里批注可以被用來向“類似鐵軌(rails-like)”的框架提供信息。批注的能力有很多，但是要記住，能力越大，責任也越大。批注是為了給開發(fā)人員提供標記信息，而不是用來隱藏運行配置。