Android注解支持(Support Annotations)

注解支持(Support Annotations)

Android support library从19.1版本开始引入了一个新的注解库,它包含很多有用的元注解,你能用它们修饰你的代码,帮助你发现bug。Support library自己本身也用到了这些注解,所以作为support library的用户,Android Studio已经基于这些注解校验了你的代码并且标注其中潜在的问题。Support library 22.2版本又新增了13个新的注解以供使用。

使用注解库

注解默认是没有包含的;他们被包装成一个独立的库。(support library现在由一些更小的库组成:v4-support, appcompat, gridlayout, mediarouter等等)

(如果你正在使用appcompat库,那么你已经可以使用这些注解了,因为appcomat它自己也依赖它。)

添加使用注解最简单的方式就是打开Project Structure对话框。首先在左边选中module,然后在右边选中Dependencies标签页,点击面板底部的+按钮,选择Library Dependency,假设你已经把Android Support Repository安装到你的SDK中了,那么注解库将会出现在列表中,你只需点击选中它即可(这里是列表中的第一个):

添加依赖

点击OK完成Project Structure的编辑。这会修改你的build.gradle文件,当然你也可以手动编辑它:

dependencies { compile 'com.android.support:support-annotations:22.2.0' }

对于Android application和Android library这两个类型的module(你应用了com.android.application或者com.android.library插件的)来说,你需要做的已经都做好了。如果你想只在Java module使用这些注解,那么你就明确的包含SDK仓库了,因为support libraries不能从jcenter获得(Android Gradle插件会自动的包含这些依赖,但是Java插件却没有。)

repositories { jcenter() maven { url '<your-SDK-path>/extras/android/m2repository' } } 执行注解

当你用Android Studio和IntelliJ的时候,如果给标注了这些注解的方法传递错误类型的参数,那么IDE就会实时标记出来。

从Gradle插件1.3.0-beta1版本开始,并且安装了Android M Preview平台工具的情况下,通过命令行调用gradle的lint任务就可以执行这些检查。如果你想把标记问题作为持续集成的一部分,那么这种方式是非常有用的。说明:这并不包含nullness注解。本文中所介绍的其他注解都可以通过lint执行检查。

Nullness Annotations

@Nullable注解能被用来标注给定的参数或者返回值可以为null。
类似的,@NonNull注解能被用来标注给定的参数或者返回值不能为null。

如果一个本地变量的值为null(比如因为过早的代码检查它是否为null),而你又把它作为参数传递给了一个方法,并且该方法的参数又被@NonNull标注,那么IDE会提醒你,你有一个潜在的崩溃问题。

v4 support library中的FragmentActivity的示例代码: import android.support.annotation.NonNull; import android.support.annotation.Nullable; ... /** * Add support for inflating the &lt;fragment> tag. */ @Nullable @Override public View onCreateView(String name, @NonNull Context context, @NonNull AttributeSet attrs) { ...

(如果你执行Analyze > Infer Nullity,或者你在键入时把@NonNull替换成了@NotNull,那么IDE可能会提供附加的IntelliJ注解。参考底部的“IntelliJ Annotations”段落了解更多)

注意@NonNull和@Nullable并不是对立的:还有第三种可能:未指定。当你没有指定@NonNull或者@Nullable的时候,工具就不能确定,所以这个API也就不起作用。

最初,我们在findViewById方法上标注@Nullable,从技术上说,这是正确的:findViewById可以返回null。但是如果你知道你在做什么的时候(如果你传递给他一个存在的id)他是不会返回null的。当我们使用@Nullable注解它的时候,就意味着源代码编辑器中会有大量的代码出现高亮警告。如果你已经意识到每次使用该方法都应该明确的进行null检查,那么就只能用@Nullable标注返回值。有个经验规则:看现有的“好的代码”(比如审查产品代码),看看这些API是怎么被使用的。如果该代码为null检查结果,你应该为方法注解@Nullable。

资源类型注解

Android的资源值通常都是使用整型传递。这意味着获取一个drawable使用的参数,也能很容易的传递给一个获取string的方法;因为他们都是int类型,编译器很难区分。

资源类型注解可以在这种情况下提供类型检查。比如一个被@StringRes住进诶的int类型参数,如果传递一个不是R.string类型的引用将会被IDE标注:

资源类型注解


以ActionBar为例:

import android.support.annotation.StringRes; ... public abstract void setTitle(@StringRes int resId);

内容版权声明:除非注明,否则皆为本站原创文章。

转载注明出处:https://www.heiqu.com/132c6d4ad0999ec70a2dae919be2c33e.html