11月
08

EventBus事件总线

发表于 • 字数统计:

EventBus是Guava的事件处理机制，是设计模式中的观察者模式（生产/消费者编程模型）实现的
EventBus类是guava中关注消息的发布和订阅的类，简单的说订阅者通过EventBus注册并订阅事件，发布者将事件发送到EventBus中，EventBus将事件顺序的通知给时间订阅者

EventBus概述

EventBus的三要素
  • Event：事件，可以是任意类型的对象。
  • Subscriber：事件订阅者，在EventBus3.0之前消息处理的方法只能限定于onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，他们分别代表四种线程模型。而在EventBus3.0之后，事件处理的方法可以随便取名，但是需要添加一个注解@Subscribe，并且要指定线程模型（默认为POSTING），四种线程模型下面会讲到。
  • Publisher：事件发布者，可以在任意线程任意位置发送事件，直接调用EventBus的post(Object)方法。可以自己实例化EventBus对象，但一般使用EventBus.getDefault()就好了，根据post函数参数的类型，会自动调用订阅相应类型事件的函数。
EventBus的四种ThreadMode（线程模型）

EventBus3.0有以下四种ThreadMode：

  • POSTING（默认）：如果使用事件处理函数指定了线程模型为POSTING，那么该事件在哪个线程发布出来的，事件处理函数就会在这个线程中运行，也就是说发布事件和接收事件在同一个线程。在线程模型为POSTING的事件处理函数中尽量避免执行耗时操作，因为它会阻塞事件的传递，甚至有可能会引起ANR。
  • MAIN:
    事件的处理会在UI线程中执行。事件处理时间不能太长，长了会ANR的。
  • BACKGROUND：如果事件是在UI线程中发布出来的，那么该事件处理函数就会在新的线程中运行，如果事件本来就是子线程中发布出来的，那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。
  • ASYNC：无论事件在哪个线程发布，该事件处理函数都会在新建的子线程中执行，同样，此事件处理函数中禁止进行UI更新操作。

创建EventBus实例

创建一个EventBus实例，只需要简单的调用构造方法:

1
EventBus eventBus = new EventBus();

也提供了一个带参数的构造类,目的只是为了加上一个标识:

1
EventBus eventBus = new EventBus(TradeAccountEvent.class.getName());

基本用法

1.自定义一个事件类：

1
2
3
public class MessageEvent {
    ...
}

2.注册事件：
EventBus.register(Object)方法，请保证事件生产者和监听者共享相同的EventBus实例。
或静态方法EventBus.getDefault().register(this);(3.0支持)

3.订阅事件：
这个类需要定义一个只接受一个参数的public方法，参数的类型要和订阅的事件类型一致。
需要在方法上加上@Subscribe注解 

1
2
3
4
@Subscribe(threadMode = ThreadMode.MAIN)
public void XXX(MessageEvent messageEvent) {
    ...
}

threadMode不指定默认为POSTING

4.发送事件：
EventBus.post(Object)方法。异步分发可以直接用EventBus的子类AsyncEventBus
或静态方法EventBus.getDefault().post(messageEvent);(3.0支持)

5.取消注册：
EventBus.unregister(Object)方法
或静态方法EventBus.getDefault().unregister(this);(3.0支持)

例子

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
class EventBusObject{
    EventBus eventBus = new EventBus();
    //注册
    eventBus.register(this);
    public void changeCustomer() {
        Object event = new Object();
        //发布事件
        eventBus.post(event);
    }
    //取消注册
    eventBus.unregister(this);

    //订阅事件
    @Subscribe
    public void listen(Object e) {
        
    }
}
分享到：