【Android】 註解是個好東西, 這個可以有

mymdeep發表於2017-03-11
Android

對於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中，顯示效果如下：

【Android】 註解是個好東西, 這個可以有
Paste_Image.png

我們可以看到test1傳入的引數被加重標識出來，如果將滑鼠放到上面會有如下顯示：

【Android】 註解是個好東西, 這個可以有

這樣，我們可以輕易發現錯誤，避免空指標的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中呼叫一下，看有什麼區別：

【Android】 註解是個好東西, 這個可以有

從上圖中可以看出，加了資源註解的方法，如果傳入的資源是錯的型別，就會報錯，這樣更容易發現程式中的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方法，會有如下效果：

【Android】 註解是個好東西, 這個可以有

傳入的引數，只能是之前定義的那幾個，如果是任意輸入的都會提示報錯。

許可權註解

對於有些方法可能需要系統的一些許可權，但是我們會忘了在Manifest中加入這些許可權，導致程式報錯。這時我們就可以使用許可權註解：

 @RequiresPermission(Manifest.permission.INTERNET)
    private void getDataFromNet(){

    }複製程式碼

這時，如果沒有這個許可權，然後去呼叫這個方法：

【Android】 註解是個好東西, 這個可以有

強制super

比如我們寫一個基類：

public class Base {
    @CallSuper
    public void test(){
        Log.e("","");
    }
}複製程式碼

這時如果我們寫一個類，繼承這個類，如果不去super父類的方法就會這樣：

【Android】 註解是個好東西, 這個可以有

@keep

一看到這個詞肯定第一反應就是跟混淆相關的，沒錯，這個就是標識該方法被keep出來，當然你也可以在混淆檔案中keep，混淆檔案的規則可以參考Android混淆機制

總結

基本的註解就總結到這裡，使用註解，養成一個良好的程式碼習慣，可以使程式碼更加嚴謹。

相關文章