关于EventBus,从使用到解析(上)

本篇文章主要讲解关于EventBus的使用,下篇文章会根据EventBus的使用具体讲解其中的原理。虽然现在RxJava也可以实现EventBus的功能,但原理性的东西都是一样的。

一、EventBus简介

EventBus是一个Android端优化的publish/subscribe消息总线,简化了应用程序内各组件间、组件与后台线程间的通信。

作为一个消息总线主要有三个组成部分:

事件(Event):可以是任意类型的对象。通过事件的发布者将事件进行传递。

事件订阅者(Subscriber):接收特定的事件。

事件发布者(Publisher):用于通知 Subscriber 有事件发生。可以在任意线程任意位置发送事件。

关于EventBus,从使用到解析(上)_第1张图片

上图解释了整个EventBus的大概工作流程:事件的发布者(Publisher)将事件(Event)通过post()方法发送。EventBus内部进行处理,找到订阅了该事件(Event)的事件订阅者(Subscriber)。然后该事件的订阅者(Subscriber)通过onEvent()方法接收事件进行相关处理(关于onEvent()在EventBus 3.0中有改动,下面详细说明)。

二、EventBus的简单使用

1、把EventBus依赖到项目

build.gradle添加引用

 compile 'de.greenrobot:eventbus:3.0.0-beta1'

2、构造事件(Event)对象。也就是发送消息类
每一个消息类,对应一种事件。这里我们定义两个消息发送类。后面讲解具体作用。

public class NewsEvent {
    private String message;

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

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}
public class ToastEvent {
    private String content;

    public ToastEvent(String content) {
        this.content = content;
    }

    public String getContent() {
        return content;
    }

    public void setContent(String content) {
        this.content = content;
    }
}

3、注册/解除事件订阅(Subscriber)

EventBus.getDefault().register(this);//注册事件 其中this代表订阅者

具体注册了对什么事件的订阅,这个需要onEvent()方法来说明。在EventBus 3.0之前,onEvent()方法是用来接收指定事件(Event)类型对象,然后进行相关处理操作。在EventBus 3.0之后,onEvent()方法可以自定义方法名,不过要加入注解@Subscribe。

@Subscribe
   public void onToastEvent(ToastEvent event){
       Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show();
   }

通过register(this)来表示该订阅者进行了订阅,通过onToastEvent(ToastEvent event)表示指定对事件ToastEvent的订阅。到这里订阅就完成了。

需要注意的是:一般在onCreate()方法中进行注册订阅。在onDestory()方法中进行解除订阅。

@Override
    protected void onDestroy() {
        super.onDestroy();
        EventBus.getDefault().unregister(this);
    }

4 、发送消息
订阅已经完成,那么便可以发送订阅了。

EventBus.getDefault().post(new ToastEvent("Toast,发个提示,祝大家新年快乐!"));

那么onToastEvent(ToastEvent event)会收到事件,并弹出提示。

EventBus的基础使用流程就是这样的。

其实,EventBus还有好多其他的功能。下面我们一个个介绍。

三、EventBus的进阶使用

1.线程模式ThreadMode

当你接收的的事件后,如果处于非UI线程,你要更新UI怎么办?如果处于UI线程,你要进行耗时操作,怎么办?等等其他情况,通过ThreadMode统统帮你解决。

用法展示:

@Subscribe(threadMode = ThreadMode.MainThread)
    public void  onNewsEvent(NewsEvent event){
        String message = event.getMessage();
        mTv_message.setText(message);
    }

使用起来很简单,通过@Subscribe(threadMode = ThreadMode.MainThread)即可指定。
下面具体介绍下ThreadMode。

关于ThreadMode,一共有四种模式PostThread,PostThread,BackgroundThread以及Async。

PostThread:事件的处理在和事件的发送在相同的进程,所以事件处理时间不应太长,不然影响事件的发送线程。

**MainThread: **事件的处理会在UI线程中执行。事件处理时间不能太长,这个不用说的,长了会ANR的。

BackgroundThread:如果事件是在UI线程中发布出来的,那么事件处理就会在子线程中运行,如果事件本来就是子线程中发布出来的,那么事件处理直接在该子线程中执行。所有待处理事件会被加到一个队列中,由对应线程依次处理这些事件,如果某个事件处理时间太长,会阻塞后面的事件的派发或处理。

Async:事件处理会在单独的线程中执行,主要用于在后台线程中执行耗时操作,每个事件会开启一个线程。

2.priority事件优先级

事件的优先级类似广播的优先级,优先级越高优先获得消息。
用法展示:

@Subscribe(priority = 100)
    public void onToastEvent(ToastEvent event){
        Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show();
    }

当多个订阅者(Subscriber)对同一种事件类型进行订阅时,即对应的事件处理方法中接收的事件类型一致,则优先级高(priority 设置的值越大),则会先接收事件进行处理;优先级低(priority 设置的值越小),则会后接收事件进行处理。

除此之外,EventBus也可以终止对事件继续传递的功能。
用法展示:

 @Subscribe(priority = 100)
    public void onToastEvent(ToastEvent event){
        Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show();
        EventBus.getDefault().cancelEventDelivery(event);
    }

这样其他优先级比100低,并且订阅了该事件的订阅者就会接收不到该事件。

3.EventBus黏性事件

EventBus除了普通事件也支持粘性事件。可以理解成:订阅在发布事件之后,但同样可以收到事件。订阅/解除订阅和普通事件一样,但是处理订阅的方法有所不同,需要注解中添加sticky = true。
用法展示:

@Subscribe(priority = 100,sticky = true)
    public void onToastEvent(ToastEvent event){
        Toast.makeText(MainActivity.this,event.getContent(),Toast.LENGTH_SHORT).show();
        EventBus.getDefault().cancelEventDelivery(event);
    }

这样,假设一个ToastEvent 的事件已经发布,此时还没有注册订阅。当设置了sticky = true,在ToastEvent 的事件发布后,进行注册。依然能够接收到之前发布的事件。

不过这个时候,发布事件的方式就改变了。

EventBus.getDefault().postSticky(new ToastEvent("Toast,发个提示,祝大家新年快乐!"));

我们如果不再需要该粘性事件我们可以移除

EventBus.getDefault().removeStickyEvent(ToastEvent.class);

或者调用移除所有粘性事件

EventBus.getDefault().removeAllStickyEvents();
4.EventBus配置

EventBus在2.3版本中添加了EventBuilder去配置EventBus的各方各面。

比如:如何去构建一个在发布事件时没有订阅者时保持沉默的EventBus。

EventBus eventBus = EventBus.builder()
.logNoSubscriberMessages(false)
.sendNoSubscriberEvent(false)
.build();

通过上述设置,当一个事件没有订阅者时,不会输出log信息,也不会发布一条默认信息。

配置默认的EventBus实例,使用EventBus.getDefault()是一个简单的方法。获取一个单例的EventBus实例。EventBusBuilder也允许使用installDefaultEventBus方法去配置默认的EventBus实例。

注意:不同的EventBus 的对象的数据是不共享的。通过一个EventBus 对象去发布事件,只有通过同一个EventBus 对象订阅事件,才能接收该事件。所以以上使用EventBus.getDefault()获得的都是同一个实例。

下面用一个小栗子来展示下EventBus的应用。

以上就是本篇文章的内容。下一篇文章将从源码的角度来分析EventBus的使用。喜欢就给个赞吧,谢谢支持。马上就要过年了,祝大家新年快乐!

你可能感兴趣的:(关于EventBus,从使用到解析(上))