前言：使用Support Annotations注解優(yōu)化代碼

本片文章講解怎么使用Support Annotations注解優(yōu)化代碼，比如使用 android特有的魔術(shù)變量注解替代Enum等功能。不要看見(jiàn)使用注解就想到反射會(huì)影響性能之類(lèi)，今天我們就來(lái)學(xué)習(xí)一下Android Support Annotations注解來(lái)優(yōu)化我們的代碼，增加可讀性的同時(shí)，也讓讓更多的錯(cuò)誤消滅在萌芽之中。

Support Annotations 簡(jiǎn)介：

Android support library 不斷地引入新的注解庫(kù)，它包含很多有用的元注解，你能用它們修飾你的代碼，幫助你發(fā)現(xiàn)bug。Support library 自己本身也用到了這些注解，所以作為 support library 的用戶(hù)，Android Studio已經(jīng)基于這些注解校驗(yàn)了你的代碼并且標(biāo)注其中潛在的問(wèn)題。

Support Annotations 如何引入：

注解默認(rèn)是沒(méi)有包含的;它被包裝成一個(gè)獨(dú)立的庫(kù)，如果使用了appcompat庫(kù)，那么 Support Annotations 就會(huì)自動(dòng)引入進(jìn)來(lái)，因?yàn)? appcompat 使用了 Support Annotations，如果沒(méi)有則需要在 build.gradle 中添加如下配置：

dependencies { 
    compile 'com.android.support:support-annotations:23.4.0' 
}  

如果你已經(jīng)引入了 appcompat v7 則可能就沒(méi)有必要再次引用 support-annotations ,因?yàn)?appcompat 默認(rèn)包含了對(duì)其引用。

Support Annotations分類(lèi)：

Typedef 注解：IntDef / StringDef (Android特有的魔術(shù)變量注解替代Enum)

Enum in Android 枚舉Enum在java中是一個(gè)完整的類(lèi). 而枚舉中的每一個(gè)值在枚舉類(lèi)中都是一個(gè)對(duì)象. 所以在我們使用時(shí)枚舉的值將比整數(shù)常量消耗更多的內(nèi)存. 當(dāng)我們使用枚舉在安卓應(yīng)用中, 如果我們的程序本身內(nèi)存消耗就比較大,或者是一個(gè)游戲的應(yīng)用程序. 那么我們***使用常量來(lái)替代枚舉。可是使用了常量代替后又不能限制取值了。那有什么好的辦法呢?

當(dāng)然, Android 支持注解庫(kù)中有一些好用的annotation helper 我們可以使用它們來(lái)解決我們之前的問(wèn)題(在編譯代碼時(shí)期).

IntDef和StringDef 是兩個(gè)魔術(shù)變量注解. 使用這個(gè)兩個(gè)來(lái)替代之前使用的Enum. 它將幫助我們?cè)诰幾g代碼時(shí)期像Enum那樣選擇變量的功能。 @IntDef和”typedef”作用非常類(lèi)似，你可以創(chuàng)建另外一個(gè)注解，然后用@IntDef指定一個(gè)你期望的整型常量值列表，***你就可以用這個(gè)定義好的注解修飾你的API了。接下來(lái)我們來(lái)使用IntDef來(lái)替換Enum看一下.

public class MainActivity extends Activity { 
    public static final int SUNDAY = 0; 
    public static final int MONDAY = 1; 
    {...省略部分} 
 
    @IntDef({SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY}) 
    @Retention(RetentionPolicy.SOURCE) 
    public @interface WeekDays { 
    } 
 
    @WeekDays 
    int currentDay = SUNDAY; 
 
    @Override 
    protected void onCreate(Bundle savedInstanceState) { 
        super.onCreate(savedInstanceState); 
        setContentView(R.layout.activity_main); 
 
        setCurrentDay(WEDNESDAY); 
 
        @WeekDays int today = getCurrentDay(); 
        switch (today) { 
            case SUNDAY: 
                break; 
            case MONDAY: 
                break; 
            {...省略部分} 
            default: 
                break; 
        } 
    } 
 
    /** 
     * 參數(shù)只能傳入在聲明范圍內(nèi)的整型，不然編譯通不過(guò) 
     * @param currentDay 
     */ 
    public void setCurrentDay(@WeekDays int currentDay) { 
        this.currentDay = currentDay; 
    } 
 
    @WeekDays 
    public int getCurrentDay() { 
        return currentDay; 
    } 
}  

說(shuō)明：

1. 聲明一些必要的 int 常量
2. 聲明一個(gè)注解為 WeekDays
3. 使用 @IntDef 修飾 WeekDays,參數(shù)設(shè)置為待枚舉的集合
4. 使用 @Retention(RetentionPolicy.SOURCE) 指定注解僅存在與源碼中,不加入到 class 文件中

