Android如何使用注解進行代碼檢查

Android Studio 內置了代碼檢查工具 Lint，可在菜單欄選擇 Analyze > Inspect Code 執行相應的代碼檢查，代碼檢查能夠根據推斷一些不合法的潛在問題，有助于在開發階段發現開發者因為主管原因導致的一下代碼問題，Android 官方提供了注解庫 support-annotations 來幫助開發者及早發現問題，下面是常用的一些注解，主要內容如下：

Nullness注解
資源注解
線程注解
值約束注解
權限注解
返回值注解
CallSuper注解
Typedef注解
可訪問性注解

Nullness注解

使用 Nullness 注解可以檢查給定變量、參數和返回值是否允許 null 值，具體如下：

@Nullable ：表示可以為 null 的變量、參數或返回值，
@NonNull ：表示不可為 null 的變量、參數或返回值。

資源注解

資源注解的使用可使得在源碼階段讓編輯器檢查書寫的不規范，也可在一定程度上優化代碼結構，下面是常見的資源注解如下：

@StringRes：表示檢查是否包含R.string引用
@ColorRes：表示檢查是否包含R.color引用
@ColorInt：表示檢查是否包含表示顏色的整型
@DrawableRes：表示檢查是否包含R.drawable引用
@DimenRes：表示檢查是否包含R.dimen引用
@InterpolatorRes：表示檢查是否包含插值器引用

線程注解

線程注解可以檢查某個方法是否從某個特定類型的線程中調用，支持一下線程注解,具體如下：

@MainThread：表示主線程
@UiThread：表示 UI 線程
@WorkerThread：表示工作線程
@BinderThread：表示Binder線程
@AnyThread：表示任何一個線程

上述注解中 @MainThread 和 @UiThread 在大多時候表示的都是同一線程，如果應用中帶有多個試圖，UI 線程可與主線程不同，故可使用 @UIThread 標注與應用的視圖層次相關聯的方法，使用 @MainThread 僅標注與應用生命周期相關聯的方法。線程注解最常用的一個用途是 AsyncTask 使用中的方法替換，因為 AsyncTask 會執行后臺操作并將結果發布到 UI 線程。

值約束注解

使用值約束注解可驗證傳遞的參數的值的合法性，可以借此指定參數的設置范圍，可在一定程度上減少代碼在主觀程度上出現的錯誤，常見的值約束注解如下：

@IntRange：表示可以驗證整型參數是否在指定范圍內
@FloatRange：表示可以驗證浮點型參數是否在指定范圍內
@Size：表示可以驗證集合、數組、字符串參數是否在指定范圍內，可指定最大值、最小值以及確切值

上面的注解有一些可使用的參數，如 from、to、min 等，使用時具體在某個注解體重查看定義即可。

權限注解

權限注解 @RequiresPermission 可以驗證方法調用方的權限，即當使用了權限注解的方法時會檢查有沒有指定的權限，如果沒有則會提示要在 AndroidManifest.xml 文件中申明權限，如果是危險權限還有進行權限動態申請，使用方式參考如下：

返回值注解

返回值注解 @CheckResult 會檢查某個方法的返回值是否被使用，如果沒有被使用，則會根據 suggest 配置建議使用相同公民沒有返回值的另一個方法，如果返回值使用了，則和未加該注解的方法一樣，使用方式參考如下：

@CheckResult(suggest="#enforcePermission(String,int,int,String)")
public int checkPermission(@NonNull String permission, int pid, int uid){
 return 0;
}

如果沒有使用返回值提示如下：