设为首页 加入收藏

TOP

Android注解支持(Support Annotations)(二)
2015-08-31 21:23:44 来源: 作者: 【 】 浏览:83
Tags:Android 注解 支持 Support Annotations
一个错误:
线程注解


@UiThread还是@MainThread?


在进程里只有一个主线程。这个就是@MainThread。同时这个线程也是一个@UiThread。比如activity的主要窗口就运行在这个线程上。然而它也有能力为应用创建其他线程。这很少见,一般具备这样功能的都是系统进程。通常是把和生命周期有关的用@MainThread标注,和View层级结构相关的用@UiThread标注。但是由于@MainThread本质上是一个@UiThread,而大部分情况下@UiThread又是一个@MainThread,所以工具(lint ,Android Studio,等等)可以把他们互换,所以你能在一个可以调用@MainThread方法的地方也能调用@UiThread方法,反之亦然。


当你的API期望一个颜色资源的时候,可以用@ColorRes标注,但是当你有一个相反的使用场景时,这种用法就不可用了,因为你并不是期望一个颜色资源id,而是一个真实的RGB或者ARGB的颜色值。


在这种情况下,你可以使用@ColorInt注解,表示你期望的是一个代表颜色的整数值:


有了这个,当你传递一个颜色id而不是颜色值的时候,lint就会标记出这段不正确的代码:
颜色值注解


如果你的参数是一个float或者double类型,并且一定要在某个范围内,你可以使用@FloatRange注解:


如果有人使用该API的时候传递一个0-255的值,比如尝试调用setAlpha(128),那么工具就会捕获这一问题:


值约束注解


(你也可以指定是否包括起始值。)


同样的,如果你的参数是一个int或者long类型,你可以使用@IntRange注解约束其值在一个特定的范围内:


把这些注解应用到参数上是非常有用的,因为用户很有可能会提供错误范围的参数,比如上面的setAlpha例子,有的API是采用0-255的方式,而有的是采用0-1的float值的方式。


最后,对于数据、集合以及字符串,你可以用@Size注解参数来限定集合的大小(当参数是字符串的时候,可以限定字符串的长度)。


举几个例子


值约束注解


如果你的方法的调用需要调用者有特定的权限,你可以使用@RequiresPermission注解:


如果你至少需要权限集合中的一个,你可以使用anyOf属性:


如果你同时需要多个权限,你可以用allOf属性:


对于intents的权限,可以直接在定义的intent常量字符串字段上标注权限需求(他们通常都已经被@SdkConstant注解标注过了):


对于content providers的权限,你可能需要单独的标注读和写的权限访问,所以可以用@Read或者@Write标注每一个权限需求:


权限注解


如果你的API允许使用者重写你的方法,但是呢,你又需要你自己的方法(父方法)在重写的时候也被调用,这时候你可以使用@CallSuper标注:


用了这个后,当重写的方法没有调用父方法时,工具就会给予标记提示:


方法重写


(Android Studio 1.3 Preview 1的lint检查有个关于这个注解的bug,这个bug就是即使是对的重写也会报错,这个bug已经在Preview 2版本修改,可以通过canary channel更新到Preview 2版本。)


如果你的方法返回一个值,你期望调用者用这个值做些事情,那么你可以使用@CheckResult注解标注这个方法。


你并不需要微每个非空方法都进行标注。它主要的目的是帮助哪些容易被混淆,难以被理解的API的使用者。


比如,可能很多开发者都对String.trim()一知半解,认为调用了这个方法,就可以让字符串改变以去掉空白字符。如果这个方法被@CheckResult标注,工具就会对那些没有使用trim()返回结果的调用者发出警告。


Android中,Context#checkPermission这个方法已经被@CheckResult标注了:


这是非常重要的,因为有些使用context.checkPermission的开发者认为他们已经执行了一个权限 —-但其实这个方法仅仅只做了检查并且反馈一个是否成功的值而已。如果开发者使用了这个方法,但是又不用其返回值,那么这个开发者真正想调用的可能是这个Context#enforcePermission方法,而不是checkPermission。


返回值


你可以把这个注解标注到类、方法或者字段上,以便你在测试的时候可以使用他们。


我们还在注解库里添加了@Keep注解,但是Gradle插件还支持(尽管已经在进行中)。被这个注解标注的类和方法在混淆的时候将不会被混淆。


如果你在你自己的库中使用了这些注解,并且是通过Gradle构建生成aar包,那么在构建的时候Android Gradle插件会提取注解信息放在AAR文件中供引用你的库的客户端使用。在AAR文件中你可以看到一个名为annotations.zip的文件,这个文件记录的就是注解信息,使用的是IntelliJ的扩展注解XML格式。这是必须的,因为.class文件不能包含足够的要处理以上@IntDef注解的信息;注意我们只需记录该常量的一个引用,而不是它的值。当且仅当你的工程依赖注解库的时候,Android Gradle插件会把提取注解的任务作为构建的一部分执行它。(说明:只有源保留注解被放置在.aar文件中;class级别的会被放在classes.jar里。)


IntelliJ,Android Studio就是基于它开发的,IntelliJ有一套它自己的注解;IntDef分析其实重用的是MagicConstant分析的代码,IntelliJ null分析其实用的是一组配置好的null注解。如果你执行Analyze > Infer Nullity…,它会试图找出所有的null约束并添加他们。这个检查有时会插入IntelliJ注解。你可以通过搜索,替换为Android注解库的注解,或者你也可以直接用IntelliJ注解。在build.gradle里或者通过Project Structure对话框的Dependencies面板都可以添加如下依赖:


首页 上一页 1 2 下一页 尾页 2/2/2
】【打印繁体】【投稿】【收藏】 【推荐】【举报】【评论】 【关闭】 【返回顶部
分享到: 
上一篇Android使用SVG矢量图打造酷炫动.. 下一篇jQuery实现数字滚动效果

评论

帐  号: 密码: (新用户注册)
验 证 码:
表  情:
内  容: