2.2Android Studio通过注解提升代码检测

Posted 2022-09-10 宋志辉

使用像Lint这样的代码检测工具可以帮助你发现问题和提升代码，但是代码检测在有些地方很难应用。例如，android的资源ID，使用一个int类型来表示字符、图像、颜色或者其他资源类型所以代码检测工具不能分辨这是一个字符串资源，还是一个颜色资源。这种情况下，即使你使用代码检测工具，你的app可能会渲染失败或者不能运行。

注解允许你为Lint这样的代码检测工具提供提示来帮助Lint检测更深层次问题。当你使用代码检测工具的时候，注解可以帮助你检测问题，比如空指针异常和资源类型冲突。

Android支持多种注解，允许你在方法，参数和返回值中使用，比如：
1、@Nullable
可以为空
2、@NonNull
不可以为空
3、@StringRes
提示Lint为String资源
4、@DrawableRes
提示Lint为Drawable资源
5、@ColorRes
提示Lint为Color资源
6、@InterpolatorRes
提示为Interpolator资源
7、@AnyRes
提示为任何类型的资源
8、@UiThread
在主线程中调用
这里仅仅列出部分的注解。

添加基本注解

为了添加注解到你的代码中，首先需要添加一个依赖：
1、 选择File > Project Structure
2、 在Project Structure中选择相应的模块，点击Dependencies标签
3、 单击+导入一个Library dependency
4、 在Choose Library Dependency对话框，选择support-annotations，点击OK
在build.gradle文件中自动更新了support-annotations依赖。
你也可以手动添加：
dependencies
compile ‘com.android.support:support-annotations:23.3.0’

如果你在一个library中添加注解，并打包成AAR，注解将会以XML格式保存在annotations.zip文件中。

添加空的注解

添加@Nullable和@NonNull注解来检测给定的变量，参数或者返回值是否为空。比如，一个值为null的本地变量通过参数传递给添加了@NonNull注解的参数，构建代码回生成一个警告。如下：
import android.support.annotation.NonNull;
…
@NonNull
@Override
public View onCreateView(String name, @NonNull Context context,
@NonNull AttributeSet attrs)
…

…

判空分析

Android Studio运行一个判空分析，并且自动添加相关的注解到你的代码中。可以检测：
1、 调用方法是否返回null
2、 方法不能返回null
3、 变量不能为null
4、 变量不能保持一个null值

添加资源注解

比如，添加@StringRes注解可以检测一个资源参数是否包含R.string。在代码检测的时候，如果R.string没有通过参数进行传递，则生成一个警告。
如下：
import android.support.annotation.StringRes;
public abstract void setTitle(@StringRes int resId);

添加线程注解

线程注解检测一个方法事是否运行在特定的线程，支持如下线程注解：
1、@UiThread
2、@MainThread
3、@WorkerThread
4、@BinderThread
注意：@UiThread和@MainThread是可以互换的

添加值约束注解

使用@IntRange、@FloatRange和@Size注解来验证传递参数的值。
@IntRange注解验证参数值是否在特定的范围内，如下示例确保alpha参数范围在0到255之间。
public void setAlpha(@IntRange(from=0,to=255) int alpha) …
@FloatRange注解检测参数值是否在一定的浮点范围内。下面这个示例确保alpha参数为0.0到1.0的参数:
public void setAlpha(@FloatRange(from=0.0, to=1.0) float alpha) …

@Size注解检测集合、数组或字符串的大小，比如，使用@Size(min=1)注解来判断集合是否为空，使用@Size（2）注解来验证一个数组是否包含两个值。以下示例确保location数组包含至少一个元素：
int[] location = new int[3];
button.getLocationOnScreen(@Size(min=1) location);

添加权限注解

使用@RequiresPermission注解来验证调用方法调用时的权限。为了检查是否用到很多权限中的某个权限，使用anyOf属性，检测是否用到多个权限，使用allOf属性。如下：
@RequiresPermission(Manifest.permission.SET_WALLPAPER)
public abstract void setWallpaper(Bitmap bitmap) throws IOException;

另外一个示例：
@RequiresPermission(allOf =
Manifest.permission.READ_EXTERNAL_STORAGE,
Manifest.permission.WRITE_EXTERNAL_STORAGE)
public static final void copyFile(String dest, String source)
…

添加结果检测注解

使用@CheckResults注解来验证一个方法的结果或者返回值是否被使用。如下：
@CheckResult(suggest=”#enforcePermission(String,int,int,String)”)
public abstract int checkPermission(@NonNull String permission, int pid, int uid);

添加调用super 注解

使用@CallSuper注解来验证重写方法是否调用了父类的方法。如下：

本文作者：宋志辉
个人微博：点击进入