制作简单的RxBus实现事件总线

自从接触了Rxjava之后就一直在使用Rxjava的方式来修改以前写过的一些代码,前段时间实现了Retrofit2+Rxjava的方式来请求数据感觉还不错,那么既然使用了这种方式来获取数据,自然也可以使用rx的方式来对数据进行处理。

之前我们可能使用callback、handler、Otto、EventBus...的方式处理数据,现在我们就来看下怎样自己制作简单的rxbus实现对数据的处理。

备注:rxjava已经升级为2.0下面是升级为2.0的RxBus传送门
http://www.jianshu.com/p/b22e6b10c6cf

1 使用方式

1.1 注册与取消注册

在合适的地方进行注册和取消注册
RxBus.getInstance().register(this);
RxBus.getInstance().unRegister(this);

@Override
protected void onCreate(@Nullable Bundle savedInstanceState) {    
 super.onCreate(savedInstanceState);   
 RxBus.getInstance().register(this);
}

@Override
protected void onDestroy() {    
  super.onDestroy();    
  RxBus.getInstance().unRegister(this);
}

1.2 发布事件与订阅事件

//发布
RxBus.getInstance().post(0, s.getBookses());

//订阅
@Subscribe(tag = 0, thread = EventThread.MAIN_THREAD)
private void dataBinding(ArrayList<TravelNoteBook.Books> bookses) {    
...//处理逻辑
}

当数据被发布之后,如果有订阅者订阅,就会获取到发布过的数据。这也是一个最简单的rxbus,那么我们就来看一下rxbus背后的处理,后面的内容最好对rxjava和lambda方面的知识有一些了解。

2 实现最简单的rxbus

对于上面用注解方式来订阅事件的方式,我们先用最简单的方式实现,然后把注解方式推导出来

2.1 发布与订阅

首先我们要有一个Subject 来处理发布和订阅事件
private final Subject bus;

/**
 * PublishSubject 创建一个可以在订阅之后把数据传输给订阅者Subject
 * SerializedSubject 序列化Subject为线程安全的Subject
 */
public RxBus() {
    bus = new SerializedSubject<>(PublishSubject.create());
}
然后我们来发布
public void post(int code, Object obj) {
    bus.onNext(obj);
}
最后订阅
public <T> Observable tObservable(final Class<T> eventType) {
    return bus.ofType(eventType.getClass());//判断接收事件类型
}
使用
APIServiceManager.getInstance()
        .getTravelNotesAPI()
        //Retrofit发送请求并返回数据
        .getTravelNotesList(query, page + "")
        //生命周期处理
        .compose(bindToLifecycle())
        //img01
        .compose(RxSchedulersHelper.io_main())
        .subscribe(s -> {
                    //发布
                    RxBus.getInstance().post(s.getBookses());
                });
