註解（Annotation）自定義註解入門

要深入學習註解，我們就必須能定義自己的註解，並使用註解，在定義自己的註解之前，我們就必須要了解Java爲我們提供的元註解和相關定義註解的語法。

元註解：

元註解的作用就是負責註解其他註解。Java5.0定義了4個標準的meta-annotation類型，它們被用來提供對其它annotation類型作說明。Java5.0定義的元註解：

1.@Target,

2.@Retention,

3.@Documented,

4.@Inherited

這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個元註解的作用和相應分參數的使用說明。

@Target：

@Target說明了Annotation所修飾的對象範圍：Annotation可被用於packages、types（類、接口、枚舉、Annotation類型）、類型成員（方法、構造方法、成員變量、枚舉值）、方法參數和本地變量（如循環變量、catch參數）。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標。

作用：用於描述註解的使用範圍（即：被描述的註解可以用在什麼地方）

取值(ElementType)有：

1.CONSTRUCTOR:用於描述構造器

2.FIELD:用於描述域

3.LOCAL_VARIABLE:用於描述局部變量

4.METHOD:用於描述方法

5.PACKAGE:用於描述包

6.PARAMETER:用於描述參數

7.TYPE:用於描述類、接口(包括註解類型) 或enum聲明

使用實例：

@Target(ElementType.TYPE)
public @interface Table {
    /**
     * 數據表名稱註解，默認值爲類名稱
     * @return
     */
    public String tableName() default"className";
}

@Target(ElementType.FIELD)
public @interface NoDBColumn {

}

註解Table 可以用於註解類、接口(包括註解類型)或enum聲明,而註解NoDBColumn僅可用於註解類的成員變量。

@Retention：

@Retention定義了該Annotation被保留的時間長短：某些Annotation僅出現在源代碼中，而被編譯器丟棄；而另一些卻被編譯在class文件中；編譯在class文件中的Annotation可能會被虛擬機忽略，而另一些在class被裝載時將被讀取（請注意並不影響class的執行，因爲Annotation與class在使用上是被分離的）。使用這個meta-Annotation可以對Annotation的“生命週期”限制。

作用：表示需要在什麼級別保存該註釋信息，用於描述註解的生命週期（即：被描述的註解在什麼範圍內有效）

取值（RetentionPoicy）有：

1.SOURCE:在源文件中有效（即源文件保留）

2.CLASS:在class文件中有效（即class保留）

3.RUNTIME:在運行時有效（即運行時保留）

Retentionmeta-annotation類型有唯一的value作爲成員，它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。具體實例如下：

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface Column {
    public String name() default"fieldName";
    public String setFuncName() default"setField";
    public String getFuncName() default"getField";
    public boolean defaultDBValue()default false;
}

　　Column註解的的RetentionPolicy的屬性值是RUTIME,這樣註解處理器可以通過反射，獲取到該註解的屬性值，從而去做一些運行時的邏輯處理

@Documented:

@Documented用於描述其它類型的annotation應該被作爲被標註的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化。Documented是一個標記註解，沒有成員。

@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Column {
    public String name() default"fieldName";
    public String setFuncName() default"setField";
    public String getFuncName() default"getField";
    public boolean defaultDBValue() defaultfalse;
}

@Inherited：

@Inherited元註解是一個標記註解，@Inherited闡述了某個被標註的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用於一個class，則這個annotation將被用於該class的子類。

注意：@Inheritedannotation類型是被標註過的class的子類所繼承。類並不從它所實現的接口繼承annotation，方法並不從它所重載的方法繼承annotation。

當@Inheritedannotation類型標註的annotation的Retention是RetentionPolicy.RUNTIME，則反射API增強了這種繼承性。如果我們使用java.lang.reflect去查詢一個@Inheritedannotation類型的annotation時，反射代碼檢查將展開工作：檢查class和其父類，直到發現指定的annotation類型被發現，或者到達類繼承結構的頂層。

實例代碼：

/**
*
* @author peida
*
*/
@Inherited
public @interface Greeting {
    public enum FontColor{BULE,RED,GREEN};
    String name();
    FontColor fontColor() defaultFontColor.GREEN;
}

自定義註解：

使用@interface自定義註解時，自動繼承了java.lang.annotation.Annotation接口，由編譯程序自動完成其他細節。在定義註解時，不能繼承其他的註解或接口。@interface用來聲明一個註解，其中的每一個方法實際上是聲明瞭一個配置參數。方法的名稱就是參數的名稱，返回值類型就是參數的類型（返回值類型只能是基本類型、Class、String、enum）。可以通過default來聲明參數的默認值。

定義註解格式：

public @interface 註解名 {定義體}

註解參數的可支持數據類型：

1.所有基本數據類型（int,float,boolean,byte,double,char,long,short)

2.String類型

3.Class類型

4.enum類型

5.Annotation類型

6.以上所有類型的數組

Annotation類型裏面的參數該怎麼設定:

第一,只能用public或默認(default)這兩個訪問權修飾.例如,Stringvalue();這裏把方法設爲defaul默認類型；

第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,Stringvalue();這裏的參數成員就爲String;

第三,如果只有一個參數成員,最好把參數名稱設爲"value",後加小括號.例:下面的例子FruitName註解就只有一個參數成員。

簡單的自定義註解和使用註解實例：

package annotation;

importjava.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* 水果名稱註解
* @author peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
String value() default"";
}

package annotation;

importjava.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* 水果顏色註解
* @author peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
    /**
     * 顏色枚舉
     * @author peida
     *
     */
    public enum Color{BULE,RED,GREEN};

    /**
     * 顏色屬性
     * @return
     */
    Color fruitColor() defaultColor.GREEN;

}

package annotation;

importannotation.FruitColor.Color;

public class Apple{

   @FruitName("Apple")
    private String appleName;

   @FruitColor(fruitColor=Color.RED)
    private String appleColor;




    public void setAppleColor(StringappleColor) {
        this.appleColor =appleColor;
    }
    public String getAppleColor(){
        return appleColor;
    }


    public void setAppleName(String appleName){
        this.appleName =appleName;
    }
    public String getAppleName(){
        return appleName;
    }

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

註解元素的默認值：

註解元素必須有確定的值，要麼在定義註解的默認值中指定，要麼在使用註解時指定，非基本類型的註解元素的值不可爲null。因此,使用空字符串或0作爲默認值是一種常用的做法。這個約束使得處理器很難表現一個元素的存在或缺失的狀態，因爲每個註解的聲明中，所有元素都存在，並且都具有相應的值，爲了繞開這個約束，我們只能定義一些特殊的值，例如空字符串或者負數，一次表示某個元素不存在，在定義註解時，這已經成爲一個習慣用法。例如：

1 package annotation;
2
3 importjava.lang.annotation.Documented;
4 import java.lang.annotation.ElementType;
5 importjava.lang.annotation.Retention;
6 importjava.lang.annotation.RetentionPolicy;
7 importjava.lang.annotation.Target;
8
9 /**
10 * 水果供應者註解
11 * @author peida
12 *
13 */
14 @Target(ElementType.FIELD)
15 @Retention(RetentionPolicy.RUNTIME)
16 @Documented
17 public @interface FruitProvider {
18     /**
19      * 供應商編號
20      * @return
21      */
22     public int id() default-1;
23
24     /**
25      * 供應商名稱
26      * @return
27      */
28     public String name() default"";
29
30     /**
31      * 供應商地址
32      * @return
33      */
34     public String address() default"";
35 }