快捷導(dǎo)航

基于Java 注解(Annotation)的基本概念詳解

更新時(shí)間：2013年04月23日 10:34:28 作者：

什么是注解（Annotation）：

　　Annotation（注解）就是Java提供了一種元程序中的元素關(guān)聯(lián)任何信息和著任何元數(shù)據(jù)（metadata）的途徑和方法。Annotion(注解)是一個(gè)接口，程序可以通過反射來獲取指定程序元素的Annotion對(duì)象，然后通過Annotion對(duì)象來獲取注解里面的元數(shù)據(jù)。

　　Annotation(注解)是JDK5.0及以后版本引入的。它可以用于創(chuàng)建文檔，跟蹤代碼中的依賴性，甚至執(zhí)行基本編譯時(shí)檢查。從某些方面看，annotation就像修飾符一樣被使用，并應(yīng)用于包、類型、構(gòu)造方法、方法、成員變量、參數(shù)、本地變量的聲明中。這些信息被存儲(chǔ)在Annotation的“name=value”結(jié)構(gòu)對(duì)中。

　　Annotation的成員在Annotation類型中以無參數(shù)的方法的形式被聲明。其方法名和返回值定義了該成員的名字和類型。在此有一個(gè)特定的默認(rèn)語法：允許聲明任何Annotation成員的默認(rèn)值：一個(gè)Annotation可以將name=value對(duì)作為沒有定義默認(rèn)值的Annotation成員的值，當(dāng)然也可以使用name=value對(duì)來覆蓋其它成員默認(rèn)值。這一點(diǎn)有些近似類的繼承特性，父類的構(gòu)造函數(shù)可以作為子類的默認(rèn)構(gòu)造函數(shù)，但是也可以被子類覆蓋。

　　Annotation能被用來為某個(gè)程序元素（類、方法、成員變量等）關(guān)聯(lián)任何的信息。需要注意的是，這里存在著一個(gè)基本的規(guī)則：Annotation不能影響程序代碼的執(zhí)行，無論增加、刪除 Annotation，代碼都始終如一的執(zhí)行。另外，盡管一些annotation通過java的反射api方法在運(yùn)行時(shí)被訪問，而java語言解釋器在工作時(shí)忽略了這些annotation。正是由于java虛擬機(jī)忽略了Annotation，導(dǎo)致了annotation類型在代碼中是“不起作用”的；只有通過某種配套的工具才會(huì)對(duì)annotation類型中的信息進(jìn)行訪問和處理。本文中將涵蓋標(biāo)準(zhǔn)的Annotation和meta-annotation類型，陪伴這些annotation類型的工具是java編譯器（當(dāng)然要以某種特殊的方式處理它們）。

--------------------------------------------------------------------------------

什么是metadata（元數(shù)據(jù)）：

　　元數(shù)據(jù)從metadata一詞譯來，就是“關(guān)于數(shù)據(jù)的數(shù)據(jù)”的意思。
　　元數(shù)據(jù)的功能作用有很多，比如：你可能用過Javadoc的注釋自動(dòng)生成文檔。這就是元數(shù)據(jù)功能的一種?？偟膩碚f，元數(shù)據(jù)可以用來創(chuàng)建文檔，跟蹤代碼的依賴性，執(zhí)行編譯時(shí)格式檢查，代替已有的配置文件。如果要對(duì)于元數(shù)據(jù)的作用進(jìn)行分類，目前還沒有明確的定義，不過我們可以根據(jù)它所起的作用，大致可分為三類：
　　　　1. 編寫文檔：通過代碼里標(biāo)識(shí)的元數(shù)據(jù)生成文檔
　　　　2. 代碼分析：通過代碼里標(biāo)識(shí)的元數(shù)據(jù)對(duì)代碼進(jìn)行分析
　　　　3. 編譯檢查：通過代碼里標(biāo)識(shí)的元數(shù)據(jù)讓編譯器能實(shí)現(xiàn)基本的編譯檢查
　　在Java中元數(shù)據(jù)以標(biāo)簽的形式存在于Java代碼中，元數(shù)據(jù)標(biāo)簽的存在并不影響程序代碼的編譯和執(zhí)行，它只是被用來生成其它的文件或針在運(yùn)行時(shí)知道被運(yùn)行代碼的描述信息。
　　綜上所述：
　　　　第一，元數(shù)據(jù)以標(biāo)簽的形式存在于Java代碼中。
　　　　第二，元數(shù)據(jù)描述的信息是類型安全的，即元數(shù)據(jù)內(nèi)部的字段都是有明確類型的。
　　　　第三，元數(shù)據(jù)需要編譯器之外的工具額外的處理用來生成其它的程序部件。
　　　　第四，元數(shù)據(jù)可以只存在于Java源代碼級(jí)別，也可以存在于編譯之后的Class文件內(nèi)部。

--------------------------------------------------------------------------------

Annotation和Annotation類型：

　　Annotation：

　　Annotation使用了在java5.0所帶來的新語法，它的行為十分類似public、final這樣的修飾符。每個(gè)Annotation具有一個(gè)名字和成員個(gè)數(shù)>=0。每個(gè)Annotation的成員具有被稱為name=value對(duì)的名字和值（就像javabean一樣），name=value裝載了Annotation的信息。

　　Annotation類型：

　　Annotation類型定義了Annotation的名字、類型、成員默認(rèn)值。一個(gè)Annotation類型可以說是一個(gè)特殊的java接口，它的成員變量是受限制的，而聲明Annotation類型時(shí)需要使用新語法。當(dāng)我們通過java反射api訪問Annotation時(shí)，返回值將是一個(gè)實(shí)現(xiàn)了該 annotation類型接口的對(duì)象，通過訪問這個(gè)對(duì)象我們能方便的訪問到其Annotation成員。后面的章節(jié)將提到在java5.0的 java.lang包里包含的3個(gè)標(biāo)準(zhǔn)Annotation類型。

--------------------------------------------------------------------------------

注解的分類：

　　根據(jù)注解參數(shù)的個(gè)數(shù)，我們可以將注解分為三類：
　　　　1.標(biāo)記注解:一個(gè)沒有成員定義的Annotation類型被稱為標(biāo)記注解。這種Annotation類型僅使用自身的存在與否來為我們提供信息。比如后面的系統(tǒng)注解@Override;
　　　　2.單值注解
　　　　3.完整注解　　

　　根據(jù)注解使用方法和用途，我們可以將Annotation分為三類：
　　　　1.JDK內(nèi)置系統(tǒng)注解
　　　　2.元注解
　　　　3.自定義注解

--------------------------------------------------------------------------------

系統(tǒng)內(nèi)置標(biāo)準(zhǔn)注解：

　　注解的語法比較簡(jiǎn)單，除了@符號(hào)的使用外，他基本與Java固有的語法一致，JavaSE中內(nèi)置三個(gè)標(biāo)準(zhǔn)注解，定義在java.lang中：
　　　　@Override：用于修飾此方法覆蓋了父類的方法;
　　　　@Deprecated：用于修飾已經(jīng)過時(shí)的方法;
　　　　@SuppressWarnnings:用于通知java編譯器禁止特定的編譯警告。

　　下面我們依次看看三個(gè)內(nèi)置標(biāo)準(zhǔn)注解的作用和使用場(chǎng)景。

--------------------------------------------------------------------------------

　　@Override，限定重寫父類方法：

