前言#
之前已經(jīng)簡單介紹了系統(tǒng)的內(nèi)置注解肚逸，我們已經(jīng)對注解有了一個(gè)初步的印象认境，接下來就來看看如何自定義注解。
此文章仍然轉(zhuǎn)載自上一篇的作者课竣，因?yàn)樗麑懙膶?shí)在是太好了嘉赎，非常適合剛接觸注解的朋友去看置媳，原文的連接地址 http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html。
正文#
元注解：
元注解的作用就是負(fù)責(zé)注解其他注解曹阔。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型半开，它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解：
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
這些類型和它們所支持的類在java.lang.annotation包中可以找到赃份。下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說明。
@Target：
@Target說明了Annotation所修飾的對象范圍：Annotation可被用于 packages奢米、types（類抓韩、接口、枚舉鬓长、Annotation類型）谒拴、類型成員（方法、構(gòu)造方法涉波、成員變量英上、枚舉值）、方法參數(shù)和本地變量（如循環(huán)變量啤覆、catch參數(shù)）苍日。在Annotation類型的聲明中使用了target可更加明晰其修飾的目標(biāo)。
作用：用于描述注解的使用范圍（即：被描述的注解可以用在什么地方）
取值(ElementType)有：
1.CONSTRUCTOR:用于描述構(gòu)造器
2.FIELD:用于描述域
3.LOCAL_VARIABLE:用于描述局部變量
4.METHOD:用于描述方法
5.PACKAGE:用于描述包
6.PARAMETER:用于描述參數(shù)
7.TYPE:用于描述類窗声、接口(包括注解類型) 或enum聲明
使用實(shí)例：
@Target(ElementType.TYPE)
public @interface Table {
/**
* 數(shù)據(jù)表名稱注解相恃，默認(rèn)值為類名稱
* @return
*/
public String tableName() default "className";
}
@Target(ElementType.FIELD)
public @interface NoDBColumn {
}
注解Table 可以用于注解類、接口(包括注解類型) 或enum聲明,而注解NoDBColumn僅可用于注解類的成員變量笨觅。
@Retention：
@Retention定義了該Annotation被保留的時(shí)間長短：某些Annotation僅出現(xiàn)在源代碼中拦耐，而被編譯器丟棄；而另一些卻被編譯在class文件中见剩；編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略杀糯，而另一些在class被裝載時(shí)將被讀取（請注意并不影響class的執(zhí)行苍苞，因?yàn)锳nnotation與class在使用上是被分離的）固翰。使用這個(gè)meta-Annotation可以對 Annotation的“生命周期”限制。
作用：表示需要在什么級(jí)別保存該注釋信息柒啤，用于描述注解的生命周期（即：被描述的注解在什么范圍內(nèi)有效）
取值（RetentionPoicy）有：
1.SOURCE:在源文件中有效（即源文件保留）
2.CLASS:在class文件中有效（即class保留）
3.RUNTIME:在運(yùn)行時(shí)有效（即運(yùn)行時(shí)保留）
Retention meta-annotation類型有唯一的value作為成員倦挂，它的取值來自java.lang.annotation.RetentionPolicy的枚舉類型值。具體實(shí)例如下：
@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,這樣注解處理器可以通過反射担巩，獲取到該注解的屬性值方援，從而去做一些運(yùn)行時(shí)的邏輯處理
@Documented:
@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API，因此可以被例如javadoc此類的工具文檔化涛癌。Documented是一個(gè)標(biāo)記注解犯戏，沒有成員送火。
@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() default false;
}
@Inherited：
@Inherited 元注解是一個(gè)標(biāo)記注解，@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的先匪。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class种吸，則這個(gè)annotation將被用于該class的子類。
注意：@Inherited annotation類型是被標(biāo)注過的class的子類所繼承呀非。類并不從它所實(shí)現(xiàn)的接口繼承annotation坚俗，方法并不從它所重載的方法繼承annotation。
當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME岸裙，則反射API增強(qiáng)了這種繼承性猖败。如果我們使用java.lang.reflect去查詢一個(gè)@Inherited annotation類型的annotation時(shí)，反射代碼檢查將展開工作：檢查class和其父類降允，直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn)恩闻，或者到達(dá)類繼承結(jié)構(gòu)的頂層。
實(shí)例代碼：
/**
*
* @author peida
*
*/
@Inherited
public @interface Greeting {
public enum FontColor{ BULE,RED,GREEN};
String name();
FontColor fontColor() default FontColor.GREEN;
}
自定義注解：
使用@interface自定義注解時(shí)剧董，自動(dòng)繼承了java.lang.annotation.Annotation接口幢尚，由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)翅楼，不能繼承其他的注解或接口尉剩。@interface用來聲明一個(gè)注解，其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)犁嗅。方法的名稱就是參數(shù)的名稱边涕，返回值類型就是參數(shù)的類型（返回值類型只能是基本類型、Class褂微、String功蜓、enum）〕杪欤可以通過default來聲明參數(shù)的默認(rèn)值式撼。
定義注解格式：
public @interface 注解名 {定義體}
注解參數(shù)的可支持?jǐn)?shù)據(jù)類型：
1.所有基本數(shù)據(jù)類型（int,float,boolean,byte,double,char,long,short)
2.String類型
3.Class類型
4.enum類型
5.Annotation類型
6.以上所有類型的數(shù)組
Annotation類型里面的參數(shù)該怎么設(shè)定:
第一,只能用public或默認(rèn)(default)這兩個(gè)訪問權(quán)修飾.例如,String value();這里把方法設(shè)為defaul默認(rèn)類型；
第二,參數(shù)成員只能用基本類型byte,short,char,int,long,float,double,boolean八種基本數(shù)據(jù)類型和 String,Enum,Class,annotations等數(shù)據(jù)類型,以及這一些類型的數(shù)組.例如,String value();這里的參數(shù)成員就為String;
第三,如果只有一個(gè)參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號(hào).例:下面的例子FruitName注解就只有一個(gè)參數(shù)成員求厕。
簡單的自定義注解和使用注解實(shí)例：
package annotation;
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 peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitName {
String value() default "";
}
package annotation;
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 peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitColor {
/**
* 顏色枚舉
* @author peida
*
*/
public enum Color{ BULE,RED,GREEN};
/**
* 顏色屬性
* @return
*/
Color fruitColor() default Color.GREEN;
}
package annotation;
import annotation.FruitColor.Color;
public class Apple {
@FruitName("Apple")
private String appleName;
@FruitColor(fruitColor=Color.RED)
private String appleColor;
public void setAppleColor(String appleColor) {
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("水果的名字是：蘋果");
}
}
注解元素的默認(rèn)值：
注解元素必須有確定的值著隆，要么在定義注解的默認(rèn)值中指定，要么在使用注解時(shí)指定呀癣，非基本類型的注解元素的值不可為null美浦。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法。這個(gè)約束使得處理器很難表現(xiàn)一個(gè)元素的存在或缺失的狀態(tài)项栏，因?yàn)槊總€(gè)注解的聲明中浦辨，所有元素都存在，并且都具有相應(yīng)的值沼沈，為了繞開這個(gè)約束流酬，我們只能定義一些特殊的值币厕，例如空字符串或者負(fù)數(shù)，一次表示某個(gè)元素不存在芽腾，在定義注解時(shí)旦装，這已經(jīng)成為一個(gè)習(xí)慣用法。例如：
package annotation;
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;
/**
* 水果供應(yīng)者注解
* @author peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
/**
* 供應(yīng)商編號(hào)
* @return
*/
public int id() default -1;
/**
* 供應(yīng)商名稱
* @return
*/
public String name() default "";
/**
* 供應(yīng)商地址
* @return
*/
public String address() default "";
}
定義了注解摊滔，并在需要的時(shí)候給相關(guān)類阴绢，類屬性加上注解信息，如果沒有響應(yīng)的注解信息處理流程惭载，注解可以說是沒有實(shí)用價(jià)值旱函。如何讓注解真真的發(fā)揮作用，主要就在于注解處理方法描滔，下一步我們將學(xué)習(xí)注解信息的獲取和處理！
總結(jié)#
說一下我的總結(jié)：
1踪古、不要被@interface迷惑含长，因?yàn)樗芟駃nterface，實(shí)際上它就是一種類型而已伏穆。
2拘泞、@Target，表示我定義的這個(gè)注解枕扫，會(huì)被用來修飾什么（目的）陪腌，類（CLASS）,還是某一個(gè)屬性（FIELD）忙上，還是某一個(gè)方法（METHOD）
3方库、@Retention 表示的是注解生命周期痴腌，SOURCE宰译，CLASS因?yàn)樯芷诙搪Π覀儷@取不到瘸羡，所以之后我們使用的都是RUNTIME峦树。
現(xiàn)在我們明白了如何自定義注解掩宜，那如何使用這些注解呢砾赔？這個(gè)時(shí)候就用到了第一篇中介紹的反射機(jī)制蝌箍，下一篇我們就來看看反射和注解的搭配用法。
