還在用枚舉？我早就拋棄了Ｋ稹（Android 注解詳解）

</br>

enum

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

本片文章講解怎么使用Support Annotations注解優(yōu)化代碼匆笤，比如使用 android特有的魔術(shù)變量注解替代Enum 等功能。不要看見使用注解就想到反射會影響性能之類谱邪，今天我們就來學習一下Android Support Annotations注解來優(yōu)化我們的代碼炮捧，增加可讀性的同時，也讓讓更多的錯誤消滅在萌芽之中惦银。

Support Annotations 簡介：

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

Support Annotations 如何引入：

注解默認是沒有包含的；它被包裝成一個獨立的庫读存，如果使用了appcompat庫为流，那么 Support Annotations 就會自動引入進來，因為 appcompat 使用了 Support Annotations让簿，如果沒有則需要在 build.gradle 中添加如下配置：

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

如果你已經(jīng)引入了 appcompat v7 則可能就沒有必要再次引用 support-annotations ,因為 appcompat 默認包含了對其引用敬察。

Support Annotations分類：

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

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

當然, Android 支持注解庫中有一些好用的annotation helper 我們可以使用它們來解決我們之前的問題(在編譯代碼時期).
IntDef和StringDef 是兩個魔術(shù)變量注解. 使用這個兩個來替代之前使用的Enum. 它將幫助我們在編譯代碼時期像Enum那樣選擇變量的功能。 @IntDef和”typedef”作用非常類似锐帜，你可以創(chuàng)建另外一個注解田盈，然后用@IntDef指定一個你期望的整型常量值列表，最后你就可以用這個定義好的注解修飾你的API了缴阎。接下來我們來使用IntDef來替換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)的整型允瞧，不然編譯通不過
     * @param currentDay
     */
    public void setCurrentDay(@WeekDays int currentDay) {
        this.currentDay = currentDay;
    }

    @WeekDays
    public int getCurrentDay() {
        return currentDay;
    }
}

說明：

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

需要在調(diào)用時只能傳入指定類型，如果傳入類型不對药蜻，編譯不通過瓷式。

我們也可以指定整型值作為標志位替饿，也就是說這些整型值可以使用 ’｜’ 或者 ’&’ 進行與或等操作语泽。如果我們把@Flavour定義為如下標志位：

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

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

setCurrentDay(SUNDAY & WEDNESDAY);

@StringDef用法和@IntDef基本差不多，只不過是針對String類型而已视卢。

怎么樣踱卵？使用起來還是很簡單的吧。如果你只是沖做標題 尋求一種替代Enum的方式 進來的話据过，看到這你就可以直接跳到文章結(jié)尾 點個喜歡 離開了惋砂。如果你還想知道更多關(guān)于注解的強大功能，那么就接著看下面的內(nèi)容吧绳锅！

Nullness注解

@Nullable注解可以用來標識特定的參數(shù)或者返回值可以為null西饵。

@Nullable

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

@NonNull

Resource Type 注解

資源在Android中作為整型值來傳遞鳞芙。這意味著希望獲取一個drawable作為參數(shù)的代碼很容易被傳遞了一個string類型的資源眷柔，因為他們資源id都是整型的，編譯器很難區(qū)分原朝。Resource Type注解在這種條件下可以提供類型檢查驯嘱，例如：

如果類型指定錯誤，編譯不會通過喳坠。

Resource Type

常見的Resource Type注解,使用方式都是指定一個integer的參數(shù)鞠评、成員變量、或者方法壕鹉，檢查對應(yīng)的資源類型剃幌。

• 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顏色整型來設(shè)置顏色值，在這種情況下怠肋，你可以使用 @ColorInt 注解敬鬓，表示你期望的是一個代表顏色的整數(shù)值，如果使用不對同樣也是編譯不通過

@ColorInt

Threading 注解

比如我們在項目中處理比較耗時的操作，需要制定在工作子線程中執(zhí)行钉答，可以使用Threading 注解础芍，如果沒有在制定的線程中執(zhí)行也是編譯不過的

Threading

幾種Threading注解

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

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

