XAOP 一个轻量级的AOP(Android)应用框架

xuexiangjys

发布于 2022-04-18 12:40:32

7400

发布于 2022-04-18 12:40:32

在软件业，AOP又名面向切面编程，通过预编译方式和运行期动态代理实现程序功能的统一维护的一种技术。AOP是OOP的延续，是软件开发中的一个热点，也是Spring框架中的一个重要内容，是函数式编程的一种衍生范型。利用AOP可以对业务逻辑的各个部分进行隔离，从而使得业务逻辑各部分之间的耦合度降低，提高程序的可重用性，同时提高了开发的效率。

那么在Android中，我们使用AOP可以解决哪些问题呢？以下我简单列举几个常用的场景：

（1）可以解决快速点击的问题

（2）解决Android6.0以上动态权限申请的问题

（3）线程自由切换的问题

（4）日志埋点问题

（5）缓存问题

（6）异常捕获处理

（7）业务拦截（登陆验证、有效性验证等）

看到AOP能解决这么多问题，你是不是也心痒痒，跃跃欲试了呀？下面我将来给大家介绍一下我的开源项目XAOP。

项目的地址：

https://github.com/xuexiangjys/XAOP

1、如何使用

1.1、添加Gradle依赖

1.先在项目根目录的 build.gradle 的 repositories 添加:

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

2.再在项目根目录的 build.gradle 的 dependencies 添加xaop插件：

buildscript {
    ···
    dependencies {
        ···
        classpath 'com.github.xuexiangjys.XAOP:xaop-plugin:1.0.1'
    }
}

3.在项目的 build.gradle 中增加依赖并引用xaop插件

apply plugin: 'com.xuexiang.xaop' //引用xaop插件

dependencies {
    ···
    //添加依赖
    implementation 'com.github.xuexiangjys.XAOP:xaop-runtime:1.0.1'
    //如果你升级到androidx，请使用下面依赖
    implementation 'com.github.xuexiangjys.XAOP:xaop-runtime:x1.0.1'
}

4.在Application中进行初始化

XAOP.init(this); //初始化插件
XAOP.debug(true); //日志打印切片开启
XAOP.setPriority(Log.INFO); //设置日志打印的等级,默认为0

//设置动态申请权限切片 申请权限被拒绝的事件响应监听
XAOP.setOnPermissionDeniedListener(new PermissionUtils.OnPermissionDeniedListener() {
    @Override
    public void onDenied(List<String> permissionsDenied) {
        ToastUtil.get().toast("权限申请被拒绝:" + Utils.listToString(permissionsDenied));
    }

});

//设置自定义拦截切片的处理拦截器
XAOP.setInterceptor(new Interceptor() {
    @Override
    public boolean intercept(int type, JoinPoint joinPoint) throws Throwable {
        switch(type) {
            case 1:
                //做你想要的拦截
                break;
            case 2:
                return true; //return true，直接拦截切片的执行
            default:
                break;
        }
        return false;
    }
});

//设置自动捕获异常的处理者
XAOP.setIThrowableHandler(new IThrowableHandler() {
    @Override
    public Object handleThrowable(String flag, Throwable throwable) {
        XLogger.d("捕获到异常，异常的flag:" + flag);
        if (flag.equals(TRY_CATCH_KEY)) {
            return 100;
        }
        return null;
    }
});

2.2、兼容Kotlin语法配置

1.在项目根目录的 build.gradle 的 dependencies 添加aspectjx插件：

buildscript {
    ···
    dependencies {
        ···
        classpath 'com.hujiang.aspectjx:gradle-android-plugin-aspectjx:2.0.0'
    }
}

2.在项目的 build.gradle 中增加依赖并引用aspectjx插件

apply plugin: 'android-aspectjx' //引用aspectjx插件

详细使用可参见kotlin-test项目进行使用.

2、切片的使用

2.1、快速点击切片使用

1.使用 @SingleClick标注点击的方法。注意点击的方法中一定要有点击控件View作为方法参数，否则将不起作用。

2.可以设置快速点击的时间间隔，单位:ms。不设置的话默认是1000ms。

@SingleClick(5000)
public void handleOnClick(View v) {
    XLogger.e("点击响应！");
    ToastUtil.get().toast("点击响应！");
    hello("xuexiangjys", "666666");
}

2.2、动态申请权限切片使用

1.使用 @Permission标注需要申请权限执行的方法。可设置申请一个或多个权限。

2.使用 @Permission标注的方法，在执行时会自动判断是否需要申请权限。

@SingleClick
@Permission({PermissionConsts.CALENDAR, PermissionConsts.CAMERA, PermissionConsts.LOCATION})
private void handleRequestPermission(View v) {

}

2.3、主线程切片使用

1.使用 @MainThread标注需要在主线程中执行的方法。

2.使用 @MainThread标注的方法，在执行时会自动切换至主线程。

@MainThread
private void doInMainThread(View v) {
    mTvHello.setText("工作在主线程");
}

