1、引入
l 編程的一個最新趨勢,尤其是 Java 編程,就是使用元數據
l 元數據可以用于創建文檔,跟蹤代碼中的依賴性,甚至執行基本編譯時檢查
l 許多元數據工具(如 Xdoclet)將這些功能添加到核心 Java 語言中,暫時成為 Java 編程功能的一部分
l Javadoc是元數據工具,但除了生成文檔之外,沒有固定、實用、標準化的方式將數據用于其他用途,而且HTML代碼經常混入到Javadoc輸出中,更進一步降低了其用于任何其它目的的價值
l JSR 175,Java編程語言的元數據工具,為將元數據合并到核心 Java 語言中提供了正式理由和說明
l Tiger 增加了Annotation的新功能,將一個更通用的元數據工具合并到核心 Java 語言中
l Annotation是可以添加到代碼中的修飾符,可以用于包聲明、類型聲明、構造函數、方法、域變量、參數和變量
l Tiger包含內置的Annotation,還支持自己編寫的定制Annotation
l 本部分將概述元數據的優點,并介紹Tiger的內置Annotation
2、元數據的價值
一般來說,元數據的好處分為三類:文檔編制、編譯器檢查和代碼分析
(1)文檔編制
l 代碼級文檔最常被引用,但對于將元數據添加到 Java 語言中來說,文檔編制可能是最不相關的理由
l 因為Javadoc已經提供了非常容易理解和健壯的方法來文檔化代碼
(2)編譯時檢查
l 元數據更重要的優點是編譯器可以使用它來執行基本的編譯時檢查
l 具體情況請參看后面介紹的Tiger內置Annotation:@Override
(3)代碼分析
l 元數據工具的最好功能就是可以使用額外數據來分析代碼
l 簡單的案例就是:許多時候,方法的參數類型或返回類型實際上不是該方法想要的類型;例如,參數類型可能是Object,但方法可能僅使用Integer,這在覆蓋超類的方法時很容易發生;元數據可以指示代碼分析工具:雖然參數類型是 Object,但 Integer 才是真正需要的
l 復雜的案例就是:即使是簡單EJB系統中也具有很強的依賴性和復雜性,要具有 Home和Remote接口,以及本地的Home 和Remote接口,以及一個實現類,保持所有這些類同步非常困難;好的工具(如XDoclet)可以管理所有這些依賴性,并確保這些沒有“代碼級”聯系,但有“邏輯級”聯系的類保持同步;元數據在這里確實可以發揮它的作用
3、Annotation基礎
l Annotation的格式是:@Annotation名
l 在Annotation需要數據時,通過name=value的形式提供
l 代碼中可以用很多Annotation,有些Annotation會具有相同的Annotation類型
l Annotation類型和Annotation的概念類似于類和對象的概念
l Annotation有三種基本種類:
? 標記Annotation:只有Annotation名,不包含數據,如@MarkerAnnotation
? 單值Annotation:只有單一的數據,可以簡化name=value的形式為value形式,如@SingleValueAnnotation("my data")
? 完整格式的Annotation:有多個數據成員,如@FullAnnotation(var1="data value 1", var2="data value 2", var3="data value 3")
l 可以使用花括號向Annotation變量提供值數組,如
@TODOItems({ // Curly braces indicate an array of values is being supplied
@TODO(
severity=TODO.CRITICAL,
item="Add functionality to calculate the mean of the student's grades",
assignedTo="Brett McLaughlin"
),
@TODO(
severity=TODO.IMPOTANT,
item="Print usage message to screen if no command-line flags specified",
assignedTo="Brett McLaughlin"
),
@TODO(
severity=TODO.LOW,
item="Roll a new website page with this class's new features",
assignedTo="Jason Hunter"
)
})
4、Tiger內置Annotation
(1)@Override
l @Override只用于方法,指明改方法覆蓋超類中的對應方法
l 簡單例子:
public class OverrideTester {
public OverrideTester() {
}
@Override public String toString() {
return super.toString() + " [Override Tester Implementation]";
}
@Override public int hashCode() {
return toString().hashCode();
}
}
l @Override可以檢查輸入錯誤導致無法覆蓋超類方法的問題,例如hashCode()錯誤的輸入為hasCode(),在編譯時就會報錯:
The method hasCode() of type OverrideTester must override a superclass method
l 這個便捷的小功能將幫助快速捕獲打字錯誤
(2)@Deprecated
l 同樣只用于方法,指明該方法不應該再使用了
l 簡單例子:
public class DeprecatedClass {
@Deprecated public void doSomething() {
System.out.println("Deprecated method!");
// some code
}
public void doSomethingElse() {
// This method presumably does what doSomething() does, but better
}
}
l 單獨編譯正常通過,如果通過覆蓋或調用Deprecated的方法,編譯器會給出警告信息
l 注:本人在Eclipse 3.1M4環境中測試,根本不起作用(即使是改了編譯參數,why?),在命令行下使用-Xlint:deprecated參數,JAVAC只給出警告信息,編譯還是通過的
(3)@SuppressWarnings
l Tiger的泛型功能使得編譯器對類型的安全性進行檢查,特別是Java集合,如下面的例子:
public void nonGenericsMethod() {
List wordList = new ArrayList(); // no typing information on the List
wordList.add("foo"); // causes error on list addition
}
l 編譯器會給出下面的警告信息:
Type safety: The method add(Object) belongs to the raw type List. References to generic
type List<E> should be parameterized
l 這對于Tiger的代碼是很有幫助的,但對于JDK1.4及以前版本,不斷的收到無關的警告信息是很煩人的
l 可以使用@SuppressWarnings來阻止指定類型的警告信息,如:
@SuppressWarnings(value = { "unchecked" })
public void nonGenericsMethod() {
List wordList = new ArrayList(); // no typing information on the List
wordList.add("foo"); // causes error on list addition
}
l 傳遞給@SuppressWarnings的類型值是一個數組,因此可以同時阻止多種類型的警告信息
l 類型值是由編譯器廠商所指定的,所以上面的例子我在Eclipse 3.1M4環境和命令行中測試,都不起作用,大概是類型值沒有指定對吧