Android Support Annotations提供的註解允許你像lint檢查那樣提供一些提示信息在審查代碼上，這可以幫助你解決一些難以發現的代碼問題。
添加依賴
- 選擇File > Project Structure
- 點擊Dependencies標籤
- 點擊“+”按鈕然後選擇Library dependency那項
- 在彈出的選擇框選擇support-annotations然後點擊ok
用上面的方法添加的依賴一般都是最新的，然後在build.gradle就會多出一行依賴。
dependencies {
compile 'com.android.support:support-annotations:23.3.0'
}Nullness 註解
添加@Nullable和@NonNull註解去檢驗一個給定的變量，參數或者返回的值是否有效。
@Nullable 表示一個參數，變量，或方法返回值可以爲null
@NonNull 表示一個參數，變量，或方法返回值不能爲null
例如添加了@NonNull這個註解表示context和attrs這兩個參數不能爲空
import android.support.annotation.NonNull;
...
/** Add support for inflating the <fragment> tag. */
@NonNull
@Override
public View onCreateView(String name, @NonNull Context context,
@NonNull AttributeSet attrs) {
...
}
...Resource 註解
對Android引用的資源類型驗證，可以用來區分像Drawables和 R.string這種同是integer的類型資源。
添加@StringRes註解檢驗resId是否爲string的資源id
import android.support.annotation.StringRes;
...
public abstract void setTitle(@StringRes int resId);
...同類型的註解還有 @DrawableRes, @DimenRes, @ColorRes, 和@InterpolatorRes等等
Thread 註解
如果一個方法需要在特定類型的線程中調用，就可以添加這些註解幫助代碼審查。
@UiThread
@MainThread
@WorkerThread
@BinderThread
注意： @MainThread 和 @UiThread 是可以互換的，所以被註解方法只允許從這2個註解聲明的線程中調用。
Value Constraint 註解
使用@IntRange, @FloatRange, 和 @Size 註解檢對傳遞的參數進行驗證。
- @IntRange 指定一個int的值必須在一個規定範圍內
例如取一個alpha值在0-255之間
public void setAlpha(@IntRange(from=0,to=255) int alpha) { … }- @FloatRange 指定一個float的值必須在一個規定範圍內
例如取一個alpha值在0.0-1.0之間
public void setAlpha(@FloatRange(from=0.0, to=1.0) float alpha) {...}- @Size 表示被註解的元素必須有一個給定的數量或長度
@Size 註解檢查集合或數組的數量，以及String的長度。例如一個集合必須要有一個存在的值就使用@Size(min=1)註解去檢查這個集合的是否合法。又比如使用 @Size(2) 註解表示這個數組必須要包含兩個存在的值。
例子：表示location這個數組必須要有一個值
int[] location = new int[3];
button.getLocationOnScreen(@Size(min=1) location);Permission 註解
使用@RequiresPermission註解用來檢驗一個方法的調用者是否已經擁有此權限。對只檢查單個權限是否爲有效權限，使用anyOf屬性，對檢查一組權限使用allOf屬性。
@RequiresPermission(Manifest.permission.SET_WALLPAPER)
public abstract void setWallpaper(Bitmap bitmap) throws IOException;@RequiresPermission(allOf = {
Manifest.permission.READ_EXTERNAL_STORAGE,
Manifest.permission.WRITE_EXTERNAL_STORAGE})
public static final void copyFile(String dest, String source) {
...
}
CheckResults 註解
使用@CheckResults註解檢驗方法的結果或返回值是否有使用。
@CheckResult(suggest="#enforcePermission(String,int,int,String)")
public abstract int checkPermission(@NonNull String permission, int pid, int uid);CallSuper 註解
使用@CallSuper註解檢驗方法是否調用super實現了父類的方法。
@CallSuper
protected void onCreate(Bundle savedInstanceState) {
}
Enumerated 註解
使用@IntDef 和 @StringDef 註解可以使用註解方式代替枚舉實現整型或字符串的列舉類型，以檢驗其他類型的代碼引用。
import android.support.annotation.IntDef;
...
public abstract class ActionBar {
...
//Define the list of accepted constants
@IntDef({NAVIGATION_MODE_STANDARD, NAVIGATION_MODE_LIST, NAVIGATION_MODE_TABS})
//Tell the compiler not to store annotation data in the .class file
@Retention(RetentionPolicy.SOURCE)
//Declare the NavigationMode annotation
public @interface NavigationMode {}
//Declare the constants
public static final int NAVIGATION_MODE_STANDARD = 0;
public static final int NAVIGATION_MODE_LIST = 1;
public static final int NAVIGATION_MODE_TABS = 2;
//Decorate the target methods with the annotation
@NavigationMode
public abstract int getNavigationMode();
//Attach the annotation
public abstract void setNavigationMode(@NavigationMode int mode);如果模型參數不是定義好的常數之一，那麼在你構建這段代碼時就會生成一段警告。
如果一個參數或返回值引用一個有效的模式，你也可以定義帶標誌的註解。
import android.support.annotation.IntDef;
...
@IntDef(flag=true, value={
DISPLAY_USE_LOGO,
DISPLAY_SHOW_HOME,
DISPLAY_HOME_AS_UP,
DISPLAY_SHOW_TITLE,
DISPLAY_SHOW_CUSTOM
})
@Retention(RetentionPolicy.SOURCE)
public @interface DisplayOptions {}
...如果修飾的參數或返回的值不引用一個有效的模式，那麼在你構建這段代碼時就會生成一段警告。
總結
| 註解 | 解釋 |
|---|---|
| @AnimatorRes | 表示該參數、字段或者函數返回值應該是一個 Animator 類型的資源 |
| @AnimRes | 表示該參數、字段或者函數返回值應該是一個 Anim 類型的資源 |
| @AnyRes | 表示該參數、字段或者函數返回值應該是一個任意類型的資源 |
| @AnyThred | 表示被註解的方法可以在任何線程中被調用 |
| @ArrayRes | 表示該參數、字段或者函數返回值應該是一個 Array 類型的資源 |
| @AttrRes | 表示該參數、字段或者函數返回值應該是一個 attribute 類型的資源 |
| @BinderThread | 表示被註解的方法只可以在被綁定的線程中被調用 |
| @BoolRes | 表示該參數、字段或者函數返回值應該是一個布爾類型的資源 |
| @CallSuper | 表示任何重寫的方法都必須調用父類的這個方法 |
| @CheckResult | 表示不能忽視被註解方法的返回值 |
| @ColorInt | 表示該參數、字段或者函數返回值應該是一個顏色值而不是顏色資源引用，例如應該是一個 AARRGGBB 的整數值。 |
| @ColorRes | 表示該參數、字段或者函數返回值應該是一個 color 類型的資源，而不是顏色值。注意和 ColorInt 區別 |
| @DimenRes | 表示該參數、字段或者函數返回值應該是一個 dimension 類型的資源 |
| @Dimension | 表示被註解的整形參數，字段或返回值是一個尺寸類型 |
| @DrawableRes | 表示該參數、字段或者函數返回值應該是一個 drawable 類型的資源 |
| @FloatRange | 表示被註解的元素必須是在一個給定範圍的float或double值 |
| @FractionRes | 表示該參數、字段或者函數返回值應該是一個 fraction 類型的資源 |
| @IdRes | 表示該參數、字段或者函數返回值應該是一個資源的 ID 類型 |
| @IntegerRes | 表示該參數、字段或者函數返回值應該是一個整數類型的資源 |
| @IntRange | 表示被註解的元素必須是在一個給定範圍的long或int值 |
| @InterpolatorRes | 表示該參數、字段或者函數返回值應該是一個 interpolator 類型的資源 |
| @keep | 表示被註解的元素在構建混淆時不會被刪除或縮小字段，會保持原字段 |
| @LayoutRes | 表示該參數、字段或者函數返回值應該是一個 layout 佈局文件類型的資源 |
| @MainThread | 表示被註解的方法只能在主線程調用 |
| @MenuRes | 表示該參數、字段或者函數返回值應該是一個 menu 類型的資源 |
| @NonNull | 表示被註解的參數，字段或返回值不能爲空 |
| @Nullable | 表示被註解的參數，字段或返回值可以爲空 |
| @PluralsRes | 表示該參數、字段或者函數返回值應該是一個 plurals 類型的資源 |
| @Px | 表示這個整形的參數，字段或返回值是一個像素尺寸 |
| @RawRes | 表示該參數、字段或者函數返回值應該是一個 raw 類型的資源 |
| @RequiresApi | 表示被註解的元素只能在給定的api級別或更高版本上運行 |
| @RequiresPermission | 表示被註解的元素需要（或可能需要）一個或多個權限 |
| @RequiresPermission.Read | 指定需要允許讀權限 |
| @RequiresPermission.Write | 指定需要允許寫權限 |
| @Size | 表示被註解的元素必須有一個給定的大小或長度 |
| @StringDef | 表示被註解的元素代表一個邏輯類型並且它的值必須是顯示命名的常量 |
| @StringRes | 表示該參數、字段或者函數返回值應該是一個字符串類型的資源 |
| @StyleableRes | 表示該參數、字段或者函數返回值應該是一個 styleable 類型的資源 |
| @StyleRes | 表示該參數、字段或者函數返回值應該是一個 style 類型的資源 |
| @TransitionRes | 表示該參數、字段或者函數返回值應該是一個 transition 類型的資源 |
| @UiThread | 表示被註解的方法或構造方法只能在UI線程調用 |
| @VisibleForTesting | 主要用到測試方面，用處很少，標誌作用 |
| @WorkerThread | 表示被註解的方法或構造方法只能在工作線程調用 |
| @XmlRes | 表示該參數、字段或者函數返回值應該是一個 XML 類型的資源 |