2.4、IO线程切片使用

1.使用 @IOThread标注需要在io线程中执行的方法。可设置线程池的类型 ThreadType，不设置的话默认是Fixed类型。

线程池的类型如下:

Single:单线程池
Fixed:多线程池
Disk:磁盘读写线程池(本质上是单线程池）
Network:网络请求线程池(本质上是多线程池）

2.使用 @IOThread标注的方法，在执行时会自动切换至指定类型的io线程。

@IOThread(ThreadType.Single)
private String doInIOThread(View v) {
    return "io线程名:" + Thread.currentThread().getName();
}

2.5、日志打印切片使用

1.使用 @DebugLog标注需要打印的方法和类。可设置打印的优先级，不设置的话默认优先级为0。注意：如果打印的优先级比 XAOP.setPriority设置的优先级小的话，将不会进行打印。

2.使用 @DebugLog标注的类和方法在执行的过程中，方法名、参数、执行的时间以及结果都将会被打印。

3.可调用 XAOP.setISerializer设置打印时序列化参数对象的序列化器。

4.可调用 XAOP.setLogger设置打印的实现接口。默认提供的是突破4000限制的logcat日志打印。

@DebugLog(priority = Log.ERROR)
private String hello(String name, String cardId) {
    return "hello, " + name + "! Your CardId is " + cardId + ".";
}

2.6、内存缓存切片使用

1.使用 @MemoryCache标注需要内存缓存的方法。可设置缓存的key，不设置的话默认key为 方法名＋参数1+参数2+...。

2.标注的方法一定要有返回值，否则内存缓存切片将不起作用。

3.使用 @MemoryCache标注的方法，可自动实现缓存策略。默认使用的内存缓存是 LruCache。

4.可调用 XAOP.initMemoryCache设置内存缓存的最大数量。默认是 Runtime.getRuntime().maxMemory()/1024)/8

@MemoryCache
private String hello(String name, String cardId) {
    return "hello, " + name + "! Your CardId is " + cardId + ".";
}

2.7、磁盘缓存切片使用

1.使用 @DiskCache标注需要磁盘缓存的方法。可设置缓存的key，不设置的话默认key为 方法名＋参数1+参数2+...。

2.可设置磁盘缓存的有效期，单位:s。不设置的话默认永久有效。

3.标注的方法一定要有返回值，否则磁盘缓存切片将不起作用。

4.使用 @DiskCache标注的方法，可自动实现缓存策略。默认使用的磁盘缓存是JakeWharton的 DiskLruCache。

5.可调用 XAOP.initDiskCache设置磁盘缓存的属性,包括磁盘序列化器 IDiskConverter，磁盘缓存的根目录，磁盘缓存的最大空间等。

@DiskCache
private String hello(String name, String cardId) {
    return "hello, " + name + "! Your CardId is " + cardId + ".";
}

2.8、自动捕获异常切片使用

1.使用 @Safe标注需要进行异常捕获的方法。可设置一个异常捕获的标志Flag，默认的Flag为当前 类名.方法名。

2.调用 XAOP.setIThrowableHandler设置捕获异常的自定义处理者，可实现对异常的弥补处理。如果不设置的话，将只打印异常的堆栈信息。

3.使用 @Safe标注的方法,可自动进行异常捕获，并统一进行异常处理，保证方法平稳执行。

@Safe(TRY_CATCH_KEY)
private int getNumber() {
    return 100 / 0;
}

2.9、自定义拦截切片使用

1.使用 @Intercept标注需要进行拦截的方法和类。可设置申请一个或多个拦截类型。

2.如果不调用 XAOP.setInterceptor设置切片拦截的拦截器的话，自定义拦截切片将不起作用。

3.使用 @Intercept标注的类和方法，在执行时将自动调用 XAOP设置的拦截器进行拦截处理。如果拦截器处理返回true的话，该类或方法的执行将被拦截，不执行。

4.使用 @Intercept可以灵活地进行切片拦截。比如用户登录权限等。

@SingleClick(5000)
@DebugLog(priority = Log.ERROR)
@Intercept(3)
public void handleOnClick(View v) {
    XLogger.e("点击响应！");
    ToastUtil.get().toast("点击响应！");
    hello("xuexiangjys", "666666");
}

@DebugLog(priority = Log.ERROR)
@Intercept({1,2,3})
private String hello(String name, String cardId) {
    return "hello, " + name + "! Your CardId is " + cardId + ".";
}

【注意】：当有多个切片注解修饰时，一般是从上至下依次顺序执行。

3、混淆配置

-keep @com.xuexiang.xaop.annotation.* class * {*;}
-keep class * {
    @com.xuexiang.xaop.annotation.* <fields>;
}
-keepclassmembers class * {
    @com.xuexiang.xaop.annotation.* <methods>;
}

本文参与腾讯云自媒体同步曝光计划，分享自微信公众号。

原始发表：2019-01-05，如有侵权请联系 cloudcommunity@tencent.com 删除

aop