Android 浅析EventBus (一) 使用

前言

Linus Benedict Torvalds : RTFSC – Read The Fucking Source Code

概括

EventBus is a publish/subscribe event bus optimized for Android.
EventBus 是一个为 Android 优化的 publish/subscribe 事件总线。

简化组件间的通讯。
事件发送者和接收者解耦。
很好地执行活动，片段和背景线程，避免复杂和容易出错的依赖关系和生命周期的问题，使您的代码更简单
快速
小（大约50K）

使用

Step 1: 定义事件

Events are POJO (plain old Java object) without any specific requirements.

public class MessageEvent {
    public final String message;

    public MessageEvent(String message) {
        this.message = message;
    }
}

Step 2: 准备订阅者

订阅者要实现一个接口函数onEvent，用来在收到通知后作出响应。这需要注册到EventBus里。

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

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

// This method will be called when a MessageEvent is posted
public void onEvent(MessageEvent event){}
    
// This method will be called when a SomeOtherEvent is posted public void onEvent(SomeOtherEvent event){}

Step 3: 发送通知

发送通知可以在代码的任意一个地方。

EventBus.getDefault().post(new MessageEvent("Hello everyone!"));

主要类解析

主要类图

EventBus

EventBus is a central publish/subscribe event system for Android. Events are posted (post(Object)) to the bus, which delivers it to subscribers that have a matching handler method for the event type. To receive events, subscribers must register themselves to the bus using register(Object). Once registered, subscribers receive events until unregister(Object) is called. By convention, event handling methods must be named "onEvent", be public, return nothing (void), and have exactly one parameter (the event).
EventBus的介绍本身就很清楚了。它是一个Android的发布/订阅事件系统。

EventBus 类负责所有对外暴露的 API，其中的 register()、post()、unregister() 函数配合上自定义的 EventType 及事件响应函数即可完成核心功能。

EventBus可以通过getDefault来获取单例，也可以自己通过创建或者EventBusBuilder来新建一个，不过EventBus是相互隔离的。huo zh

getDefault()

进程中创建一个EventBus的单例返回。

register(Object subscriber)

注册一个订阅者到接收事件。订阅者必须调用'unregister()'当它们不再接收事件。

订阅者有一个事件句柄方法用他们的名字识别，通常是叫“onEvent”。事件句柄方法必须有一个参数，事件。如果事件句柄方法被调用在一个特殊的线程，一个修改将被用到方法的名字上。有效的修改符合ThreadMode枚举之一。例如，如果一个方法被调用在由EventBus在UI/主线程，这将被称为“onEventMainThread”。

unregister(Object subscriber)

反注册一个订阅者

post(Object event)

发送一个事件到event bus。

四种订阅函数

onEvent:如果使用onEvent作为订阅函数，那么该事件在哪个线程发布出来的，onEvent就会在这个线程中运行，也就是说发布事件和接收事件线程在同一个线程。使用这个方法时，在onEvent方法中不能执行耗时操作，如果执行耗时操作容易导致事件分发延迟。
onEventMainThread:如果使用onEventMainThread作为订阅函数，那么不论事件是在哪个线程中发布出来的，onEventMainThread都会在UI线程中执行，接收事件就会在UI线程中运行，这个在Android中是非常有用的，因为在Android中只能在UI线程中跟新UI，所以在onEvnetMainThread方法中是不能执行耗时操作的。
onEvnetBackground:如果使用onEventBackgrond作为订阅函数，那么如果事件是在UI线程中发布出来的，那么onEventBackground就会在子线程中运行，如果事件本来就是子线程中发布出来的，那么onEventBackground函数直接在该子线程中执行。
onEventAsync：使用这个函数作为订阅函数，那么无论事件在哪个线程发布，都会创建新的子线程在执行onEventAsync.

EventBusBuilder

Creates EventBus instances with custom parameters and also allows to install a custom default EventBus instance.

Builder对应的就是Builder生成器模式。EventBusBuilder用于在需要设置参数过多时构造 EventBus。包含的属性也是 EventBus 的一些设置参数。

build()

生成一个EventBus基于现有的配置。

SubscriberMethod

订阅者事件响应函数信息，包括响应方法、线程 Mode、事件类型以及一个用来比较 SubscriberMethod 是否相等的特征值 methodString 共四个变量

其中 methodString 为 ${methodClassName}#${methodName}(${eventTypeClassName}。

Subscription

订阅者信息，包括 subscriber 对象、事件响应方法 SubscriberMethod、优先级 priority。

HandlerPoster

事件主线程处理，对应ThreadMode.MainThread。继承自 Handler，enqueue 函数将事件放到队列中，并利用 handler 发送 message，handleMessage 函数从队列中取事件，invoke 事件响应函数处理。

AsyncPoster

事件异步线程处理，对应ThreadMode.Async，继承自 Runnable。enqueue 函数将事件放到队列中，并调用线程池执行当前任务，在 run 函数从队列中取事件，invoke 事件响应函数处理。

BackgroundPoster

事件 Background 处理，对应ThreadMode.BackgroundThread，继承自 Runnable。enqueue 函数将事件放到队列中，并调用线程池执行当前任务，在 run 函数从队列中取事件，invoke 事件响应函数处理。

与 AsyncPoster.java 不同的是，BackgroundPoster 中的任务只在同一个线程中依次执行，而不是并发执行。

PendingPost

订阅者和事件信息实体类，并含有同一队列中指向下一个对象的指针。通过缓存存储不用的对象，减少下次创建的性能消耗。

PendingPostQueue

通过 head 和 tail 指针维护一个PendingPost队列。HandlerPoster、AsyncPoster、BackgroundPoster 都包含一个此队列实例，表示各自的订阅者及事件信息队列，在事件到来时进入队列，处理时从队列中取出一个元素进行处理。

NoSubscriberEvent

当没有事件处理函数对事件处理时发送的 EventBus 内部自定义事件，通过 post 发送，订阅者可自行订阅这类事件进行处理。

ThreadMode

线程 Mode 枚举类，表示事件响应函数执行线程信息

包括:
1.ThreadMode.PostThread
2.ThreadMode.MainThread
3.ThreadMode.BackgroundThread
4.ThreadMode.Async

Android 浅析 EventBus (一) 使用