请使用Support Annotations 进行代码检查

1.Support Annotations 是什么?

Support Annotations 是Android 官方注解支持库。(如果对 Annotation 不了解的可参考:Java Annotation)主要作用是用于在编译期间进行代码检查,能在编译期间提示代码是否符合规范,参数是否为null,是否正确等。

将以下代码行添加到 build.gradle文件的dependencies块中,即可添加support-annotations依赖

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

Support Annotations 内容

1.资源注解 

@AnimatorRes :Xml资源属性动画注解

@AnimRes :Xml资源动画

@AnyRes :能够指示注解的参数可为任意类型的R资源,但并不能区别出类型

@ArrayRes :用于指定R.array.*类型数据

@AttrRes :自定义属性 R.attr.*

@BoolRes : 指定R.bool.* Boolean类型资源

@ColorRes :指定R.color.* 颜色资源

@DimenRes:指定 R.dimen.*大小资源

@DrawableRes :图片资源 R.drawable.*

@IdRes : id 资源文件 R.id.*

@IntegerRes :int 资源id R.integer.*

@InterpolatorRes :动画插值器资源 R.interpolator.*

@LayoutRes :指定layout 资源文件 R.layout.*

@MenuRes : 指定菜单文件 R.menu.*

@RawRes : 指定本地音频文件 R.raw.*

@StringRes : 指定字符串常量 R.string.*

@StyleableRes:指定自定义属性集合 R.styleable.*

@StyleRes: 指定样式 R.style.*

@TransitionRes : 指定 过度动画资源 R.transition.*

@XmlRes : 指定xml 资源文件 R.xml.*

以上就是常用的资源注解,资源注解能帮助我们在编译期间发现方法调用,传参可能出现的问题,IDE能提前发现问题,并提示给我们。说了那么多举个栗子吧!

比如再启动一个新Activity 添加一个转场动画我们可以写这样的代码:


本来enterAnim 和 exitAnim 应该是R.anim 资源动画 但是我给他们传值R.id.basic,0发现IDE并没有提示我的参数是否合法,这样就只能运行时才能发现我的参数是错误的,这样效率真的降低了,那么现在引入注解就完全不一样了...

我们把方法参数加上@AnimRes 注解 发现IDE 会自动检查我们的参数是否正确并给出警告,这样就在编译期间发现这些bug提高效率了

使用资源注解很简单只需要在方法,变量定义处添加注解即可

调用

2.线程注解

@MainThread

@UiThread

@WorkerThread

@BinderThread

@AnyThread

@MainThread和@UiThread注解效果相同,因此可以从@MainThread方法调用@UiThread方法,反之也可。@WorkerThread 用于注解一个工作线程 @BinderThread 用于指定线程为绑定线程 @AnyThread 可以注解任何线程

3.约束注解

约束注解包括:@IntRange@FloatRange 和 @Size

@FloatRange 用于约束double 类型参数范围使用如下:

@FloatRange 注解

form double 类型 用户指定参数开始值 

to double 类型 用于指定参数最大值 

fromInclusive Boolean 类型 用于控制参数是否可以和form的值相同(默认 true)

toInclusive Boolean 类型 用于控制参数是否可以和to的值相同 (默认 true)

@IntRange 用于约束整型数据参数范围使用如下:

@IntRange 注解

使用方式和@FloatRange 一致 不过并没有fromInclusive, toInclusive 控制条件

@Size 注解可以检查集合或数组的大小,以及字符串的长度。@Size注解可用于验证以下

min 表示最小大小(例如@Size(min=2))

max 表示最大大小(例如@Size(max=2))

确切大小(例如@Size(2))

multiple 表示大小必须为此倍数的数字(例如@Size(multiple=2)) 

例如:

@Size 注解

4.权限注解

@RequiresPermission

使用@RequiresPermission注解可以检查方法调用方的权限是否拥有权限。(Android 6.0 需要动态申请隐私权限,不了解的可点此处:Android 6.0 Permissions)。

要检查有效权限列表中是否存在某个权限,请使用anyOf属性。要检查是否存在一组权限,请使用allOf属性。

@RequiresPermission 注解

startCamera() 要拥有启动照相机的权限,copyFile() 需要拥有读取和写入SD卡的权限 。对于 intent 权限,可直接将要申请的权限定义在字符串常量上。

对于需要单独读写权限的可使用@RequiresPermission.Read@RequiresPermission.Write注解 

@RequiresPermission.Write,@RequiresPermission.Read

5.返回值注解

@CheckResult 注解是用来检查实际使用的是方法的结果还是返回值。并不是标注方法返回值不是null

6.Callsuper 注解

@CallSuper注解用于检查子类重写的方法是否调用父类方法 super.*  示例:

我们先定义一个抽象类 BaseActivity 定义一个bindView()使用@CallSuper 注解

BaseActivity

之后在新建一个UserActivity 继承 BaseActivity 之后实现 bindView() 如果不加上super.bindView(); 就会提示出错 这就是 @CallSuper 注解 的作用

UserActivity

7.Typedef 注解

typedef注解包括 @IntDef@StringDef 注解。使用@IntDef@StringDef注解,以便能够创建整型和字符串集的类似枚举类型的引用。

Typedef 注解使用@interface声明新的枚举注解类型。

举个栗子 :假设我们要给一个方法传入固定类型的值怎么传?一般我们有两种做法 1:使用枚举 2:定义常量 

现在结合Typedef 就能达到以上两种要求:

getLayoutView() 是根据state 值 返回不同的view

getLayoutView

state 的值都是常量如下

state 值

在上面的getLayoutView()中我们定义的参数是 @ViewState int state 这个@ViewState 就是结合Typedef 自定义注解 使用@IntDef 固定了@ViewState 做参数的类型。

自定义@ViewState注解结合@IntDef

这样就能达到想枚举一样使用如下,它规定了state 的值,不能传入其他值,和枚举,常量等使用相同。

调用时IDE提示

8.Null ness 注解

Null ness 注解包括 @Nullable@NonNull注解 @Nullable 表示可以为null @NonNull 表示不能为null

举个例子 当用@NonNull 标识一个参数时 表示参数不能为null,当传入null IDE 就会给出提示,@Nullable 表示可以为null IDE 不做检查 ,这样我们就能根据IDE给出的提示找出原因了

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

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,510评论 18 139
  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,135评论 25 707
  • 今天和同事陈桑一起和咖啡的时候,听他聊起上周他回国参加的一个报告会.是五角场那边一个项目孵化第一期项目汇报,听他讲...
    卡纳西阅读 440评论 0 2
  • 很难受 最近看书其实心态很好 拿一些事情去学习也表现的很不错! 可是不知道为什么总是会胡思乱想一些事情 一个字一个...
    gisslle阅读 169评论 0 0
  • 亦舒说我希望我的朋友和敌人都飞黄腾达,五世其昌,那样开心才不会加害于我。 看到王宝强离婚的消息,以及各种八卦消息,...
    只有香如故阅读 475评论 0 1