【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中,显示效果如下:

Paste_Image.png

我们可以看到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混淆机制

总结

基本的注解就总结到这里,使用注解,养成一个良好的代码习惯,可以使代码更加严谨。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,948评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,371评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 157,490评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,521评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,627评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,842评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,997评论 3 408
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,741评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,203评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,534评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,673评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,339评论 4 330
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,955评论 3 313
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,770评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,000评论 1 266
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,394评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,562评论 2 349

推荐阅读更多精彩内容