深刻理解Java：註解（Annotation）基本概念

深刻理解Java：註解（Annotation）基本概念

什麼是註解（Annotation）：

　　Annotation（註解）就是Java提供了一種元程序中的元素關聯任何信息和着任何元數據（metadata）的途徑和方法。Annotion(註解)是一個接口，程序能夠經過反射來獲取指定程序元素的Annotion對象，而後經過Annotion對象來獲取註解裏面的元數據。

　　Annotation(註解)是JDK5.0及之後版本引入的。它能夠用於建立文檔，跟蹤代碼中的依賴性，甚至執行基本編譯時檢查。從某些方面看，annotation就像修飾符同樣被使用，並應用於包、類 型、構造方法、方法、成員變量、參數、本地變量的聲明中。這些信息被存儲在Annotation的「name=value」結構對中。

　　Annotation的成員在Annotation類型中以無參數的方法的形式被聲明。其方法名和返回值定義了該成員的名字和類型。在此有一個特定的默認語法：容許聲明任何Annotation成員的默認值：一個Annotation能夠將name=value對做爲沒有定義默認值的Annotation成員的值，固然也可使用name=value對來覆蓋其它成員默認值。這一點有些近似類的繼承特性，父類的構造函數能夠做爲子類的默認構造函數，可是也能夠被子類覆蓋。

　　Annotation能被用來爲某個程序元素（類、方法、成員變量等）關聯任何的信息。須要注意的是，這裏存在着一個基本的規則：Annotation不能影響程序代碼的執行，不管增長、刪除 Annotation，代碼都始終如一的執行。另外，儘管一些annotation經過java的反射api方法在運行時被訪問，而java語言解釋器在工做時忽略了這些annotation。正是因爲java虛擬機忽略了Annotation，致使了annotation類型在代碼中是「不起做用」的； 只有經過某種配套的工具纔會對annotation類型中的信息進行訪問和處理。本文中將涵蓋標準的Annotation和meta-annotation類型，陪伴這些annotation類型的工具是java編譯器（固然要以某種特殊的方式處理它們）。

---

什麼是metadata（元數據）：

　　元數據從metadata一詞譯來，就是「關於數據的數據」的意思。
　　元數據的功能做用有不少，好比：你可能用過Javadoc的註釋自動生成文檔。這就是元數據功能的一種。總的來講，元數據能夠用來建立文檔，跟蹤代碼的依賴性，執行編譯時格式檢查，代替已有的配置文件。若是要對於元數據的做用進行分類，目前尚未明確的定義，不過咱們能夠根據它所起的做用，大體可分爲三類： 
　　　　1. 編寫文檔：經過代碼裏標識的元數據生成文檔
　　　　2. 代碼分析：經過代碼裏標識的元數據對代碼進行分析
　　　　3. 編譯檢查：經過代碼裏標識的元數據讓編譯器能實現基本的編譯檢查
　　在Java中元數據以標籤的形式存在於Java代碼中，元數據標籤的存在並不影響程序代碼的編譯和執行，它只是被用來生成其它的文件或針在運行時知道被運行代碼的描述信息。
　　綜上所述：
　　　　第一，元數據以標籤的形式存在於Java代碼中。
　　　　第二，元數據描述的信息是類型安全的，即元數據內部的字段都是有明確類型的。
　　　　第三，元數據須要編譯器以外的工具額外的處理用來生成其它的程序部件。
　　　　第四，元數據能夠只存在於Java源代碼級別，也能夠存在於編譯以後的Class文件內部。

---

 Annotation和Annotation類型：

　　Annotation：

　　Annotation使用了在java5.0所帶來的新語法，它的行爲十分相似public、final這樣的修飾符。每一個Annotation具備一個名字和成員個數>=0。每一個Annotation的成員具備被稱爲name=value對的名字和值（就像javabean同樣），name=value裝載了Annotation的信息。

　　Annotation類型：

　　Annotation類型定義了Annotation的名字、類型、成員默認值。一個Annotation類型能夠說是一個特殊的java接口，它的成員變量是受限制的，而聲明Annotation類型時須要使用新語法。當咱們經過java反射api訪問Annotation時，返回值將是一個實現了該 annotation類型接口的對象，經過訪問這個對象咱們能方便的訪問到其Annotation成員。後面的章節將提到在java5.0的 java.lang包裏包含的3個標準Annotation類型。

---

註解的分類：

　　根據註解參數的個數，咱們能夠將註解分爲三類：
　　　　1.標記註解:一個沒有成員定義的Annotation類型被稱爲標記註解。這種Annotation類型僅使用自身的存在與否來爲咱們提供信息。好比後面的系統註解@Override;
　　　　2.單值註解
　　　　3.完整註解　　

　　根據註解使用方法和用途，咱們能夠將Annotation分爲三類：
　　　　1.JDK內置系統註解
　　　　2.元註解
　　　　3.自定義註解

---

 系統內置標準註解：

　　註解的語法比較簡單，除了@符號的使用外，他基本與Java固有的語法一致，JavaSE中內置三個標準註解，定義在java.lang中：
　　　　@Override：用於修飾此方法覆蓋了父類的方法;
　　　　@Deprecated：用於修飾已通過時的方法;
　　　　@SuppressWarnnings:用於通知java編譯器禁止特定的編譯警告。

　　下面咱們依次看看三個內置標準註解的做用和使用場景。

---

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

　　@Override 是一個標記註解類型，它被用做標註方法。它說明了被標註的方法重載了父類的方法，起到了斷言的做用。若是咱們使用了這種Annotation在一個沒有覆蓋父類方法的方法時，java編譯器將以一個編譯錯誤來警示。這個annotaton經常在咱們試圖覆蓋父類方法而確又寫錯了方法名時發揮威力。使用方法極其簡單：在使用此annotation時只要在被修飾的方法前面加上@Override便可。下面的代碼是一個使用@Override修飾一個企圖重載父類的displayName()方法，而又存在拼寫錯誤的實例：

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 類編譯不會有任何問題，Apple 類在編譯的時候會提示相應的錯誤。@Override註解只能用於方法，不能用於其餘程序元素。

---

@Deprecated，標記已過期：

　　同 樣Deprecated也是一個標記註解。當一個類型或者類型成員使用@Deprecated修飾的話，編譯器將不鼓勵使用這個被標註的程序元素。並且這種修飾具備必定的 「延續性」：若是咱們在代碼中經過繼承或者覆蓋的方式使用了這個過期的類型或者成員，雖然繼承或者覆蓋後的類型或者成員並非被聲明爲 @Deprecated，但編譯器仍然要報警。

　　值得注意，@Deprecated這個annotation類型和javadoc中的 @deprecated這個tag是有區別的：前者是java編譯器識別的，然後者是被javadoc工具所識別用來生成文檔（包含程序成員爲何已通過 時、它應當如何被禁止或者替代的描述）。

　　在java5.0，java編譯器仍然象其從前版本那樣尋找@deprecated這個javadoc tag，並使用它們產生警告信息。可是這種情況將在後續版本中改變，咱們應在如今就開始使用@Deprecated來修飾過期的方法而不是 @deprecated javadoc tag。

　　下面一段程序中使用了@Deprecated註解標示方法過時，同時在方法註釋中用@deprecated tag 標示該方法已通過時，代碼以下：

 class AppleService {
    public void displayName(){
        System.out.println("水果的名字是：蘋果");
    }
    
    /**
     * @deprecated 該方法已通過期，不推薦使用
     */
    @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標註爲過期方法，在FruitRun類中使用的時候，編譯器會給出該方法已過時，不推薦使用的提示。

---

SuppressWarnnings，抑制編譯器警告：

　　@SuppressWarnings 被用於有選擇的關閉編譯器對類、方法、成員變量、變量初始化的警告。在java5.0，sun提供的javac編譯器爲咱們提供了-Xlint選項來使編譯器對合法的程序代碼提出警告，此種警告從某種程度上表明瞭程序錯誤。例如當咱們使用一個generic collection類而又沒有提供它的類型時，編譯器將提示出"unchecked warning"的警告。一般當這種狀況發生時，咱們就須要查找引發警告的代碼。若是它真的表示錯誤，咱們就須要糾正它。例如若是警告信息代表咱們代碼中的switch語句沒有覆蓋全部可能的case，那麼咱們就應增長一個默認的case來避免這種警告。
　　有時咱們沒法避免這種警告，例如，咱們使用必須和非generic的舊代碼交互的generic collection類時，咱們不能避免這個unchecked warning。此時@SuppressWarning就要派上用場了，在調用的方法前增長@SuppressWarnings修飾，告訴編譯器中止對此方法的警告。
　　SuppressWarning不是一個標記註解。它有一個類型爲String[]的成員，這個成員的值爲被禁止的警告名。對於javac編譯器來說，被-Xlint選項有效的警告 名也一樣對@SuppressWarings有效，同時編譯器忽略掉沒法識別的警告名。
　　annotation語法容許在annotation名後跟括號，括號中是使用逗號分割的name=value對用於爲annotation的成員賦值。實例以下：

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>();
    }
}

　　在這個例子中SuppressWarnings annotation類型只定義了一個單一的成員，因此只有一個簡單的value={...}做爲name=value對。又因爲成員值是一個數組，故使用大括號來聲明數組值。注意：咱們能夠在下面的狀況中縮寫annotation：當annotation只有單一成員，併成員命名爲"value="。這時能夠省去"value="。好比將上面方法getFruit()的SuppressWarnings annotation就是縮寫的。

 　 SuppressWarnings註解的常見參數值的簡單說明：

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