　　@Override 是一個(gè)標(biāo)記注解類型，它被用作標(biāo)注方法。它說明了被標(biāo)注的方法重載了父類的方法，起到了斷言的作用。如果我們使用了這種Annotation在一個(gè)沒有覆蓋父類方法的方法時(shí)，java編譯器將以一個(gè)編譯錯(cuò)誤來警示。這個(gè)annotaton常常在我們?cè)噲D覆蓋父類方法而確又寫錯(cuò)了方法名時(shí)發(fā)揮威力。使用方法極其簡(jiǎn)單：在使用此annotation時(shí)只要在被修飾的方法前面加上@Override即可。下面的代碼是一個(gè)使用@Override修飾一個(gè)企圖重載父類的displayName()方法，而又存在拼寫錯(cuò)誤的實(shí)例：

復(fù)制代碼代碼如下:

public class Fruit {

    public void displayName(){
        System.out.println("水果的名字是：*****");
    }
}

class Orange extends Fruit {
    @Override
    public void displayName(){
        System.out.println("水果的名字是：桔子");
    }
}

class Apple extends Fruit {
    @Override
    public void displayname(){
        System.out.println("水果的名字是：蘋果");
    }
}

　 Orange 類編譯不會(huì)有任何問題，Apple 類在編譯的時(shí)候會(huì)提示相應(yīng)的錯(cuò)誤。@Override注解只能用于方法，不能用于其他程序元素。
--------------------------------------------------------------------------------

@Deprecated，標(biāo)記已過時(shí)：

　　同樣Deprecated也是一個(gè)標(biāo)記注解。當(dāng)一個(gè)類型或者類型成員使用@Deprecated修飾的話，編譯器將不鼓勵(lì)使用這個(gè)被標(biāo)注的程序元素。而且這種修飾具有一定的 “延續(xù)性”：如果我們?cè)诖a中通過繼承或者覆蓋的方式使用了這個(gè)過時(shí)的類型或者成員，雖然繼承或者覆蓋后的類型或者成員并不是被聲明為 @Deprecated，但編譯器仍然要報(bào)警。

　　值得注意，@Deprecated這個(gè)annotation類型和javadoc中的 @deprecated這個(gè)tag是有區(qū)別的：前者是java編譯器識(shí)別的，而后者是被javadoc工具所識(shí)別用來生成文檔（包含程序成員為什么已經(jīng)過時(shí)、它應(yīng)當(dāng)如何被禁止或者替代的描述）。

　　在java5.0，java編譯器仍然象其從前版本那樣尋找@deprecated這個(gè)javadoc tag，并使用它們產(chǎn)生警告信息。但是這種狀況將在后續(xù)版本中改變，我們應(yīng)在現(xiàn)在就開始使用@Deprecated來修飾過時(shí)的方法而不是 @deprecated javadoc tag。

　　下面一段程序中使用了@Deprecated注解標(biāo)示方法過期，同時(shí)在方法注釋中用@deprecated tag 標(biāo)示該方法已經(jīng)過時(shí)，代碼如下：

復(fù)制代碼代碼如下:

class AppleService {
    public void displayName(){
        System.out.println("水果的名字是：蘋果");
    }

    /**
     * @deprecated 該方法已經(jīng)過期，不推薦使用
     */
    @Deprecated
    public void showTaste(){
        System.out.println("水果的蘋果的口感是：脆甜");
    }

    public void showTaste(int typeId){
        if(typeId==1){
            System.out.println("水果的蘋果的口感是：酸澀");
        }
        else if(typeId==2){
            System.out.println("水果的蘋果的口感是：綿甜");
        }
        else{
            System.out.println("水果的蘋果的口感是：脆甜");
        }
    }
}

public class FruitRun {

    /**
     * @param args
     */
    public static void main(String[] args) {
        Apple apple=new Apple();
        apple.displayName();

        AppleService appleService=new AppleService();
        appleService.showTaste();
        appleService.showTaste(0);
        appleService.showTaste(2);
    }

}

　　AppleService類的showTaste() 方法被@Deprecated標(biāo)注為過時(shí)方法，在FruitRun類中使用的時(shí)候，編譯器會(huì)給出該方法已過期，不推薦使用的提示。

--------------------------------------------------------------------------------

