Android如何使用注解进行代码检查

躬行之
原文首发于微信公众号:躬行之(jzman-blog),欢迎关注交流!

Android Studio 内置了代码检查工具 Lint,可在菜单栏选择 Analyze > Inspect Code 执行相应的代码检查,代码检查能够根据推断一些不合法的潜在问题,有助于在开发阶段发现开发者因为主管原因导致的一下代码问题,Android 官方提供了注解库 support-annotations 来帮助开发者及早发现问题,下面是常用的一些注解,主要内容如下:

  1. Nullness注解
  2. 资源注解
  3. 线程注解
  4. 值约束注解
  5. 权限注解
  6. 返回值注解
  7. CallSuper注解
  8. Typedef注解
  9. 可访问性注解

Nullness注解

使用 Nullness 注解可以检查给定变量、参数和返回值是否允许 null 值,具体如下:

  • @Nullable :表示可以为 null 的变量、参数或返回值,
  • @NonNull :表示不可为 null 的变量、参数或返回值。
@NonNull
@Override
public View onCreateView(String name, @NonNull Context context,@NonNull AttributeSet attrs) {
    //...
}

资源注解

资源注解的使用可使得在源码阶段让编辑器检查书写的不规范,也可在一定程度上优化代码结构,下面是常见的资源注解如下:

  • @StringRes: 表示检查是否包含R.string引用
  • @ColorRes: 表示检查是否包含R.color引用
  • @ColorInt: 表示检查是否包含表示颜色的整型
  • @DrawableRes: 表示检查是否包含R.drawable引用
  • @DimenRes: 表示检查是否包含R.dimen引用
  • @InterpolatorRes:表示检查是否包含插值器引用

线程注解

线程注解可以检查某个方法是否从某个特定类型的线程中调用,支持一下线程注解,具体如下:

  • @MainThread:表示主线程
  • @UiThread:表示 UI 线程
  • @WorkerThread:表示工作线程
  • @BinderThread:表示Binder线程
  • @AnyThread:表示任何一个线程

上述注解中 @MainThread@UiThread 在大多时候表示的都是同一线程,如果应用中带有多个试图,UI 线程可与主线程不同,故可使用 @UIThread 标注与应用的视图层次相关联的方法,使用 @MainThread 仅标注与应用生命周期相关联的方法。线程注解最常用的一个用途是 AsyncTask 使用中的方法替换,因为 AsyncTask 会执行后台操作并将结果发布到 UI 线程。

值约束注解

使用值约束注解可验证传递的参数的值的合法性,可以借此指定参数的设置范围,可在一定程度上减少代码在主观程度上出现的错误,常见的值约束注解如下:

  • @IntRange:表示可以验证整型参数是否在指定范围内
  • @FloatRange:表示可以验证浮点型参数是否在指定范围内
  • @Size:表示可以验证集合、数组、字符串参数是否在指定范围内,可指定最大值、最小值以及确切值

上面的注解有一些可使用的参数,如 from、to、min 等,使用时具体在某个注解体重查看定义即可。

权限注解

权限注解 @RequiresPermission 可以验证方法调用方的权限,即当使用了权限注解的方法时会检查有没有指定的权限,如果没有则会提示要在 AndroidManifest.xml 文件中申明权限,如果是危险权限还有进行权限动态申请,使用方式参考如下:

/**
 * 单个权限检查
 * @param message
 */
@RequiresPermission(Manifest.permission.WRITE_EXTERNAL_STORAGE)
public void setMessage(String message) {
}

/**
 * 全部权限检查
 * @param message
 */
@RequiresPermission(allOf = {
        Manifest.permission.WRITE_EXTERNAL_STORAGE,
        Manifest.permission.READ_EXTERNAL_STORAGE})
public void setMesage(String message) {
}

/**
 * 某个权限检查
 * @param message
 */
@RequiresPermission(anyOf = {
        Manifest.permission.WRITE_EXTERNAL_STORAGE,
        Manifest.permission.READ_EXTERNAL_STORAGE})
public void setMesage(String message) {
}

返回值注解

