Android中使用EventBus事件发布/订阅框架实现事件传递

旧城等待， 2023-10-05 17:33 16阅读 0赞

## 场景 ##

### EventBus ###

EventBus是一种用于Android的事件发布-订阅总线。它简化了应用程序内各个组件之间进行通信的复杂度，尤其是碎片之间进行通信的问题，可以避免由于使用广播通信而带来的诸多不便。

### 官方文档 ###

[https://greenrobot.org/eventbus/documentation/][https_greenrobot.org_eventbus_documentation]

### 使用场景 ###

在做项目的时候往往需要应用程序内各组件间、组件与后台线程间的通信。比如耗时操作，等耗时操作完成后通过Handler或Broadcast将结果通知给UI，N个Activity之间需要通过Listener通信，又比如本文将要介绍的在接收到MQTT推送的回调方法中将消息显示在系统通知栏中，这些都可以通过EventBus轻松实现，EventBus通过发布/订阅(publish/subscribe)方式来管理事件总线。

### 三个角色 ###

Event：事件，它可以是任意类型，EventBus会根据事件类型进行全局的通知。  
Subscriber：事件订阅者，在EventBus 3.0之前我们必须定义以onEvent开头的那几个方法，分别是onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync，而在3.0之后事件处理的方法名可以随意取，不过需要加上注解@subscribe，并且指定线程模型，默认是POSTING。  
Publisher：事件的发布者，可以在任意线程里发布事件。一般情况下，使用EventBus.getDefault()就可以得到一个EventBus对象，然后再调用post(Object)方法即可。

### 四种线程模型 ###

POSTING：默认，表示事件处理函数的线程跟发布事件的线程在同一个线程。  
MAIN：表示事件处理函数的线程在主线程(UI)线程，因此在这里不能进行耗时操作。  
BACKGROUND：表示事件处理函数的线程在后台线程，因此不能进行UI操作。如果发布事件的线程是主线程(UI线程)，那么事件处理函数将会开启一个后台线程，如果果发布事件的线程是在后台线程，那么事件处理函数就使用该线程。  
ASYNC：表示无论事件发布的线程是哪一个，事件处理函数始终会新建一个子线程运行，同样不能进行UI操作。

注：

博客：  
[https://blog.csdn.net/badao\_liumang\_qizhi][https_blog.csdn.net_badao_liumang_qizhi]  
关注公众号  
霸道的程序猿  
获取编程相关电子书、教程推送与免费下载。

## 实现 ##

官网给出的快速开始的文档

[https://greenrobot.org/eventbus/documentation/how-to-get-started/][https_greenrobot.org_eventbus_documentation_how-to-get-started]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70][]

这里我们以接收到MQTT服务器发的消息后的回调方法中去传递给主线程去在通知栏显示通知消息为例

这里还使用了EventBus的StickyEvents黏性事件

### StickyEvents黏性事件 ###

何为黏性事件呢？简单讲，就是在发送事件之后再订阅该事件也能收到该事件，跟黏性广播类似。

官方文档：

[https://greenrobot.org/eventbus/documentation/configuration/sticky-events/][https_greenrobot.org_eventbus_documentation_configuration_sticky-events]

直译：

有些事件在事件发布后会携带一些感兴趣的信息。例如，事件表示某个初始化已经完成。或者你有一些传感器或位置数据你想保持最近的值。您可以使用粘滞事件，而不是实现自己的缓存。EventBus将特定类型的最后一个sticky事件保存在内存中。然后，可以将sticky事件交付给订阅者或显式查询。因此，您不需要任何特殊的逻辑来考虑已经可用的数据。

### 使用EventBus ###

在build.gradle中引入依赖

//Event bus用来传递消息
        implementation 'org.greenrobot:eventbus:3.0.0'

然后按照官方文档快速开始的说明，新建一个消息事件实体MessageEvent

public class MessageEvent {
        private String message;
    
        public MessageEvent(String message) {
            this.message = message;
        }
    
        public String getMessage() {
            return message;
        }
    
        public void setMessage(String message) {
            this.message = message;
        }
    }

然后在需要订阅事件的地方进行注册事件并进行事件的处理，这里是要在MainActivity中进行通知栏显示消息，所以在MainActivity的onCreate方法中

//在需要订阅事件的地方注册事件
            EventBus.getDefault().register(this);

然后还需要在MainActivity中进行事件的处理

//处理事件
        @Subscribe(threadMode = ThreadMode.MAIN, sticky = true)
        public void showTheEventMessage(MessageEvent messageEvent) {
            Log.i(TAG, "showTheEventMessage: show notification");
            showNotification(this, messageEvent.getMessage());
        }

即进行显示通知栏消息的操作。

然后在收到MQTT消息的回调方法中

EventBus.getDefault().postSticky(new MessageEvent(msg));

进行发布消息，其中msg是传递的消息的字符串内容

上面完整实现流程

Android中连接MQTT服务器实现订阅主题并接收消息推送在通知栏显示(附代码下载)：

[https://blog.csdn.net/BADAO\_LIUMANG\_QIZHI/article/details/112466469][https_blog.csdn.net_BADAO_LIUMANG_QIZHI_article_details_112466469]

[https_greenrobot.org_eventbus_documentation]: https://greenrobot.org/eventbus/documentation/
[https_blog.csdn.net_badao_liumang_qizhi]: https://blog.csdn.net/badao_liumang_qizhi
[https_greenrobot.org_eventbus_documentation_how-to-get-started]: https://greenrobot.org/eventbus/documentation/how-to-get-started/
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20210111164506700.jpg?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L0JBREFPX0xJVU1BTkdfUUlaSEk=,size_16,color_FFFFFF,t_70
[https_greenrobot.org_eventbus_documentation_configuration_sticky-events]: https://greenrobot.org/eventbus/documentation/configuration/sticky-events/
[https_blog.csdn.net_BADAO_LIUMANG_QIZHI_article_details_112466469]: https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/112466469