EventBus简单分析 -- 《源码系列》

2020年06月11日 21:53 · 阅读 632

前言

EventBus在Android算是比较常用的三方库了，EventBus可以代替Android传统的Intent,Handler,Broadcast或接口函数,在Fragment,Activity,Service线程之间传递数据和执行方法。

使用方法

基本使用：

定义事件

public class MessageEvent {
    public final String message;
    public MessageEvent(String message) {
        this.message = message;
    }
}
复制代码

注册和事件处理

//注册
@Override
public void onStart() {
    super.onStart();
    EventBus.getDefault().register(this);
}

@Override
public void onStop() {
    EventBus.getDefault().unregister(this);
    super.onStop();
}


//事件处理1 
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(MessageEvent event) {
    Toast.makeText(getActivity(), event.message, Toast.LENGTH_SHORT).show();
}

//事件处理2
@Subscribe
public void handleSomethingElse(SomeOtherEvent event) {
    doSomethingWith(event);
}

复制代码

发送事件

EventBus.getDefault().post(new MessageEvent("测试"));
复制代码

基本流程

线程模式ThreadMode

ThreadMode.POSTING:默认的模式,开销最小的模式,因为声明为POSTING的订阅者会在发布的同一个线程调用，发布者在主线程那么订阅者也就在主线程,反之亦,避免了线程切换,如果不确定是否有耗时操作，谨慎使用，因为可能是在主线程发布
ThreadMode.MAIN:主线程调用，视发布线程不同处理不同,如果发布者在主线程那么直接调用(非阻塞式),如果发布者不在主线程那么阻塞式调用
ThreadMode.MAIN_ORDERED:和MAIN差不多,主线程调用，和MAIN不同的是他保证了post是非阻塞式的(默认走MAIN的非主线程的逻辑，所以可以做到非阻塞)
ThreadMode.BACKGROUND:在子线程调用,如果发布在子线程那么直接在发布线程调用,如果发布在主线程那么将开启一个子线程来调用,这个子线程是阻塞式的,按顺序交付所有事件,所以也不适合做耗时任务,因为多个事件共用这一个后台线程
ThreadMode.ASYNC: 在子线程调用,总是开启一个新的线程来调用,适用于做耗时任务,比如数据库操作,网络请求等，不适合做计算任务,会导致开启大量线程

简单的来说：

POSTING：由发布的线程来执行，没有切换。
MAIN：由主线程来执行
MAIN_ORDERED：由主线程来执行，但是会保证时间的有序。
BACKGROUND：如果在非主线程发布的话，就直接执行，否则，使用单个后台线程并且有序的执行。
ASYNC：在单独的线程执行。

配置

EventBus eventBus = EventBus.builder()
    //当事件没有订阅者订阅时是否打印日志，默认为true。
    .logNoSubscriberMessages(false)
    //当事件没有订阅者订阅时是否发送NoSubscriberEvent，默认为true。
    //当为true时，订阅者可以订阅NoSubscriberEvent事件。
    .sendNoSubscriberEvent(false)
    .build();
复制代码

粘性事件

// 1. 订阅
@Subscribe(sticky = true, threadMode = ThreadMode.MAIN)
public void onEvent(MessageEvent event) {   
    textField.setText(event.message);
}
// 2. 发布
EventBus.getDefault().postSticky(new MessageEvent("Hello everyone!"));
// 3. 获取粘性事件
MessageEvent stickyEvent = EventBus.getDefault().getStickyEvent(MessageEvent.class);
if(stickyEvent != null) {
    // 4. 移除粘性事件
    EventBus.getDefault().removeStickyEvent(stickyEvent);
    // do something.
}
// 5. 移除粘性事件
MessageEvent stickyEvent = EventBus.getDefault().removeStickyEvent(MessageEvent.class);
if(stickyEvent != null) {
    // do something.
}
复制代码

优先级和事件取消

优先级

@Subscribe(priority = 1);
public void onEvent(MessageEvent event) {
    ...
}
复制代码

在同一个传递线程（ThreadMode）中，优先级较高的订阅服务器将比优先级较低的其他订阅服务器接收事件。默认优先级为0。注意： 优先级不影响不同线程模式的订阅服务器之间的传递顺序！

事件取消

可以通过从订阅者的事件处理方法中调用cancelEventDelivery（对象事件）来取消事件传递过程。任何进一步的事件传递都将被取消，后续订阅者将不会收到该事件。

@Subscribe
public void onEvent(MessageEvent event){
    // 处理事件
    ...
    // 阻止传递给其他订阅服务器
    EventBus.getDefault().cancelEventDelivery(event) ;
}
复制代码

用户索引

使用订阅者索引可以避免在运行时使用反射查找订阅者方法。相反，EventBus注释处理器可以在构建时查找它们。

生成索引

如果用的是kotlin

apply plugin: 'kotlin-kapt' // ensure kapt plugin is applied

dependencies {
    def eventbus_version = '3.2.0'
    implementation "org.greenrobot:eventbus:$eventbus_version"
    kapt "org.greenrobot:eventbus-annotation-processor:$eventbus_version"
}

kapt {
    arguments {
        arg('eventBusIndex', 'com.example.myapp.MyEventBusIndex')
    }
}
复制代码

使用索引

//方式1
EventBus eventBus = EventBus.builder().addIndex(new MyEventBusIndex()).build();
//方式2
EventBus.builder().addIndex(new MyEventBusIndex()).installDefaultEventBus();
EventBus eventBus = EventBus.getDefault();
//方式3
EventBus eventBus = EventBus.builder()
    .addIndex(new MyEventBusAppIndex())
    .addIndex(new MyEventBusLibIndex()).build();
复制代码

源码分析

@Subscribe采用运行时注解,且注解只能用在函数上,默认的threadmode为posting

register

通过getDefault获取EventBus实例，这是一条默认的事件总线,通过单例模式实现,其构造函数是Public的也可以通过new的形式来创建多条事件总线
从缓存中获取订阅方法列表,如果缓存中不存在则通过反射获取到订阅者所有的函数,遍历再通过权限修饰符.参数长度(只允许一个参数).注解(@Subscribe)来判断是否是具备成为订阅函数的前提,具备则构建一个SubscriberMethod(订阅方法，其相当于一个数据实体类,包含方法,threadmode,参数类型,优先级,是否粘性事件这些参数),循环结束订阅函数列表构建完成添加进入缓存.
对subscriptionsByEventType.typesBySubscriber完成数据初始化,subscriptionsByEventType根据参数类型存储订阅者和订阅方法,typesBySubscriber根据订阅者存储了所有的参数类型，subscriptionsByEventType主要是post时使用,因为其存储了订阅者和订阅事件这两个参数在反射时要用到,typesBySubscriber在反注册时可以根据订阅者获取到存储的事件类型就可以从subscriptionsByEventType中获取到对应的订阅者和订阅方法释放资源,还可以用来判断是否注册,这些最后会分析到.