需要在調(diào)用時(shí)只能傳入指定類(lèi)型，如果傳入類(lèi)型不對(duì)，編譯不通過(guò)。

我們也可以指定整型值作為標(biāo)志位，也就是說(shuō)這些整型值可以使用 ’|’ 或者 ’&’ 進(jìn)行與或等操作。如果我們把@Flavour定義為如下標(biāo)志位：

@IntDef(flag = true, value = {SUNDAY, MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY}) 
public @interface Flavour { 
}  

那么可以如下調(diào)用：

setCurrentDay(SUNDAY & WEDNESDAY); 

@StringDef用法和@IntDef基本差不多，只不過(guò)是針對(duì)String類(lèi)型而已。

怎么樣?使用起來(lái)還是很簡(jiǎn)單的吧。如果你只是沖做標(biāo)題 尋求一種替代Enum的方式 進(jìn)來(lái)的話(huà)，看到這你就可以直接跳到文章結(jié)尾 點(diǎn)個(gè)喜歡 離開(kāi)了。如果你還想知道更多關(guān)于注解的強(qiáng)大功能，那么就接著看下面的內(nèi)容吧!

Nullness注解

@Nullable注解可以用來(lái)標(biāo)識(shí)特定的參數(shù)或者返回值可以為null。  

@NonNull注解可以用來(lái)標(biāo)識(shí)參數(shù)不能為null。   

Resource Type 注解

資源在Android中作為整型值來(lái)傳遞。這意味著希望獲取一個(gè)drawable作為參數(shù)的代碼很容易被傳遞了一個(gè)string類(lèi)型的資源，因?yàn)樗麄冑Y源id都是整型的，編譯器很難區(qū)分。Resource Type注解在這種條件下可以提供類(lèi)型檢查，例如：

如果類(lèi)型指定錯(cuò)誤，編譯不會(huì)通過(guò)。  

常見(jiàn)的Resource Type注解,使用方式都是指定一個(gè)integer的參數(shù)、成員變量、或者方法，檢查對(duì)應(yīng)的資源類(lèi)型。

• AnimatorRes ：animator資源類(lèi)型
• AnimRes：anim資源類(lèi)型
• AnyRes：任意資源類(lèi)型
• ArrayRes：array資源類(lèi)型
• AttrRes：attr資源類(lèi)型
• BoolRes：boolean資源類(lèi)型
• ColorRes：color資源類(lèi)型
• DimenRes：dimen資源類(lèi)型。
• DrawableRes：drawable資源類(lèi)型。
• FractionRes：fraction資源類(lèi)型
• IdRes：id資源類(lèi)型
• IntegerRes：integer資源類(lèi)型
• InterpolatorRes：interpolator資源類(lèi)型
• LayoutRes：layout資源類(lèi)型
• MenuRes：menu資源類(lèi)型
• PluralsRes：plurals資源類(lèi)型
• RawRes：raw資源類(lèi)型
• StringRes：string資源類(lèi)型
• StyleableRes：styleable資源類(lèi)型
• StyleRes：style資源類(lèi)型
• TransitionRes：transition資源類(lèi)型
• XmlRes：xml資源類(lèi)型

以上基本上包括了所有的資源類(lèi)型，但是有時(shí)需要通過(guò)RGB顏色整型來(lái)設(shè)置顏色值，在這種情況下，你可以使用 @ColorInt 注解，表示你期望的是一個(gè)代表顏色的整數(shù)值，如果使用不對(duì)同樣也是編譯不通過(guò)   

Threading 注解

比如我們?cè)陧?xiàng)目中處理比較耗時(shí)的操作，需要制定在工作子線程中執(zhí)行，可以使用Threading 注解，如果沒(méi)有在制定的線程中執(zhí)行也是編譯不過(guò)的    

幾種Threading注解

• @UiThread UI線程
• @MainThread 主線程
• @WorkerThread 子線程
• @BinderThread 綁定線程

Value Constraints 注解：@Size, @IntRange, @FloatRange

在實(shí)際開(kāi)發(fā)過(guò)程中，我們有時(shí)可能需要設(shè)置一個(gè)取值范圍，這時(shí)我們可以使用取值范圍注解來(lái)約束。

比如我們?cè)O(shè)置一個(gè)百分比，取值范圍為0-100，   

對(duì)于數(shù)據(jù)、集合以及字符串，你可以用@Size注解參數(shù)來(lái)限定集合的大小(當(dāng)參數(shù)是字符串的時(shí)候，可以限定字符串的長(zhǎng)度)。

舉幾個(gè)例子

