Google Guava EventBus(事件总线)

Posted 2022-04-16 tuacy

       EventBus是Guava的事件处理机制，是设计模式中的观察者模式（生产/消费者编程模型）的优雅实现。对于事件监听和发布订阅模式，EventBus非常优雅使用起来也非常的简单,这个可不是吹的是真的非常的简单。

       EventBus内部实现原理不复杂(源码不复杂，强烈推荐大家去看下)。我们简单的概况下EventBus内部的实现：EventBus内部会维护一个Multimap<Class<?>, Subscriber> map(你可以认为是一个消息队列样的东西)，key就代表消息对应的类(消息不同类不同，区分不同的消息)、value是一个Subscriber，Subscriber其实就是对对应消息处理的一个封装。如果有消息发布就去这个map里面找到这个消息对应的处理方法在执行。

       EventBus里面的相关术语。

EventBus术语	解释	备注
事件(消息)	可以向事件总线发布的对象	通常是一个类，不同的消息事件用不同的类来代替，消息内容就是类里面的属性
订阅	向事件总线注册监听者以接受事件的行为	EventBus.register(Object)，参数就是监听者
监听者	提供一个处理方法，希望接受和处理事件的对象	通常也是一个类，里面有消息的处理方法
处理方法	监听者提供的公共方法，事件总线使用该方法向监听者发送事件；该方法应该用Subscribe注解	监听者里面添加了Subscribe注解的方法，就可以认为是消息的处理方法
发布消息	通过事件总线向所有匹配的监听者提供事件	EventBus.post(Object)

一 EventBus的使用

       EventBus的使用很简单。笼统来说分为以下几个步骤。不过在说EventBus使用之前，先把EventBus里面常用的函数列出来。

    /**
     * 创建EventBus对象, identifier为“default”
     */
    public EventBus() 
        this("default");
    

    /**
     * 创建EventBus对象, identifier就是用一个字符串来标识EventBus
     */
    public EventBus(String identifier);

    /**
     * 创建EventBus对象，exceptionHandler是异常处理类(消息处理过程中有异常，统一处理)
     * ps: identifier为“default”
     */
    public EventBus(SubscriberExceptionHandler exceptionHandler);
    

    /**
     * EventBus对象标识
     */
    public final String identifier();
    

    /**
     * 取消监听者的注册
     */
    public void unregister(Object object);

    /**
     * 发布一个消息
     *
     * @param event 可以认为是消息
     */
    public void post(Object event);

EventBus简单吧，给我们用的函数都没几个。

1.1 EventBus对象创建

       EventBus对象需要根据实际情况来创建，你想全局只用一个EventBug。你可以用单例。你也可以根据不同的模块，每个模块一个EventBus对象。这些你都可以随意处理。当中缘由也很好理解，EventBus是中央处理器。你的监听者在哪个EventBus里面注册，你的消息就发布到这个对应的EventBus里面去。不能乱来。

       EventBus对象创建就没什么说的了。

        EventBus eventBus = new EventBus("test");

1.2 创建消息类

       消息，我们通常会封装成一个类。消息不同类也不同。如果是带参数的消息，这些参数就可以作为类的属性。比如如下一个实例，我们定义一个OrderMessage消息类，来接受某个命令，对应的命令内容orderContent。

/**
 * @name: OrderMessage
 * @author: tuacy.
 * @date: 2019/7/9.
 * @version: 1.0
 * @Description: 命令消息
 */
public class OrderMessage 
    
    /**
     * 命令对应的内容
     */
    private String orderContent;


    public String getOrderContent() 
        return orderContent;
    

    public void setOrderContent(String orderContent) 
        this.orderContent = orderContent;
    

       这里也建议，消息对应的类不用搞的太复杂。最好不要各种继承，各种实现。除非到了万不得已的情况。

1.3 创建监听者类

       监听者也是一个类，不过在这个类里面需要确定我们需要处理哪些消息(可以是多个)，每个消息的处理对应一个函数，而且这个函数需要添加@Subscribe注解。比如我们定义一个OrderEventListener的监听类，处理我们上面的OrderMessage消息，代码如下：

/**
 * @name: OrderMessage
 * @author: tuacy.
 * @date: 2019/7/9.
 * @version: 1.0
 * @Description: 命令监听者
 */
public class OrderEventListener 

    /**
     * 如果发送了OrderMessage消息，会进入到该函数的处理
     * @param event 消息
     */
    @Subscribe
    public void dealWithEvent(OrderMessage event) 
        // TODO: 收到EventTest消息之后，做相应的处理
        System.out.println("我收到了您的命令，命令内容为：" + event.getOrderContent());
    

1.4 注册监听者

       监听者类我们已经创建好了，这个时候我们需要把这个监听者注册到EventBus里面去。让他可以去匹配发布的消息。注册监听者就掉一个函数就行。

        // 注册监听者
        eventBus.register(new OrderEventListener());

1.4 发布消息

       当有对应的消息产生的时候，需要发布出去让监听者处理的时候。很简单。掉个函数就Ok了。

        // 发布消息
        eventBus.post(new OrderMessage());

    @Test
    public void eventBus() 
        // 定义一个EventBus对象，因为我这里是测试，才这样写的。实际你应该定义一个单例获取其他的方式
        EventBus eventBus = new EventBus("test");
        // 注册监听者
        eventBus.register(new OrderEventListener());
        // 发布消息
        eventBus.post(new OrderMessage());

    

二 异步消息处理AsyncEventBus

       AsyncEventBus是继承EventBus异步消息，准确来讲是我们可以指定消息的处理在哪里执行。比如我们可以把他们都放到一个线程池里面去执行。

public class AsyncEventBus extends EventBus 

    /**
     * 创建AsyncEventBus对象
     *
     * @param identifier EventBus标识
     * @param executor 消息在哪里执行，EventBus里面默认的是MoreExecutors.directExecutor()
     */
    public AsyncEventBus(String identifier, Executor executor) 
        super(identifier, executor, Dispatcher.legacyAsync(), LoggingHandler.INSTANCE);
    

    /**
     * 创建AsyncEventBus对象
     *
     * @param executor 消息在哪里执行，EventBus里面默认的是MoreExecutors.directExecutor()
     * @param subscriberExceptionHandler 异常处理
     * @since 16.0
     */
    public AsyncEventBus(Executor executor, SubscriberExceptionHandler subscriberExceptionHandler) 
        super("default", executor, Dispatcher.legacyAsync(), subscriberExceptionHandler);
    

    /**
     * 创建AsyncEventBus对象
     *
     * @param executor 消息在哪里执行，EventBus里面默认的是MoreExecutors.directExecutor()
     */
    public AsyncEventBus(Executor executor) 
        super("default", executor, Dispatcher.legacyAsync(), LoggingHandler.INSTANCE);
    
    

---

       Guava EventBus里面的东西比较简单，所以上面讲的也很简单。有什么疑问欢迎留言。关于Guava EventBus个人觉得要是有以下功能就跟好了，纯属个人观点。

• 要是消息支持优先级就好了。
• 要是可以主动中断消息就好了。比如有多个监听者。有一个处理了我不希望继续往下传递了。
• 要是消息要是能支持存活时间就好了。比如多长时间没有处理。消息失效。