返回值注解 @CheckResult 会检查某个方法的返回值是否被使用,如果没有被使用,则会根据 suggest 配置建议使用相同公民没有返回值的另一个方法,如果返回值使用了,则和未加该注解的方法一样,使用方式参考如下:

@CheckResult(suggest="#enforcePermission(String,int,int,String)")
public  int checkPermission(@NonNull String permission, int pid, int uid){
    return 0;
}

如果没有使用返回值提示如下:
jzman-blog
当返回值没有被使用,则会建议使用相同功能没有返回值的另一个方法,简而言之,返回值注解 @CheckResult 能够表示某个方法实际使用的时方法本身的处理还是方法最终的处理结果。

CallSuper注解

使用 @CallSuper 注解会验证子类的重写方法是否调用父类的实现,这样约束的好处是可保证父类的实现不会修改,当然,如果不使用该注解,子类重写父类的方法可以不调用弗父类的默认实现,具体参考如下:

/**
 * 父类
 * @CallSuper注解的使用
 */
public class Test {
    //使用@CallSuper注解,子类重写该方法时必须调用该方法
    @CallSuper
    protected void onCreate(){
        
    }
}

下面是 Test 类的实现类:

/**
 * 子类
 * @CallSuper注解的使用
 */
public class TestImpl extends Test{
    @Override
    protected void onCreate() {
        super.onCreate();
        /**
         * 如果不调用父类的方法,则会提示
         * Some methods, such as View#onDetachedFromWindow, require that you also call the super implementation as part of your method.
         */
    }
}

Typedef注解

使用 @IntDef@StringDef 注解 可以创建整型和字符串的枚举注解来验证其他代码中使用的某些整型和字符串,可以保证代码中的某些常量整型或常量字符串是某些具体定义的常量集,这两个注解的位置只能是注解。

开发中总会使用到枚举,枚举在一定程度上可使得代码结构更清晰,但枚举的使用会增加内存的开销,这里可以用 Typedef 注解的方式来代替枚举,下面是 Tyoedef 注解的使用,参考如下:

/**
 * Typedef 注解的定义
 */
public class ActionType {

    public static final int ACTION_TYPE_0 = 0;
    public static final int ACTION_TYPE_1 = 1;
    public static final int ACTION_TYPE_2 = 2;

    @Retention(RetentionPolicy.SOURCE)
    @IntDef({ACTION_TYPE_0,ACTION_TYPE_1,ACTION_TYPE_2})
    public @interface ActionTypeDef{

    }
}

下面是上述 Typedef 注解的使用方式,参考如下:

/**
 * Typedef注解的使用
 * @param value
 */
private void setValue(@ActionType.ActionTypeDef int value) {
    switch (value) {
        case ActionType.ACTION_TYPE_0:
            break;
        case ActionType.ACTION_TYPE_1:
            break;
        case ActionType.ACTION_TYPE_2:
            break;

//        case 100://不能使用未定义的整型
//            break;
    }
}

可见 Typedef 注解约束了使用到的某些整型,当然还可以是字符串,这样也能达到枚举的作用。

可访问性注解

可访问性注解是 @VisibleForTesting@Keep 可以表示方法、字段、类的可访问性。具体如下:

  • @VisibleForTesting:表示注解的某个代码块的可见性高于能够测试时需要的水平
  • @Keep:表示被注解的代码块将不会被混淆。

最常用的可能就是资源注解,如 @StringRes、@ColorRes、@ColorInt等,还有Typeof 注解,该注解可以在替换枚举在 Android 开发中带来的性能影响,如果平时留意这些注解在 Android 源码中也经常使用,所以可在开发过程中尝试去使用这些注解以进行必要的代码检查。

可以关注公众号:躬行之(jzman-blog),一起交流学习。

阅读 110

躬行之
个人公众号:躬行之(jzmna-blog),推送原创Android技术文章,不限于生活、职场等,不定期更新。

微信公众号:躬行之(jzman-blog)

15 声望
3 粉丝
0 条评论

微信公众号:躬行之(jzman-blog)

15 声望
3 粉丝
宣传栏