一竿秆、元注解:
元注解的作用就是負(fù)責(zé)注解其他注解启摄。Java5.0定義了4個標(biāo)準(zhǔn)的meta-annotation類型匪燕,它們被用來提供對其它 annotation類型作說明。Java5.0定義的元注解:
1.@Target,
2.@Retention,
3.@Documented,
4.@Inherited
這些類型和它們所支持的類在java.lang.annotation包中可以找到书闸。下面我們看一下每個元注解的作用和相應(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聲明
@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被保留的時間長短:某些Annotation僅出現(xiàn)在源代碼中骂际,而被編譯器丟棄;而另一些卻被編譯在class文件中太示;編譯在class文件中的Annotation可能會被虛擬機(jī)忽略,而另一些在class被裝載時將被讀妊椒恰(請注意并不影響class的執(zhí)行,因為Annotation與class在使用上是被分離的)恩闻。使用這個meta-Annotation可以對 Annotation的“生命周期”限制。
作用:表示需要在什么級別保存該注釋信息尉剩,用于描述注解的生命周期(即:被描述的注解在什么范圍內(nèi)有效)
取值(RetentionPoicy)有:
1.SOURCE:在源文件中有效(即源文件保留)
2.CLASS:在class文件中有效(即class保留)
3.RUNTIME:在運行時有效(即運行時保留)
Retention meta-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應(yīng)該被作為被標(biāo)注的程序成員的公共API,因此可以被例如javadoc此類的工具文檔化浦辨。Documented是一個標(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 元注解是一個標(biāo)記注解阴绢,@Inherited闡述了某個被標(biāo)注的類型是被繼承的。如果一個使用了@Inherited修飾的annotation類型被用于一個class,則這個annotation將被用于該class的子類篓足。
注意:@Inherited annotation類型是被標(biāo)注過的class的子類所繼承陪腌。類并不從它所實現(xiàn)的接口繼承annotation,方法并不從它所重載的方法繼承annotation强岸。
當(dāng)@Inherited annotation類型標(biāo)注的annotation的Retention是RetentionPolicy.RUNTIME蝌箍,則反射API增強(qiáng)了這種繼承性妓盲。如果我們使用java.lang.reflect去查詢一個@Inherited annotation類型的annotation時专普,反射代碼檢查將展開工作:檢查class和其父類檀夹,直到發(fā)現(xiàn)指定的annotation類型被發(fā)現(xiàn),或者到達(dá)類繼承結(jié)構(gòu)的頂層
/**
*
* @author peida
*
*/
@Inherited
public @interface Greeting {
public enum FontColor{ BULE,RED,GREEN};
String name();
FontColor fontColor() default FontColor.GREEN;
}
二娜亿、自定義注解
使用@interface自定義注解時买决,自動繼承了java.lang.annotation.Annotation接口,由編譯程序自動完成其他細(xì)節(jié)瘸味。在定義注解時够挂,不能繼承其他的注解或接口。@interface用來聲明一個注解枯冈,其中的每一個方法實際上是聲明了一個配置參數(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)這兩個訪問權(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;
第三,如果只有一個參數(shù)成員,最好把參數(shù)名稱設(shè)為"value",后加小括號.例:下面的例子FruitName注解就只有一個參數(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 "";
}
/**
* 水果顏色注解
* @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;
}
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)值中指定顿涣,要么在使用注解時指定蒲障,非基本類型的注解元素的值不可為null背捌。因此, 使用空字符串或0作為默認(rèn)值是一種常用的做法扭仁。這個約束使得處理器很難表現(xiàn)一個元素的存在或缺失的狀態(tài),因為每個注解的聲明中,所有元素都存在翻默,并且都具有相應(yīng)的值肯污,為了繞開這個約束剂桥,我們只能定義一些特殊的值恕酸,例如空字符串或者負(fù)數(shù)义矛,一次表示某個元素不存在,在定義注解時,這已經(jīng)成為一個習(xí)慣用法。例如
/**
* 水果供應(yīng)者注解
* @author peida
*
*/
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface FruitProvider {
/**
* 供應(yīng)商編號
* @return
*/
public int id() default -1;
/**
* 供應(yīng)商名稱
* @return
*/
public String name() default "";
/**
* 供應(yīng)商地址
* @return
*/
public String address() default "";
}