前言:
前面學習總結了Java注解的使用,博客地址詳見Java學習之注解Annotation實現原理,從本質上了解到什么注解,以及注解怎么使用?不要看見使用注解就想到反射會影響性能之類,今天我們就來學習一下Android Support Annotations注解來優化我們的代碼,增加可讀性的同時,也讓讓更多的錯誤消滅在萌芽之中。
Support Annotations簡介:
Android support library從19.1版本開始引入了一個新的注解庫,它包含很多有用的元注解,你能用它們修飾你的代碼,幫助你發現bug。Support library自己本身也用到了這些注解,所以作為support library的用戶,Android Studio已經基於這些注解校驗了你的代碼並且標注其中潛在的問題。
Support Annotations如何引入:
注解默認是沒有包含的;它被包裝成一個獨立的庫,如果使用了appcompat庫,那么Support Annotations就會自動引入進來,因為appcompat使用了Support Annotations,如果沒有則需要在build.gradle中添加如下配置:
dependencies {
compile 'com.android.support:support-annotations:23.4.0'
}
Support Annotations分類:
1.)Nullness注解
@Nullable注解可以用來標識特定的參數或者返回值可以為null。

@NonNull注解可以用來標識參數不能為null。

2.)Resource Type 注解
資源在Android中作為整型值來傳遞。這意味着希望獲取一個drawable作為參數的代碼很容易被傳遞了一個string類型的資源,因為他們資源id都是整型的,編譯器很難區分。Resource Type注解在這種條件下可以提供類型檢查,例如:
如果類型指定錯誤,編譯不會通過。

常見的Resource Type注解,使用方式都是指定一個integer的參數、成員變量、或者方法,檢查對應的資源類型。
AnimatorRes:animator資源類型AnimRes:anim資源類型AnyRes:任意資源類型ArrayRes:array資源類型AttrRes:attr資源類型BoolRes:boolean資源類型ColorRes:color資源類型DimenRes:dimen資源類型。DrawableRes:drawable資源類型。FractionRes:fraction資源類型IdRes:id資源類型IntegerRes:integer資源類型InterpolatorRes:interpolator資源類型LayoutRes:layout資源類型MenuRes:menu資源類型PluralsRes:plurals資源類型RawRes:raw資源類型StringRes:string資源類型StyleableRes:styleable資源類型StyleRes:style資源類型TransitionRes:transition資源類型XmlRes:xml資源類型
以上基本上包括了所有的資源類型,但是有時需要通過RGB顏色整型來設置顏色值,在這種情況下,你可以使用@ColorInt注解,表示你期望的是一個代表顏色的整數值,如果使用不對同樣也是編譯不通過

3.)Threading 注解
比如我們在項目中處理比較耗時的操作,需要制定在工作子線程中執行,可以使用Threading 注解,如果沒有在制定的線程中執行也是編譯不過的

幾種Threading注解
- @UiThread UI線程
- @MainThread 主線程
- @WorkerThread 子線程
- @BinderThread 綁定線程
4.)Typedef 注解:IntDef/StringDef
整型除了可以作為資源的引用之外,也可以用作“枚舉”類型使用。
@IntDef和”typedef”作用非常類似,你可以創建另外一個注解,然后用@IntDef指定一個你期望的整型常量值列表,最后你就可以用這個定義好的注解修飾你的API了。
例如:需要自定義網絡類型
private final static int GET=0; private final static int POST=1; private final static int DELETE=2; private final static int PUT=3; @IntDef({GET, POST, DELETE,PUT}) @Retention(RetentionPolicy.SOURCE) public @interface ReqType{}
需要在調用時只能傳入指定類型,如果傳入類型不對,編譯不通過

5.)Value Constraints注解:@Size, @IntRange, @FloatRange
在實際開發過程中,我們有時可能需要設置一個取值范圍,這時我們可以使用取值范圍注解來約束。
比如我們設置一個百分比,取值范圍為0-100,

