1.引言
從jdk1.5開始,引入了注解類Annotation,Annotation其實(shí)是一種接口,可以作用于類、方法、屬性等,它可以通過反射機(jī)制來訪問annotation信息,獲取所加上注解信息,做相應(yīng)的操作。相當(dāng)于給相關(guān)的作用對(duì)象打上“tag”,使用方便,作用廣泛。
2.java.lang中的注解
在java.lang中,用到的三種注解類,即常用到的Deprecated、Override和SuppressWarnings。
2.1@Deprecated過時(shí)
在使用AS編程的過程中,有一些方法寫出來之后被畫上了中劃線,表示該方法已過時(shí)。@Deprecated注解起到的就是這個(gè)作用。
2.2@Override復(fù)寫
這是開發(fā)過程中最常遇到的注解,表示復(fù)寫父類中的方法。
2.3@SuppressWarnings阻止警告
阻止了彈出警告,比如屏蔽對(duì)上述過時(shí)的提示,可在調(diào)用
setOnPageChangeListener()
方法之上加上@SuppressWarnings("deprecation"),這樣雖然在 IDE中仍以中劃線形式表示,但如果使用javac命令就不再提示警告了。
3.元注解
那么以上的注解類的源碼是什么樣的呢,打開Override發(fā)現(xiàn)其代碼如下:
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.SOURCE)
public @interface Override {
}
這里可以發(fā)現(xiàn)注解類的定義方法以及注解類上所加的注解—元注解。元注解有四個(gè),位于java.lang.annotation包中:Documented,Inherited,Retention,Target。
3.1@Target
表示注解作用的目的
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Target {
ElementType[] value();
}
注解可以作用的目標(biāo)有枚舉類ElementType決定,可作用于類、方法、屬性等,數(shù)組表示注解可以有多個(gè)作用域。
public enum ElementType {
ANNOTATION_TYPE,//注解類
CONSTRUCTOR,//構(gòu)造方法
FIELD,//屬性
LOCAL_VARIABLE,//局部變量
METHOD,//方法
PACKAGE,//包
PARAMETER,//用于描述參數(shù)
TYPE,//類、接口、注解類型或枚舉
TYPE_PARAMETER,
TYPE_USE;
private ElementType() {
}
}
注解作用于類時(shí),定義@Target(ElementType.TYPE)ElementType.TYPE表示類型,Class,Interface等都實(shí)現(xiàn)了java中的Type接口,因此ElementType.TYPE表示注解作用于這些“類”(并不是單純的Class類)
3.2@Retention
表示注解的作用時(shí)段
@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.ANNOTATION_TYPE})
public @interface Retention {
RetentionPolicy value();
}
有上面代碼可見,Retention定義的是RetentionPolicy類型的數(shù)據(jù),RetentionPolicy是一個(gè)枚舉類型,包括SOURCE,CLASS,RENTIME三個(gè)類型,表示注解保留階段。
SOURCE:表示注解只在源文件中保留。
CLASS:表示注解保留到.class文件中
RUNTIME:表示注解一直保留到內(nèi)存中,類加載器把.class文件加載到內(nèi)存中產(chǎn)生的字節(jié)碼中要保留注解信息。
可想而知,@Override僅在寫代碼時(shí)用到,其Retention中的值為RetentionPolicy.SOURCE,@SuppressWarmings也只是編譯器使用的,保留到SOURCE階段。而@deprecated在內(nèi)存中也需要保留,編譯器需要得知方法是否過時(shí),從加載到內(nèi)存中的二進(jìn)制文件中獲取,因而要保留到RUNTIME階段。
3.3@Documented
注解只是一個(gè)標(biāo)記的話,那么使用javadoc生產(chǎn)文檔時(shí),這些注解都不會(huì)存在于文檔中,要使注解在文檔中也存在,就可以在使用了注解的作用對(duì)象上加上@Documented這個(gè)注解,javadoc所生產(chǎn)的文檔就會(huì)帶上注解信息。
3.4@Inherited
該注解表示子類可以集成加載父類上的注解,但是要注意:
1.注解定義在類上面,子類可以繼承該注解
2.注解定義在方法上面,子類也可以繼承該注解,但是如果子類復(fù)寫了父類中定義了注解的方法,那么子類將無法繼承該方法的注解,也就是說,子類在復(fù)寫父類中被@Inherited標(biāo)注的方法時(shí),會(huì)將該方法上面的注解覆蓋掉
3.Interface實(shí)現(xiàn)類無法繼承接口中所定義的被@Inherited標(biāo)注的注解
4.注解參數(shù)
在注解后為注解增加參數(shù),如上述的@Retention、@Target后的括號(hào)中就是注解的參數(shù)。
參數(shù)的類型,支持基本數(shù)據(jù)類型,String類型,Class類型,enmu類型,Annotation類型以及上述所有類型的數(shù)據(jù)。
5.自定義注解
從上面的注解中,也大致看到了注解定義的方式。
1.使用@Interface定義一個(gè)注解類,其內(nèi)部自行繼承了Annotation類,
2.在該類中定義注解的參數(shù),定義方式很像方法。
3.注解元素必須有確定的值,要么在定義注解的默認(rèn)值中指定,要么在使用注解時(shí)指定,非基本類型的注解元素的值不可為null,因此,使用空字符串或0作為默認(rèn)值是一種常用做法。定義一些特殊的值,淚如空字符串或者負(fù)數(shù),表示某個(gè)元素不存在參數(shù)設(shè)置默認(rèn)值時(shí),后面跟上default即可設(shè)置默認(rèn)值。
4.當(dāng)注解的參數(shù)只有一個(gè)時(shí),建議用value作為參數(shù)名,這樣在使用注解時(shí),可以直接寫參數(shù)的值接下來自定義一個(gè)注解類:
@Documented
@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
public @interface Car{
String name() default "";
int number() default -1;
}
在定義一個(gè)類去使用這個(gè)注解:@Car(name="好車",number=666)
public class CarBMW(){
}
那么如何獲取這些注解值呢?有如下方法:if(CarBMW.class.isAnnotationPresent(Car.class)){//判斷CarBMW類是否有注解類Car
Car carAnnotation=(Car)CarBMW.class.getAnnotation(Car.class);//獲取注解實(shí)例對(duì)象
Log.v("Shawn",carAnnotation.name());//獲取name參數(shù)的值
Log.v("Shawn",carAnnotation.number());//獲取number參數(shù)的值
}
6.Android中的注解
Annotation就是注解了,JDK1.5新增加的功能,該功能可用于類,構(gòu)造方法,成員變量,參數(shù)等的聲明中,比如常見的@Override,butterknife庫(kù)里的@Bind,該功能并不影響程序的運(yùn)行,主要作用就是提供類型安全,對(duì)編譯器警告燈輔助工具產(chǎn)生影響。
Android從API16引入了annotation包,最常見兩個(gè)注解@TargetApi和@SuppressLint,
@TargetApi(Build.VERSION_CODES.XX)用于屏蔽某一新api中才能使用的方法報(bào)的lint檢查出現(xiàn)的錯(cuò)誤;
@SuppressLinet(“NewApi")屏蔽一切新api中才能使用的方法報(bào)的Android lint錯(cuò)誤。
這兩個(gè)注解的作用僅僅是屏蔽lint錯(cuò)誤,再發(fā)方法中還要根據(jù)版本不同做不同的操作。
6.1Nullness注解
包括@NonNull和@Nullable,先來看@NonNull源碼:
/**
- Denotes that a parameter, field or method return value can never be null.
- <p>
- This is a marker annotation and it has no specific attributes.
*/
@Documented
@Retention(CLASS)
@Target({METHOD, PARAMETER, FIELD, LOCAL_VARIABLE, ANNOTATION_TYPE, PACKAGE})
public @interface NonNull {
}
Target中表示它可以應(yīng)用于方法、參數(shù)、成員變量,使用@NonNull的好處就是避免后面頻繁判斷參數(shù)是否為空的操作。
6.2資源類型注解
此類注解以Res結(jié)尾,比如@BoolRes,@IdRes,@IntergerRes,@ColorRes等。
用法如下:
getDrawable(@DrawableRes int id)//getDrawable方法限定了傳入的參數(shù)必須是Drawable資源文件
6.3@CallSuper
要求方法必須調(diào)用父類方法,可想而知,Activity的onCreate方法就有此注解標(biāo)識(shí)。
6.4@idDef和@StringDef
提到最常用的Toast,在API21之前,一般可以這么寫:
Toast.makeText(context, "msg", 0).show();
但是21之后,0突然被劃紅線了,查看源碼發(fā)現(xiàn),之前是這么寫的:
- public static final int LENGTH_SHORT = 0;
- public static final int LENGTH_LONG = 1;
makeText方法中單純的寫著int duration參數(shù),而21之后,成了這樣: - @IntDef({LENGTH_SHORT, LENGTH_LONG})
- @Retention(RetentionPolicy.SOURCE)
- public @interface Duration {}
在makeText的duration參數(shù)之前加上了注解@Duration,這就要求傳入的Duration中的值才不會(huì)報(bào)警報(bào)。@IntDef和@StringDef中放入了一個(gè)value數(shù)組,在開發(fā)中,這兩個(gè)注解就可以限制限制枚舉了。
6.4進(jìn)程類注解
@UIThread,@BinderThread,@MainThread,@WorkerThread
用來限定方法或類在指定的線程類型中被調(diào)用
6.5權(quán)限注解@RequiresPermission
如果方法的調(diào)用需要權(quán)限,可以加這個(gè)注解,當(dāng)需要幾個(gè)權(quán)限中的一個(gè)時(shí),使用anyOf,如果@RequiresPermission(anyOf= { Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION})
若需要多個(gè)權(quán)限,使用allOf,如@RequiresPermission(allOf = { Manifest.permission.READ_EXTERNAL_STORAGE, Manifest.permission.WRITE_EXTERNAL_STORAGE})
若需要單獨(dú)的標(biāo)注讀和寫的權(quán)限訪問,可以用@Read或者@Write標(biāo)注每一個(gè)權(quán)限需求。
6.6@SdkConstant
表示一個(gè)常量字段應(yīng)該被輸出在SDK工具中使用,例如:
添加一個(gè)自定義的Action
@SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
public static final String ACTION_MY_TEST = "android.intent.action.MY_TEST";
則可以這樣使用Intent myTest = new Intent(Intent.ACTION_MY_TEST);
mContext.sendBroadcast(myTest);
6.7范圍約束@FloatRange、@IntRange和@Size
前兩個(gè)限制了數(shù)字的范圍,比如可以用來限制傳入?yún)?shù)值的范圍,
@Size可以用來限定集合的大小或者限定字符串的長(zhǎng)度,還可以做其他限制:1.限制最小最大數(shù)量:@Size(min=1,max=10)
2:數(shù)量必須是2的倍數(shù)(偶數(shù)):@Size(multiple=2)
6.8@CheckResult
該注解意味著需要對(duì)方法的返回值進(jìn)行處理,例如:有個(gè)方法為:
- @CheckResult
- public boolean checkValid(String value){
return TextUtils.isEmpty(value);
- }
當(dāng)調(diào)用者直接調(diào)用checkValid(”abc”)時(shí)會(huì)報(bào)錯(cuò),需要對(duì)方法的返回值進(jìn)行處理,無論返回true或false,需要進(jìn)行后續(xù)操作,不能單單的調(diào)用一句。