前言
注解是 Java 5 的一個(gè)新特性板乙。注解是插入你代碼中的一種注釋或者說(shuō)是一種元數(shù)據(jù)(meta data)。這些注解信息可以在編譯期使用預(yù)編譯工具進(jìn)行處理(pre-compiler tools)感挥,也可以在運(yùn)行期使用 Java 反射機(jī)制進(jìn)行處理。
現(xiàn)在注解在越來(lái)越多的地方用到越败,在Android中非常著名的網(wǎng)絡(luò)請(qǐng)求框架 Retrofit 就是利用注解和動(dòng)態(tài)代理很大程度上簡(jiǎn)化了網(wǎng)絡(luò)請(qǐng)求的代碼触幼。
元注解
元注解的作用就是負(fù)責(zé)注解其他注解。Java5.0定義了4個(gè)標(biāo)準(zhǔn)的meta-annotation類型究飞,它們被用來(lái)提供對(duì)其它 annotation類型作說(shuō)明置谦。Java5.0定義的元注解:
1. @Target,
2. @Retention,
3. @Documented,
4. @Inherited
這些類型和它們所支持的類在java.lang.annotation包中可以找到。下面我們看一下每個(gè)元注解的作用和相應(yīng)分參數(shù)的使用說(shuō)明亿傅。
@Target
@Target說(shuō)明了Annotation所修飾的對(duì)象范圍: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聲明
@Retention:
@Retention定義了該Annotation被保留的時(shí)間長(zhǎng)短:某些Annotation僅出現(xiàn)在源代碼中,而被編譯器丟棄译打;而另一些卻被編譯在class文件中耗拓;編譯在class文件中的Annotation可能會(huì)被虛擬機(jī)忽略,而另一些在class被裝載時(shí)將被讀茸嗨尽(請(qǐng)注意并不影響class的執(zhí)行乔询,因?yàn)锳nnotation與class在使用上是被分離的)。使用這個(gè)meta-Annotation可以對(duì) Annotation的“生命周期”限制韵洋。
作用:表示需要在什么級(jí)別保存該注釋信息竿刁,用于描述注解的生命周期(即:被描述的注解在什么范圍內(nèi)有效)
取值(RetentionPoicy)有:
1. SOURCE : 在源文件中有效(即源文件保留)
2. CLASS : 在class文件中有效(即class保留)
3. RUNTIME : 在運(yùn)行時(shí)有效(即運(yùn)行時(shí)保留)
@Documented:
@Documented用于描述其它類型的annotation應(yīng)該被作為被標(biāo)注的程序成員的公共API,因此可以被例如javadoc此類的工具文檔化搪缨。Documented是一個(gè)標(biāo)記注解食拜,沒(méi)有成員。
@Inherited:
@Inherited 元注解是一個(gè)標(biāo)記注解副编,@Inherited闡述了某個(gè)被標(biāo)注的類型是被繼承的负甸。如果一個(gè)使用了@Inherited修飾的annotation類型被用于一個(gè)class,則這個(gè)annotation將被用于該class的子類痹届。
注意:@Inherited annotation類型是被標(biāo)注過(guò)的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)的頂層铺浇。
自定義注解
使用@interface自定義注解時(shí)悠就,自動(dòng)繼承了java.lang.annotation.Annotation接口千绪,由編譯程序自動(dòng)完成其他細(xì)節(jié)。在定義注解時(shí)梗脾,不能繼承其他的注解或接口荸型。@interface用來(lái)聲明一個(gè)注解,其中的每一個(gè)方法實(shí)際上是聲明了一個(gè)配置參數(shù)。方法的名稱就是參數(shù)的名稱瑞妇,返回值類型就是參數(shù)的類型(返回值類型只能是基本類型稿静、Class、String辕狰、enum)改备。可以通過(guò)default來(lái)聲明參數(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è)訪問(wèn)權(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ù)成員。
注解元素的默認(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í)慣用法。
簡(jiǎn)單的自定義注解和使用注解實(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("水果的名字是:蘋果");
}
}
Android內(nèi)置注解
作為android程序員芬膝,我們還是了解一下android中自帶的注解望门,以及用法含義。
@SuppressLint: 指示lint檢查時(shí)忽略注解元素的警告信息锰霜。
@TargetApi:指示lint把當(dāng)前這個(gè)注解元素的target api為指定值筹误,而不是項(xiàng)目設(shè)置的target api。
@NonNull:表示一個(gè)成員變量癣缅,或者參數(shù)厨剪,或者方法返回值永遠(yuǎn)不能為NULL。
@Nullable:標(biāo)識(shí)一個(gè)成員變量友存,或者參數(shù)祷膳,方法返回值,可以為NULL屡立。
參考
[深入理解Java:注解(Annotation)自定義注解入門] (http://www.cnblogs.com/peida/archive/2013/04/24/3036689.html)