SuppressWarnnings，抑制編譯器警告：

　　@SuppressWarnings 被用于有選擇的關(guān)閉編譯器對(duì)類、方法、成員變量、變量初始化的警告。在java5.0，sun提供的javac編譯器為我們提供了-Xlint選項(xiàng)來使編譯器對(duì)合法的程序代碼提出警告，此種警告從某種程度上代表了程序錯(cuò)誤。例如當(dāng)我們使用一個(gè)generic collection類而又沒有提供它的類型時(shí)，編譯器將提示出"unchecked warning"的警告。通常當(dāng)這種情況發(fā)生時(shí)，我們就需要查找引起警告的代碼。如果它真的表示錯(cuò)誤，我們就需要糾正它。例如如果警告信息表明我們代碼中的switch語句沒有覆蓋所有可能的case，那么我們就應(yīng)增加一個(gè)默認(rèn)的case來避免這種警告。
　　有時(shí)我們無法避免這種警告，例如，我們使用必須和非generic的舊代碼交互的generic collection類時(shí)，我們不能避免這個(gè)unchecked warning。此時(shí)@SuppressWarning就要派上用場(chǎng)了，在調(diào)用的方法前增加@SuppressWarnings修飾，告訴編譯器停止對(duì)此方法的警告。
　　SuppressWarning不是一個(gè)標(biāo)記注解。它有一個(gè)類型為String[]的成員，這個(gè)成員的值為被禁止的警告名。對(duì)于javac編譯器來講，被-Xlint選項(xiàng)有效的警告名也同樣對(duì)@SuppressWarings有效，同時(shí)編譯器忽略掉無法識(shí)別的警告名。
　　annotation語法允許在annotation名后跟括號(hào)，括號(hào)中是使用逗號(hào)分割的name=value對(duì)用于為annotation的成員賦值。實(shí)例如下：

復(fù)制代碼代碼如下:

public class FruitService {

    @SuppressWarnings(value={ "rawtypes", "unchecked" })
    public static List<Fruit> getFruitList(){
        List<Fruit> fruitList=new ArrayList();
        return fruitList;
    }

    @SuppressWarnings({ "rawtypes", "unchecked" })
    public static List<Fruit> getFruit(){
        List<Fruit> fruitList=new ArrayList();
        return fruitList;
    }

    @SuppressWarnings("unused")
    public static void main(String[] args){
        List<String> strList=new ArrayList<String>();
    }
}

　　在這個(gè)例子中SuppressWarnings annotation類型只定義了一個(gè)單一的成員，所以只有一個(gè)簡(jiǎn)單的value={...}作為name=value對(duì)。又由于成員值是一個(gè)數(shù)組，故使用大括號(hào)來聲明數(shù)組值。注意：我們可以在下面的情況中縮寫annotation：當(dāng)annotation只有單一成員，并成員命名為"value="。這時(shí)可以省去"value="。比如將上面方法getFruit()的SuppressWarnings annotation就是縮寫的。

　 SuppressWarnings注解的常見參數(shù)值的簡(jiǎn)單說明：

　　　　1.deprecation：使用了不贊成使用的類或方法時(shí)的警告；
　　　　2.unchecked：執(zhí)行了未檢查的轉(zhuǎn)換時(shí)的警告，例如當(dāng)使用集合時(shí)沒有用泛型 (Generics) 來指定集合保存的類型;
　　　　3.fallthrough：當(dāng) Switch 程序塊直接通往下一種情況而沒有 Break 時(shí)的警告;
　　　　4.path：在類路徑、源文件路徑等中有不存在的路徑時(shí)的警告;
　　　　5.serial：當(dāng)在可序列化的類上缺少 serialVersionUID 定義時(shí)的警告;
　　　　6.finally：任何 finally 子句不能正常完成時(shí)的警告;
　　　　7.all：關(guān)于以上所有情況的警告。

您可能感興趣的文章: