對于Android開發(fā)來說吃环,注解可是個好東西也颤,但是利用的不多,我研究過國內(nèi)不少SDK郁轻,發(fā)現(xiàn)很少有使用注解的翅娶,至于App的開發(fā)團(tuán)隊的使用情況不太清楚文留,但是就我接觸的而言,使用的也不多竭沫。之前接觸過國外的一些SDK燥翅,比如facebook相關(guān)的一些SDK,你查看一下源碼蜕提,就會發(fā)現(xiàn)森书,注解是一個很普遍的存在。
注解庫
如果你使用了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傳入的參數(shù)被加重標(biāo)識出來镣煮,如果將鼠標(biāo)放到上面會有如下顯示:
這樣姐霍,我們可以輕易發(fā)現(xiàn)錯誤,避免空指針的crash發(fā)生典唇,養(yǎng)成在每個方法中加注解的習(xí)慣镊折,增強(qiáng)代碼的嚴(yán)謹(jǐn)性。
資源類型的注解
資源類型的注解介衔,有以下幾種:
- @StringRes
- @ColorRes
- @AnimationRes
- @DimensionRes
- @DimensionPixelOffsetRes
- @DimensionPixelSizeRes
- @BooleanRes
- @ColorStateListRes
- @DrawableRes
- @IntArrayRes
- @IntegerRes
- @LayoutRes
- @MovieRes
- @TextRes
- @TextArrayRes
- @StringArrayRes
這些注解在用法上都是一樣的恨胚,只是標(biāo)識的類型不一樣(不一一介紹了,通過名字就能看出來)炎咖,下面看一下用法:
private void setText1(@StringRes int id){
}
private void setText2( int id){
}
上面連個方法一個是帶資源注解的赃泡,一個是不帶的,我們在IDE中調(diào)用一下乘盼,看有什么區(qū)別:
從上圖中可以看出升熊,加了資源注解的方法,如果傳入的資源是錯的類型绸栅,就會報錯级野,這樣更容易發(fā)現(xiàn)程序中的bug。
IntDef StringDef
IntDef StringDef可以限制傳入?yún)?shù)的內(nèi)容粹胯,這在一些固定參數(shù)的方法中尤為重要蓖柔,比如網(wǎng)絡(luò)的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) {
}
這時偶們再調(diào)用setMethod方法,會有如下效果:
傳入的參數(shù)风纠,只能是之前定義的那幾個渊抽,如果是任意輸入的都會提示報錯。
權(quán)限注解
對于有些方法可能需要系統(tǒng)的一些權(quán)限议忽,但是我們會忘了在Manifest中加入這些權(quán)限懒闷,導(dǎo)致程序報錯。這時我們就可以使用權(quán)限注解:
@RequiresPermission(Manifest.permission.INTERNET)
private void getDataFromNet(){
}
這時,如果沒有這個權(quán)限愤估,然后去調(diào)用這個方法:
強(qiáng)制super
比如我們寫一個基類:
public class Base {
@CallSuper
public void test(){
Log.e("","");
}
}
這時如果我們寫一個類帮辟,繼承這個類,如果不去super父類的方法就會這樣:
@keep
一看到這個詞肯定第一反應(yīng)就是跟混淆相關(guān)的玩焰,沒錯由驹,這個就是標(biāo)識該方法被keep出來,當(dāng)然你也可以在混淆文件中keep昔园,混淆文件的規(guī)則可以參考Android混淆機(jī)制
總結(jié)
基本的注解就總結(jié)到這里蔓榄,使用注解,養(yǎng)成一個良好的代碼習(xí)慣默刚,可以使代碼更加嚴(yán)謹(jǐn)甥郑。