• 集合不能為空: @Size(min=1)
• 字符串***只能有23個(gè)字符: @Size(max=23)
• 數(shù)組只能有2個(gè)元素: @Size(2)
• 數(shù)組的大小必須是2的倍數(shù) (例如圖形API中獲取位置的x/y坐標(biāo)數(shù)組: @Size(multiple=2)

Permissions 注解: @RequiresPermission

有時(shí)我們的方法調(diào)用需要調(diào)用者擁有指定的權(quán)限，這時(shí)我們可以使用

@RequiresPermission注解，

@RequiresPermission(Manifest.permission.SET_WALLPAPER) 
public abstract void setWallpaper(Bitmap bitmap) throws IOException;  

除了上面的單一使用方式，官方同時(shí)也給出了如下幾種使用場(chǎng)景

(1)如果你至少需要權(quán)限集合中的一個(gè)，你可以使用anyOf屬性

@RequiresPermission(anyOf = { 
    Manifest.permission.ACCESS_COARSE_LOCATION, 
    Manifest.permission.ACCESS_FINE_LOCATION}) 
public abstract Location getLastKnownLocation(String provider);  

(2)如果你同時(shí)需要多個(gè)權(quán)限，你可以用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)對(duì)于intents的權(quán)限，可以直接在定義的intent常量字符串字段上標(biāo)注權(quán)限需求(他們通常都已經(jīng)被@SdkConstant注解標(biāo)注過(guò)了)

@RequiresPermission(android.Manifest.permission.BLUETOOTH) 
public static final String ACTION_REQUEST_DISCOVERABLE = 
            "android.bluetooth.adapter.action.REQUEST_DISCOVERABLE";  

(4)對(duì)于content providers的權(quán)限，你可能需要單獨(dú)的標(biāo)注讀和寫(xiě)的權(quán)限訪問(wèn)，所以可以用@Read或者@Write標(biāo)注每一個(gè)權(quán)限需求

@RequiresPermission.Read(@RequiresPermission(READ_HISTORY_BOOKMARKS)) 
@RequiresPermission.Write(@RequiresPermission(WRITE_HISTORY_BOOKMARKS)) 
public static final Uri BOOKMARKS_URI = Uri.parse("content://browser/bookmarks");  

Overriding Methods 注解: @CallSuper

如果你的API允許使用者重寫(xiě)你的方法，但是呢，你又需要你自己的方法(父方法)在重寫(xiě)的時(shí)候也被調(diào)用，這時(shí)候你可以使用@CallSuper標(biāo)注

例如：Activity的onCreate函數(shù)

@CallSuper 
protected void onCreate(@Nullable Bundle savedInstanceState)  

用了這個(gè)后，當(dāng)重寫(xiě)的方法沒(méi)有調(diào)用父方法時(shí)，工具就會(huì)給予標(biāo)記提示   

Return Values注解: @CheckResult

如果你的方法返回一個(gè)值，你期望調(diào)用者用這個(gè)值做些事情，那么你可以使用 @CheckResult 注解標(biāo)注這個(gè)方法。

這個(gè)在具體使用中用的比較少，除非特殊情況，比如在項(xiàng)目中對(duì)一個(gè)數(shù)據(jù)進(jìn)行處理，這個(gè)處理比較耗時(shí)，我們希望調(diào)用該函數(shù)的調(diào)用者在不需要處理結(jié)果的時(shí)候，提示沒(méi)有使用，酌情刪除調(diào)用。 

 

Keep 注解

Keep：指出一個(gè)方法在被混淆的時(shí)候應(yīng)該被保留。

在Android編譯生成APK的環(huán)節(jié),我們通常需要設(shè)置minifyEnabled為true實(shí)現(xiàn)下面的兩個(gè)效果:

• 混淆代碼
• 刪除沒(méi)有用的代碼

但是出于某一些目的,我們需要不混淆某部分代碼或者不刪除某處代碼,除了配置復(fù)雜的Proguard文件之外,我們還可以使用@Keep注解.

@Keep 
public static int getBitmapWidth(Bitmap bitmap) { 
    return bitmap.getWidth(); 
}  

其他注解

VisibleForTesting：可注解一個(gè)類(lèi)，方法，或變量，表示有更寬松的可見(jiàn)性，這樣它能夠有更寬泛的可見(jiàn)性，使代碼可以被測(cè)試。

IntelliJ注解

dependencies { 
    compile 'com.intellij:annotations:12.0' 
}  

結(jié)尾

經(jīng)過(guò)查閱資料和博客，系統(tǒng)了學(xué)習(xí)和總結(jié)了關(guān)于Support Annotations注解的內(nèi)容，在編碼中通過(guò)使用Support Annotations可以提高代碼可讀性，同時(shí)可以在類(lèi)加載時(shí)就可以檢查一些錯(cuò)誤，同時(shí)不會(huì)對(duì)性能有任何影響，因?yàn)镾upport Annotations中的注解的生命周期全部是RetentionPolicy.class。在以后的編碼中大家可以嘗試用用。