//订阅
Subscription subscription=RxBus.getInstance().tObservable(POJO.class)
        .subscribe(s -> {//事件处理});
//取消订阅
subscription.unsubscribe();
img01

现在最原始的rxbus就成功了,现在可以进行简单的事件的发布与订阅,虽然可以进行发布于订阅,但是在项目中还没有办法满足我们的需求,那么下面我们就需要对现在的这种方式进行优化。

2.2 rxbus优化

先看一下优化后rxbus包的内容


Paste_Image.png

Subscribe //订阅注解
EventTag //事件标示
EventThread //事件线程
Msg //发布事件时默认封装pojo
RxBus //rxbus主要处理

一共五个类主要的就是rxbus,那我们就先看一下rxbus中到底做了哪些处理

2.2.1 注册
然后需要一个map空间存放订阅者方便取消注册
//存放订阅者信息
private Map<Object, List<Subscription>> subscriptions = new HashMap<>();
现在来处理注册事件

下面代码核心思想是,获取Object 中被Subscribe注解的方法并通过反射的方式,在数据被发布后通过invoke调用方法,并在订阅后把订阅者加入map空间方便解除注册。

public void register(Object subscriber) {
  Observable.just(subscriber)
  //判断订阅者不为空            
  .filter(s -> s != null)
  .map(s -> s.getClass())            
  //获取订阅者方法并且用Observable装载            
  .flatMap(s -> Observable.from(s.getDeclaredMethods()))
  //方法必须被Subscribe注解            
  .filter(m -> m.isAnnotationPresent(Subscribe.class))
  //使非public方法可以被invoke            
  .doOnNext(m -> m.setAccessible(true))
  .subscribe(m -> {                
    addSubscription(m,subscriber);            
  });
}

private void addSubscription(Method m,Object subscriber){
//获取方法内参数    
Class[] parameterType = m.getParameterTypes();    
//只获取第一个方法参数,否则默认为Object    
Class cla = Object.class;    
if (parameterType.length > 1) {
    cla = parameterType[0];
}
//获取注解
Subscribe sub = m.getAnnotation(Subscribe.class);    
//订阅事件    
Subscription subscription = tObservable(sub.tag(), cla)
.observeOn(EventThread.getScheduler(sub.thread()))            
.subscribe(o -> {                        
  try {                            
    m.invoke(subscriber, o);                        
  } catch (IllegalAccessException e) {  
    e.printStackTrace();                        
  } catch (InvocationTargetException e) {  
    e.printStackTrace();                       
  }                    
}, e -> System.out.println("this object is not invoke"));  
  putSubscriptionsData(subscriber,subscription);
}

/**
 * 添加订阅者到map空间来unRegister
 * @param subscriber 订阅者
 * @param subscription 订阅者 Subscription
 */
private void putSubscriptionsData(Object subscriber,Subscription subscription){
    List<Subscription> subs = subscriptions.get(subscriber);
    if (subs == null) {
        subs = new ArrayList<>();
    }
    subs.add(subscription);
    subscriptions.put(subscriber, subs);
}

代码中我们调用过这么一个方法:tObservable(sub.tag(), cla)
这个就是刚才的tObservable方法,然后增加了一个int类型的参数用于标示在同一个Object下使用不同的事件处理方法

/**
 * 订阅事件
 * @return
 */
public <T> Observable tObservable(int code, final Class<T> eventType) {
    return bus.ofType(Msg.class)//判断接收事件类型
            .filter(new Func1<Msg, Boolean>() {
                @Override
                public Boolean call(Msg o) {
                    //过滤code相同的事件
                    return o.code == code;
                }
            })
            .map(new Func1<Msg, Object>() {
                @Override
                public Object call(Msg o) {
                    return o.object;
                }
            })
            .cast(eventType);
}

对于post也相应的增加了int参数,通过对code的判断bus会返回eventType类型的Observable数据,并传入备注解的相应方法中。这样就完成了整个事件的注册过程

2.2.2 发布数据

把数据包装以下并发送

public void post(int code, Object obj) {
    bus.onNext(new Msg(code, obj));
}
2.2.3 取消注册
public void unRegister(Object subscriber) {
    if (subscriber == null) {
        return;
    }
    List<Subscription> subs = subscriptions.get(subscriber);
    if (subs != null) {
        for (Subscription sub : subs) {
            if (sub != null)
                sub.unsubscribe();
        }
        subscriptions.remove(subscriber);
    }
}

取消注册主要就是判断map中相同的subscriber,然后调用unsubscribe()取消事件订阅并删除相应的map数据,保证订阅事件与activity生命周期相同防止内存溢出。

使用
APIServiceManager.getInstance()
        .getTravelNotesAPI()
        .getTravelNotesList(query, page + "")
        .compose(bindToLifecycle())
        .compose(RxSchedulersHelper.io_main())
        //对返回数据的优先处理,如果数据有异常则会执行error
        .compose(SchedulersHelper.handleResult())
        .subscribe(s -> {
                    //发布
                    RxBus.getInstance().post(0, s.getBookses());
                },
                e -> {
                    //发布(error)
                    RxBus.getInstance().post(RxBus.TAG_ERROR, e.getMessage());
                });

@Subscribe(tag = 0, thread = EventThread.MAIN_THREAD)
private void dataBinding(ArrayList<TravelNoteBook.Books> bookses) {
    //事件处理
}
@Subscribe(tag =RxBus.TAG_ERROR)
private void dataError(String error) {
    ToastUtil.getInstance().makeShortToast(this, error);
}

3 总结

现在优化过后最简单的rxbus事件总线就已经实现,可以对数据进行发布和订阅处理,相关的代码和demo可以访问我的git:
https://github.com/hackerlc/GearApplication
或者在gradle中直接引用:

compile 'com.joker.gear:com-joker-gear:1.4.1'

当然因为现在rxbus是最简单的版本,不论是代码还是实现方式还有很多不足的地方,在实际项目中也会遇到更多的问题,这里只提供了只用rxbus的实现思路,随着rxbus的不断完善相信后面会有更加健壮的代码呈现出来。

4 相关引用

在实现rxbus上看了很多的文章和git,也非常感谢这些作者的分享,当然如果在文章引用过程中有什么问题,请联系我我会作出修改,以下是相关的引用连接。
http://www.open-open.com/lib/view/open1444011371541.html
http://www.jianshu.com/p/ca090f6e2fe2
https://github.com/AndroidKnife/RxBus
https://github.com/1030310877/JoeRxBus
https://github.com/ch331917692/RxBus
http://www.jianshu.com/p/f3f0eccbcd6f

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 213,099评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,828评论 3 387
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,540评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,848评论 1 285
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,971评论 6 385
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,132评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,193评论 3 412
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,934评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,376评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,687评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,846评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,537评论 4 335
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,175评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,887评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,134评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,674评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,741评论 2 351

推荐阅读更多精彩内容