概述

Support Annotation Library是在Android Support Library19.1版本開始引入的一個全新的函式包，它包含了諸多有用的元註解。用來幫助開發者在編譯期間發現可能存在的bug。Support Library本身也使用Annotations Library提供的註解來完善Library的程式碼質量。
Android的每一個版本都在不斷的完善Annotation Library，在Android Support Library22.2版本中，又新增了13種新的Annotation Library註解。Android Support Library發展到25，已經有多個獨立的jar，如我們常見的Support-v4，Support-v7…

Annotation Library的使用

如果我們的sdk安裝了Android Support Respository,那麼我們可以開啟工程的Srrucure，選中Module，選中Dependencies選項卡，點選新增按鈕，選中Android Library。然後通過gradle可以很容易的把這些註解新增到我們的工程中。

compile 'com.android.support:support-annotations:23.1.1'

常用註解

Nullness註解

使用@NonNull註解修飾的引數不能為null。在下面的程式碼例子中，我們有一個取值為null的name變數，它被作為引數傳遞給sayHello函式，而該函式要求這個引數是非null的String型別：

public class MainActivity extends ActionBarActivity {
    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        String name = null;
        sayHello(name);
    }

    void sayHello(@NonNull
 
 String s) {
        Toast.makeText(this, "Hello " + s, Toast.LENGTH_LONG).show();
    }
}

由於程式碼中引數String s使用@NonNull註解修飾，因此IDE將會以警告的形式提醒我們這個地方有問題。

資源型別註解

我們知道在Android中，資源通常以整型表示，並儲存在R.java中，這意味著如果資源傳的是String型別，則編譯就會報錯，為了給開發者以提示，Android有了資源型別註解，在最新的版本中，每種資源都對應一種註解。

常見的資源型註解如下：
AnimRes
AnimatorRes
AnyRes
ArrayRes
AttrRes
BoolRes
ColorRes
DimenRes
DrawableRes
FractionRes
IdRes
IntegerRes
InterpolatorRes
LayoutRes
MenuRes
PluralsRes
RawRes
StringRes
StyleRes
StyleableRes
TransitionRes
XmlRes

型別定義註解

在Android開發中，整型不僅用來代表資源引用值，還可以用來代表列舉，IntDef註解就是用來定義整型的新註解，我們可以用來標記我們自己編寫的api，例如：

public class IceCreamFlavourManager {
    private int flavour;
    public static final int VANILLA = 0;
    public static final int CHOCOLATE = 1;
    public static final int STRAWBERRY = 2;
    @IntDef({VANILLA, CHOCOLATE, STRAWBERRY})
    public @interface Flavour {
    }
    @Flavour
    public int getFlavour() {
        return flavour;
    }
    public void setFlavour(@Flavour int flavour) {
        this.flavour = flavour;
    }
}

這時如果我們使用錯誤的整型值呼叫IceCreamFlavourManager.setFlavour時，IDE將報錯。

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

@IntDef(flag = true, value = {VANILLA, CHOCOLATE, STRAWBERRY})

    public @interface Flavour {

}

那麼我們可以這麼呼叫。

iceCreamFlavourManager.setFlavour(IceCreamFlavourManager.VANILLA & IceCreamFlavourManager
                .CHOCOLATE);

@StringDef用法和@IntDef基本差不多。

許可權註解

在Android中,有很多場景都需要使用許可權,無論是Marshmallow之前還是之後的動態許可權管理.都需要在manifest中進行宣告,如果忘記了,則會導致程式崩潰. 好在有一個註解能輔助我們避免這個問題.使用RequiresPermission註解即可。

@RequiresPermission(Manifest.permission.SET_WALLPAPER)
  public void changeWallpaper(Bitmap bitmap) throws IOException {
}

Color值限定註解

上面部分提到了ColorRes,用來限定顏色資源id,這裡我們將使用ColorInt,一個用來限定Color值的註解. 在較早的TextView的setTextColor是這樣實現的。

public void setTextColor(int color) {
  mTextColor = ColorStateList.valueOf(color);
  updateTextColors();
}

執行緒註解

Android開發中經常會涉及到很多執行緒，如主執行緒，子執行緒等操作。我相信大家在使用什麼EventBus，訊息匯流排…看的比較多，Android中提供了四個與執行緒相關的註解。

• @UiThread,通常可以等同於主執行緒,標註方法需要在UIThread執行,比如View類就使用這個註解
• @MainThread 主執行緒,經常啟動後建立的第一個執行緒
• @WorkerThread 工作者執行緒,一般為一些後臺的執行緒,比如AsyncTask裡面的doInBackground就是這樣的.
• @BinderThread 註解方法必須要在BinderThread執行緒中執行,一般使用較少.
  例如大名鼎鼎的AsyncTask。

new AsyncTask<Void, Void, Void>() {
    //doInBackground is already annotated with @WorkerThread
    @Override
    protected Void doInBackground(Void... params) {
      return null;
      updateViews();//error
    }
  };

@UiThread
public void updateViews() {
  Log.i(LOGTAG, "updateViews ThreadInfo=" + Thread.currentThread());
}

注意,這種情況下不會出現錯誤提示。

new Thread(){
  @Override
  public void run() {
    super.run();
    updateViews();
  }
}.start();

雖然updateViews會在一個新的工作者執行緒中執行,但是在compile時沒有錯誤提示。因為它的判斷依據是,如果updateView的執行緒註解(這裡為@UiThread)和run(沒有執行緒註解)不一致才會錯誤提示.如果run方法沒有執行緒註解,則不提示。

CallSuper重寫函式註解

重寫的方法必須要呼叫super方法。使用這個註解,我們可以強制方法在重寫時必須呼叫父類的方法 比如ApplicationonCreate,onConfigurationChanged等。

@Keep註解

在Android編譯生成APK的環節,我們通常需要設定minifyEnabled為true實現下面的兩個效果
混淆程式碼
刪除沒有用的程式碼
但是出於某一些目的,我們需要不混淆某部分程式碼或者不刪除某處程式碼,除了配置複雜的Proguard檔案之外,我們還可以使用@Keep註解 。

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

返回值註解

我們開發的時候，有時候需要對返回的值做一些出來，那麼久用到了@CheckResult註解，如果一個方法得到了結果，卻沒有使用這個結果，就會有錯誤出現，一旦出現這種錯誤，就說明你沒有正確使用該方法。

@CheckResult
public String trim(String s) {
  return s.trim();
}

註解在Android開發中隨處可以看到，如ButterKnife，afinal,eventbus等，這些都大大提高了我們的開發效率。