基于APT的RxBus库使用

介绍使用java APT封装基于RxJava2和RxAndroid的RxBus库

在上篇文章我写了一下基于RxJava2的RxBus简单封装,没看过的同学可以简单看下，我们可以看到对外暴露的注册和解绑接口，用户还需要在调用注册方法后，手动管理RxJava2的Disposable或者CompositeDisposable对象，还是不是太方便开发者使用。那怎么改进呢？这里我借鉴EventBus这个开源库的一些思想，通过Java Annotation Processing Tool (apt)生成辅助代码来帮助用户通过简单的api就能实现消息总线的功能

Github

本项目已经放到Github上，欢迎兴趣的同学fork查看示例和源码，同时也欢迎star

目的

旨在App中使用Rxjava2的同学们可以方便通过这个库，来使用类似于EventBus消息总线的功能，这样就不用额外的引入EventBus，增加App的库臃肿

引入

在你的Android Studio中module的build.gradle文件中引入

dependencies {
    annotationProcessor 'com.eggsy:rxbus-processor:0.0.4'
    compile 'com.eggsy:rxbus:0.0.4'
    // RxJava and RxAndroid is necessary
    compile 'io.reactivex.rxjava2:rxandroid:2.0.1'
    compile 'io.reactivex.rxjava2:rxjava:2.0.4'
}

需要引入rxjava2和rxandroid，如果你的App中没有用到rxjava，那么不建议你使用RxBus库，因为RxBus是基于rxjava2和rxandroid，如果单纯为了使用RxBus额外引入这两个库，我个人觉得是没必要的，完全可以使用EventBus替换

如何使用

使用主要分为

注册
注解事件方法
发出事件
解绑

注册

在Activity，Fragment或者其他任何你的类中(比如Mvp模式中的Presenter
类)，都可以用来注册RxBus事件

RxBus.register(this); // 这里的this是指包含了下面注解事件方法的类实例

注解事件方法

@EventSubscribe
public void testboolean(boolean testParam) {  // boolean事件
    Toast.makeText(this, testParam, Toast.LENGTH_SHORT).show();
}

// tmode, 指定下面方法接收到事件之后，在哪个线程上运行
@EventSubscribe(tmode = ThreadMode.NewThread)
public void test(String testParam) {  // String类型事件
    Log.i(TAG,"test IoThread, main thread id="+getMainLooper().getThread().getId()+" , result="+testParam);
    Log.i(TAG,"test IoThread, curr thread id="+Thread.currentThread().getId()+" , result="+testParam);
    Toast.makeText(this, testParam, Toast.LENGTH_SHORT).show();
}

@EventSubscribe
public void testCustomEvent(TestEvent event) {  // 自定义事件
    Log.i(TAG, "test custom Event, event=" + event.toString());
}

这里的@EventSubscribe注解有两个属性

tmode：指定事件发出时，注解的方法执行的线程，一共有6种模式
- PostThread 与发出事件(调用RxBus.post()方法)所在线程使用同一个线程
- MainThread 使用App主线程
- IoThread 使用一个自增长的线程池中的线程，适合异步阻塞的IO操作
- NewThread 使用一个新的线程
- SingleThread 使用一个通用的单线程，支持用于主线程到其他线程的管道数据
- ComputationThread 使用一个非主线程来做计算型的工作
bpstrategy：指定上游事件发送很快，次数很多，注解方法来不及处理情况，这里指定一个策略，主要有6种策略
- DEFAULT 如果不设置，默认该属性，不做任何处理
- MISSING 事件在没有任何缓冲或丢弃的情况下写入。注解方法需要处理所有任何溢出
- ERROR 在注解方法处理速度不能跟上事件发出速度时，发出一个Exception
- BUFFER 缓存事件，等到注解方法消费掉这个事件
- DROP 如果注解方法不能跟上事件发送速度，丢弃最近的事件
- LATEST 仅保留最新的事件，如果注解方法处理速度跟不上事件发出速度，则覆盖任何先前的值，保留最新事件。

注意：注解方法限定了参数只能有一个，也就是指定接收一个事件触发

发出事件

RxBus.post("eggsy test");  // 发出String类型的事件
RxBus.post(true);  // 发出boolean事件
RxBus.post(new Boolean(false));  // 发出Boolean类使劲
RxBus.post(newTestEvent(1,"post event object"));  // 当然，还可以发出自定义的对象事件

这里我支持发送的事件类型有两种，一种是java 8种基础类型以及包装类，另外一种自定义类。其中，如果发出的事件类型是基础类型，那么如果注解方法是对应包装类型的事件，也会跟着触发，反之，如果发出的是包装类型的事件，那么注解方法是对应的基础类型，也会跟着触发，比如，发出如下事件

RxBus.post(true);  // 发出boolean事件
RxBus.post(new Boolean(false));  // 发出Boolean类使劲

那么下面方法会被触发两次

@EventSubscribe
public void testboolean(boolean testParam) {  // boolean事件
    Toast.makeText(this, testParam, Toast.LENGTH_SHORT).show();
}

解绑

 RxBus.unRegister(this);

在合适的地方，解绑注册事件，这样就收不到后续发出的事件，比如在Activity的onDestory中解绑，这样就形成了一个完整的生命周期

生成辅助类

在编译时，会生成一个_RxBusProxy后缀的辅助类，例如我例子中，

public class MainActivity_RxBusProxy implements RxBusProxy<MainActivity> {
    protected CompositeDisposable compositeDisposable;

    protected MainActivity sourceInstance;

    public CompositeDisposable register(MainActivity source) {
        sourceInstance = source;
        Disposable test4_disposable = RxBusHelper.getDefault().register(String.class, new Consumer<String>() {
            @Override
            public void accept(String o) throws Exception {
                sourceInstance.test4(o);
            }
        }, io.reactivex.schedulers.Schedulers.computation());
        if (compositeDisposable == null || compositeDisposable.isDisposed()) {
            compositeDisposable = new CompositeDisposable();
        }
        compositeDisposable.add(test4_disposable);
        return compositeDisposable;
    }

    public void unRegister() {
        if (compositeDisposable != null && !compositeDisposable.isDisposed()) {
            compositeDisposable.dispose();
        }
    }
}

栗子

具体栗子请参考我的github上的工程RxBus，欢迎大家fork下来玩玩。

总结

RxBus最基本的还是基于RxJava2和RxAndroid，利用Rxjava2中的支持事件在不同线程之间传递，封装出的一个类似于EventBus功能的库，底层还是调用了我上一篇文章中的RxBus类，把事件与Rxjava2结合起来。然后利用Java APT，识别出@EventSubscribe注解和注解内容，动态的根据注解内容，生成注解方法所在类的一个辅助类，在辅助类里面做了register和unregister方法，实现注册和解绑功能。对外封装了api方便调用者根据传入的类类型，找到对应的辅助类，调用register方法。

最后，谢谢大家查看这篇文章，写的不好的或者有问题的，欢迎大家留言交流～～～