JAVA Annotation 自定義註解

    Annotation（註解），是源代碼的元數據

    本質一：它是一個附屬品，依賴其它元素存在

    本質二： 自己沒有任何做用，在恰當的時候由外部程序解析產生做用

    做用：簡化配置，增長代碼可讀性，提升系統的可維護性

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

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

Java元註解和相關定義註解的語法

元註解：

    元註解的做用就是負責註解其餘註解。Java5.0定義了4個標準的meta-annotation類型，它們被用來提供對其它 annotation類型做說明。Java5.0定義的元註解：
    1.@Target,2.@Retention,3.@Documented,4.@Inherited
    這些類型和它們所支持的類在java.lang.annotation包中能夠找到。下面咱們看一下每一個元註解的做用和相應分參數的使用說明。

@Retention: 定義註解的保留策略

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

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

    取值（RetentionPoicy）有：

        @Retention(RetentionPolicy.SOURCE)   //註解僅存在於源碼中，在class字節碼文件中不包含

        @Retention(RetentionPolicy.CLASS)     // 默認的保留策略，註解會在class字節碼文件中存在，但運行時沒法得到，

        @Retention(RetentionPolicy.RUNTIME)  // 註解會在class字節碼文件中存在，在運行時能夠經過反射獲取到

@Target：定義註解的做用目標

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

    做用：用於描述註解的使用範圍（即：被描述的註解能夠用在什麼地方）

    取值（RetentionPoicy）有：

        @Target(ElementType.TYPE)   //接口、類、枚舉、註解

        @Target(ElementType.FIELD) //字段、枚舉的常量

        @Target(ElementType.METHOD) //方法

        @Target(ElementType.PARAMETER) //方法參數

        @Target(ElementType.CONSTRUCTOR)  //構造函數

        @Target(ElementType.LOCAL_VARIABLE)//局部變量

        @Target(ElementType.ANNOTATION_TYPE)//註解

        @Target(ElementType.PACKAGE) ///包   

@Document：說明該註解將被包含在javadoc中

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

@Inherited：說明子類能夠繼承父類中的該註解

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

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

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

 

自定義註解：

    使用@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)這兩個訪問權修飾.例如,String value();這裏把方法設爲defaul默認類型；　 　
    第二,參數成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數據類型和 String,Enum,Class,annotations等數據類型,以及這一些類型的數組.例如,String value();這裏的參數成員就爲String;　　
    第三,若是隻有一個參數成員,最好把參數名稱設爲"value",後加小括號.例:下面的例子FruitName註解就只有一個參數成員。

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

package org.lvgang;

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

/**
 * 個人姓名註解
 * @author lvgang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyName {
    String value() default "";
}

    

package org.lvgang;

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

/**
 * 顏色註解
 * @author lvgang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface MyColor {
    /**
     * 顏色枚舉
     * @author peida
     *
     */
    public enum Color{ BULE,RED,GREEN};
    
    /**
     * 顏色屬性
     * @return
     */
    Color myColor() default Color.GREEN;

}

 

package org.lvgang;

import org.lvgang.MyColor.Color;

public class My{
    
    @MyName("lvgang")
    private String name;
    
    @MyColor(myColor=Color.RED)
    private String color;
    
    public void setColor(String color) {
        this.color = color;
    }
    public String getColor() {
        return color;
    }
    
    public void setName(String appleName) {
        this.name = name;
    }
    public String getName() {
        return name;
    }
}

    註解元素的默認值：

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

package org.lvgang;

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

/**
 * 應者註解
 * @author lvgang
 *
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Provider {
    /**
     * 編號
     * @return
     */
    public int id() default -1;
    
    /**
     * 名稱
     * @return
     */
    public String name() default "";
    
    /**
     * 地址
     * @return
     */
    public String address() default "";
}

    定義了註解，並在須要的時候給相關類，類屬性加上註解信息，若是沒有響應的註解信息處理流程，註解能夠說是沒有實用價值。如何讓註解真真的發揮做用，主要就在於註解處理方法，下一步咱們將學習註解信息的獲取和處理！