在實際開發(fā)過程中，我們有時可能需要設(shè)置一個取值范圍数尿，這時我們可以使用取值范圍注解來約束仑性。
比如我們設(shè)置一個百分比，取值范圍為0-100右蹦，

@IntRange

對于數(shù)據(jù)诊杆、集合以及字符串，你可以用@Size注解參數(shù)來限定集合的大小(當參數(shù)是字符串的時候何陆，可以限定字符串的長度)晨汹。

舉幾個例子

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

Permissions 注解: @RequiresPermission

有時我們的方法調(diào)用需要調(diào)用者擁有指定的權(quán)限，這時我們可以使用@RequiresPermission注解贷盲，

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

除了上面的單一使用方式淘这，官方同時也給出了如下幾種使用場景

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

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

（2）如果你同時需要多個權(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）對于intents的權(quán)限铝穷，可以直接在定義的intent常量字符串字段上標注權(quán)限需求(他們通常都已經(jīng)被@SdkConstant注解標注過了)

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

（4）對于content providers的權(quán)限，你可能需要單獨的標注讀和寫的權(quán)限訪問佳魔，所以可以用@Read或者@Write標注每一個權(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允許使用者重寫你的方法曙聂，但是呢，你又需要你自己的方法(父方法)在重寫的時候也被調(diào)用鞠鲜，這時候你可以使用@CallSuper標注

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

@CallSuper
protected void onCreate(@Nullable Bundle savedInstanceState) 

用了這個后宁脊，當重寫的方法沒有調(diào)用父方法時，工具就會給予標記提示

@CallSuper

Return Values注解: @CheckResult

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

這個在具體使用中用的比較少庐氮，除非特殊情況语稠，比如在項目中對一個數(shù)據(jù)進行處理，這個處理比較耗時弄砍，我們希望調(diào)用該函數(shù)的調(diào)用者在不需要處理結(jié)果的時候仙畦，提示沒有使用，酌情刪除調(diào)用音婶。

@CheckResult

Keep 注解

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

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

• 混淆代碼
• 刪除沒有用的代碼

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

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

其他注解

VisibleForTesting：可注解一個類，方法衣式，或變量寸士，表示有更寬松的可見性檐什，這樣它能夠有更寬泛的可見性，使代碼可以被測試弱卡。

IntelliJ注解

IntelliJ 乃正，Android Studio 就是基于它開發(fā)的， IntelliJ 有一套它自己的注解婶博； IntDef 分析其實重用的是 MagicConstant 分析的代碼瓮具，IntelliJ null 分析其實用的是一組配置好的 null 注解。如果你執(zhí)行 Analyze > Infer Nullity…凡人，它會試圖找出所有的 null 約束并添加他們名党。這個檢查有時會插入 IntelliJ 注解。你可以通過搜索,替換為 Android 注解庫的注解挠轴，或者你也可以直接用 IntelliJ 注解传睹。在 build.gradle 里或者通過 Project Structure 對話框的 Dependencies 面板都可以添加如下依賴：

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

結(jié)尾：

經(jīng)過查閱資料和博客，系統(tǒng)了學習和總結(jié)了關(guān)于Support Annotations注解的內(nèi)容忠荞，在編碼中通過使用Support Annotations可以提高代碼可讀性蒋歌，同時可以在類加載時就可以檢查一些錯誤帅掘，同時不會對性能有任何影響委煤，因為Support Annotations中的注解的生命周期全部是RetentionPolicy.class。在以后的編碼中大家可以嘗試用用修档。

參考文章（本編文章內(nèi)容大多來自對下面幾篇文章的總結(jié)）：

http://droidyue.com/blog/2016/08/14/android-annnotation/index.html
http://www.cnblogs.com/whoislcj/p/5677917.html
https://asce1885.gitbooks.io/android-rd-senior-advanced/content/shen_ru_qian_chu_android_support_annotations.html
https://noobcoderblog.wordpress.com/2015/04/12/java-enum-and-android-intdefstringdef-annotation/
http://szysky.com/2016/05/20/Android-%E4%B8%AD%E5%A6%82%E4%BD%95%E4%BD%BF%E7%94%A8annotion%E6%9B%BF%E4%BB%A3Enum/
http://anupcowkur.com/posts/a-look-at-android-support-annotations/