對于Android開發來說，注解可是個好東西，但是利用的不多，我研究過國內不少SDK，發現很少有使用注解的，至于App的開發團隊的使用情況不太清楚，但是就我接觸的而言，使用的也不多。之前接觸過國外的一些SDK，比如facebook相關的一些SDK，你查看一下源碼，就會發現，注解是一個很普遍的存在。
注解庫
如果你使用了com.android.support:appcompat-v7庫不需要添加額外的依賴。
但是如果你沒有使用這個庫，也可以額外單獨添加注解庫。compile 'com.android.support:support-annotations:xx.xx.xx'。
Nullable NonNull
下面舉個例子：
public class MainActivity extends AppCompatActivity {
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
test1(null);
test2(null);
}
private void test1(@NonNull String str){
Log.e(this.getClass().getName(),str);
}
private void test2(@Nullable String str){
if (str!=null){
Log.e(this.getClass().getName(),str);
}
}
}
將上面代碼放到IDE中，顯示效果如下：
我們可以看到test1傳入的參數被加重標識出來，如果將鼠標放到上面會有如下顯示：
這樣，我們可以輕易發現錯誤，避免空指針的crash發生，養成在每個方法中加注解的習慣，增強代碼的嚴謹性。
資源類型的注解
資源類型的注解，有以下幾種：
- @StringRes
- @ColorRes
- @AnimationRes
- @DimensionRes
- @DimensionPixelOffsetRes
- @DimensionPixelSizeRes
- @BooleanRes
- @ColorStateListRes
- @DrawableRes
- @IntArrayRes
- @IntegerRes
- @LayoutRes
- @MovieRes
- @TextRes
- @TextArrayRes
- @StringArrayRes
這些注解在用法上都是一樣的，只是標識的類型不一樣（不一一介紹了，通過名字就能看出來），下面看一下用法：
private void setText1(@StringRes int id){
}
private void setText2( int id){
}
上面連個方法一個是帶資源注解的，一個是不帶的，我們在IDE中調用一下，看有什么區別：
從上圖中可以看出，加了資源注解的方法，如果傳入的資源是錯的類型，就會報錯，這樣更容易發現程序中的bug。
IntDef StringDef
IntDef StringDef可以限制傳入參數的內容，這在一些固定參數的方法中尤為重要，比如網絡的get post方法：
比如：
private static final int INTGET = 0;
private static final int INTPOST = 1;
private static final String STRGET = "get";
private static final String STRPOST = "post";
然后使用IntDef StringDef定義注解接口
@IntDef({INTGET, INTPOST})
public @interface HttpMethod {
}
@StringDef({STRGET, STRPOST})
public @interface MethodName {
}
public void setMethod(@HttpMethod int httpmethod) {
}
public void setMethod(@MethodName String httpmethod) {
}
這時偶們再調用setMethod方法，會有如下效果：
傳入的參數，只能是之前定義的那幾個，如果是任意輸入的都會提示報錯。
權限注解
對于有些方法可能需要系統的一些權限，但是我們會忘了在Manifest中加入這些權限，導致程序報錯。這時我們就可以使用權限注解：
@RequiresPermission(Manifest.permission.INTERNET)
private void getDataFromNet(){
}
這時，如果沒有這個權限，然后去調用這個方法：
強制super
比如我們寫一個基類：
public class Base {
@CallSuper
public void test(){
Log.e("","");
}
}
這時如果我們寫一個類，繼承這個類，如果不去super父類的方法就會這樣：
@keep
一看到這個詞肯定第一反應就是跟混淆相關的，沒錯，這個就是標識該方法被keep出來，當然你也可以在混淆文件中keep，混淆文件的規則可以參考Android混淆機制
總結
基本的注解就總結到這里，使用注解，養成一個良好的代碼習慣，可以使代碼更加嚴謹。
