Eventbus初探

2018-11-09  本文已影响5人  魔焰之

本文主要介绍一下EventBus的基础使用和其对应的源码实现,如有问题,麻烦各位指出,谢谢大家。

EventBus简介

EventBus是一个用于解偶消息处理者和发送者的第三方库,常用于一些模块化开发中,多个模块或者页面的消息分发和处理,使用该库后能使代码更加简洁,让开发者能主要关注在业务细节上,而且该jar很小(50k内)

基本使用

在EventBus的github主页上可以看到,其最简单的用法如下:
1.定义一个事件类

public static class MessageEvent { /* Additional fields if needed */ }

2.在需要接收/处理该事件的类(例如类A.java)中使用注解(@Subscribe)标注一个方法用于接收事件

@Subscribe(threadMode = ThreadMode.MAIN)  
public void onMessageEvent(MessageEvent event) {/* Do something */};

3.将类A的对象注册到EventBus对象中:

EventBus.getDefault().register(this);

4.接下来你可以在其他类中发送该消息给A的对象了:

EventBus.getDefault().post(new MessageEvent());

源码实现

上述基本上算一个最简单的EventBus的使用实例,也已经基本包含了EventBus中涉及的角色,下面将整个流程分为两个步骤来详细介绍下源码中的实现:

初始化阶段

初始化阶段主要负责创建EventBus对象和注册事件处理者两步:

  1. 创建EventBus
    默认构造
    上述使默认的构造函数,可以看出其使用了默认的构建器,其中相关的成员变量作用说明如下:
    subscriptionsByEventType:存储订阅关系的HashMap,其中key为事件类型(类似上面的MesageEvent的class),value为Subscription对象的集合,其中Subscription类用于描述订阅关系(哪个对象订阅了什么类型的消息)
    typesBySubscriber: 存储某个订阅者订阅的多个事件的事件类型的HashMap,结合subscriptionsByEventType变量,就可以描述一个事件的多个处理者和一个处理者订阅多个事件类型
    mainThreadPoster:主线程的消息发射器,基本上后缀为Poster的类都是消息的发射器,只是发射的场景不一样(子线程或者后台或者异步等)
    subscriberMethodFinder:负责查找某个订阅者订阅的方法信息
    eventInheritance:是否支持事件继承关系
  2. 注册事件处理者
注册入口

注册的时候,首先通过方法查找器去找到该订阅者所订阅的事件对应的方法实现,之后会创建事件和订阅者之间的联系。


查找订阅者注解方法 在这里插入图片描述

在findSubscriberMethods方法中会先检查缓存是否有该类对应的方法列表,如果没有会调findUsingInfo,该方法返回List<SubscriberMethod>,所以Eventbus是支持一个订阅者订阅多个事件类的事件,其次可以看到其会遍历子类的父类,所以订阅者的子类也是可以收到事件的。接下来看一下它是怎么去查找订阅的方法的,实现在findUsingReflectionInSingleClass中:


查找类中的订阅方法
findUsingReflectionInSingleClass的参数是FindState对象,该类是用来暂时存储订阅者和订阅方法的中间对象,且使用了对象池的方式避免重复创建,一开始findState.clazz就是订阅者(参照基本使用中类A)的class,通过getDeclaredMethod方法获取到该类所有的方法,然后遍历去查找方法修饰符为public,且参数长度等于1的方法,如果没有,则会抛出异常,如果有,则会查找该方法是否有Subscribe注解所标注,如果是,则会进行添加前的检查,检查规则如下:

事件分发

分发入口

上述是默认的事件分发入口函数,PostingThreadState类是分发状态类,使用ThreadLocal保存不同线程间的事件分发状态,这里获取到了当前线程的分发状态对象,将事件加入到其事件队列中,如果状态对象已经在分发,就直接跳过,如果没有分发,则进行分发,具体的分发实现在postSingleEvent函数中


分发单个事件

默认evenInheritance变量是为true,表示允许事件之间的继承或者实现关系(即一个事件如果继承了父事件,那么分发子事件的时候,也会发送父事件),其中lookupAllEventTypes方法就是去找到当前事件的所有类关系,如果当前事件是Object的直接子类,则evenTypes中只含有当前事件的class,之后会调用postSingleEventForEventType去发送单个事件,如果没有找到该事件的接收者,则会有可能去发送一个NoSubscriberEvent事件


发送单个事件
postSingleEventForEvenType方法首先根据事件类型查找到该事件所有的订阅关系描述实体,之后遍历各个实体,按顺序发送事件,如果发送过程中取消消息,则会中断消息发送,具体的发送代码在postToSubscription方法中
发送事件给订阅者
这里主要关注case MAIN中的流程,如果不是在主线程,则调用poster的enqueue方法,这个mainThreadPoster实际是一个主线程的Handler,这里enqueue方法是将订阅关系和事件通过发送消息的方式给了主线程,主线程会调用invokeSubscriber方法;如果是在主线程,则直接调用invokeSubscriber方法
调用订阅者的方法

可以看到这里直接使用的反射来调用订阅者的订阅方法,将事件传递给接收者,这样就将事件的发送者和事件的处理者通过订阅的关系成功解偶。
上述就是EventBus最简单的使用方式所对应的源码流程,如果有问题,请各位斧正,谢谢大家的指导。

上一篇下一篇

猜你喜欢

热点阅读