對於數據、集合以及字符串,你可以用@Size注解參數來限定集合的大小(當參數是字符串的時候,可以限定字符串的長度)。
舉幾個例子
- 集合不能為空: @Size(min=1)
- 字符串最大只能有23個字符: @Size(max=23)
- 數組只能有2個元素: @Size(2)
- 數組的大小必須是2的倍數 (例如圖形API中獲取位置的x/y坐標數組: @Size(multiple=2)
6.)Permissions 注解: @RequiresPermission
有時我們的方法調用需要調用者擁有指定的權限,這時我們可以使用@RequiresPermission注解,
@RequiresPermission(Manifest.permission.SET_WALLPAPER) public abstract void setWallpaper(Bitmap bitmap) throws IOException;
除了上面的單一使用方式,官方同時也給出了如下幾種使用場景
(1)如果你至少需要權限集合中的一個,你可以使用anyOf屬性
@RequiresPermission(anyOf = { Manifest.permission.ACCESS_COARSE_LOCATION, Manifest.permission.ACCESS_FINE_LOCATION}) public abstract Location getLastKnownLocation(String provider);
(2)如果你同時需要多個權限,你可以用allOf屬性
@RequiresPermission(allOf = { Manifest.permission.READ_HISTORY_BOOKMARKS, Manifest.permission.WRITE_HISTORY_BOOKMARKS}) public static final void updateVisitedHistory(ContentResolver cr, String url, boolean real) ;
(3)對於intents的權限,可以直接在定義的intent常量字符串字段上標注權限需求(他們通常都已經被@SdkConstant注解標注過了)
@RequiresPermission(android.Manifest.permission.BLUETOOTH) public static final String ACTION_REQUEST_DISCOVERABLE = "android.bluetooth.adapter.action.REQUEST_DISCOVERABLE";
(4)對於content providers的權限,你可能需要單獨的標注讀和寫的權限訪問,所以可以用@Read或者@Write標注每一個權限需求
@RequiresPermission.Read(@RequiresPermission(READ_HISTORY_BOOKMARKS)) @RequiresPermission.Write(@RequiresPermission(WRITE_HISTORY_BOOKMARKS)) public static final Uri BOOKMARKS_URI = Uri.parse("content://browser/bookmarks");
7.)Overriding Methods 注解: @CallSuper
如果你的API允許使用者重寫你的方法,但是呢,你又需要你自己的方法(父方法)在重寫的時候也被調用,這時候你可以使用@CallSuper標注
例如:Activity的onCreate函數
@CallSuper protected void onCreate(@Nullable Bundle savedInstanceState)
用了這個后,當重寫的方法沒有調用父方法時,工具就會給予標記提示

8.)Return Values注解: @CheckResult
如果你的方法返回一個值,你期望調用者用這個值做些事情,那么你可以使用@CheckResult注解標注這個方法。
這個在具體使用中用的比較少,除非特殊情況,比如在項目中對一個數據進行處理,這個處理比較耗時,我們希望調用該函數的調用者在不需要處理結果的時候,提示沒有使用,酌情刪除調用。

9.)其他注解
Keep:指出一個方法在被混淆的時候應該被保留。
VisibleForTesting:可注解一個類,方法,或變量,表示有更寬松的可見性,這樣它能夠有更寬泛的可見性,使代碼可以被測試。
10.)IntelliJ注解
IntelliJ,Android Studio就是基於它開發的,IntelliJ有一套它自己的注解;IntDef分析其實重用的是MagicConstant分析的代碼,IntelliJ null分析其實用的是一組配置好的null注解。如果你執行Analyze > Infer Nullity…,它會試圖找出所有的null約束並添加他們。這個檢查有時會插入IntelliJ注解。你可以通過搜索,替換為Android注解庫的注解,或者你也可以直接用IntelliJ注解。在build.gradle里或者通過Project Structure對話框的Dependencies面板都可以添加如下依賴:
dependencies { compile 'com.intellij:annotations:12.0' }
小結:
經過查閱資料,系統了學習了Support Annotations注解,學以致用,通過這個Support Annotations可以提高代碼可讀性,同時可以在類加載時就可以檢查一些錯誤,同時不會對性能有任何影響,因為Support Annotations中的注解的生命周期全部是RetentionPolicy.CLASS。接下來准備在項目中大量推廣使用。
