一、EventBus 简介
EventBus是一种用于Android的事件发布-订阅总线,由GreenRobot开发,Gihub地址是:EventBus。
它简化了应用程序内各个组件之间进行通信的复杂度,尤其是碎片之间进行通信的问题,可以避免由于使用广播通信而带来的诸多不便。
1. 作用
ventBus是一个Android端优化的publish/subscribe消息总线,简化了应用程序内各组件间、组件与后台线程间的通信。比如请求网络,等网络返回时通过Handler或Broadcast通知UI,两个Fragment之间需要通过Listener通信,这些需求都可以通过EventBus实现
优点:简化组件之间的通信方式,实现解耦让业务代码更加简洁,可以动态设置事件处理线程以及优先级
缺点:目前发现唯一的缺点就是类似之前策略模式一样的诟病,每个事件都必须自定义一个事件类,造成事件类太多,无形中加大了维护成本
2. 三个角色
Event:事件,它可以是任意类型,EventBus会根据事件类型进行全局的通知。
Subscriber:事件订阅者,在EventBus 3.0之前我们必须定义以onEvent开头的那几个方法,分别是onEvent、onEventMainThread、onEventBackgroundThread和onEventAsync,而在3.0之后事件处理的方法名可以随意取,不过需要加上注解@subscribe,并且指定线程模型,默认是POSTING。
Publisher:事件的发布者,可以在任意线程里发布事件。一般情况下,使用EventBus.getDefault()就可以得到一个EventBus对象,然后再调用post(Object)方法即可。
3. 四种线程模型
EventBus3.0有四种线程模型-ThreadMode,分别是:
@Subscribe(threadMode = ThreadMode.POSTING)
@Subscribe(threadMode = ThreadMode.MAIN)
@Subscribe(threadMode = ThreadMode.BACKGROUND)
@Subscribe(threadMode = ThreadMode.ASYNC)
POSTING:默认,表示事件处理函数的线程跟发布事件的线程在同一个线程。
MAIN:表示事件处理函数的线程在主线程(UI)线程,因此在这里不能进行耗时操作。
BACKGROUND:表示事件处理函数的线程在后台线程,因此不能进行UI操作。如果发布事件的线程是主线程(UI线程),那么事件处理函数将会开启一个后台线程,如果果发布事件的线程是在后台线程,那么事件处理函数就使用该线程。
ASYNC:表示无论事件发布的线程是哪一个,事件处理函数始终会新建一个子线程运行,同样不能进行UI操作。
二、EventBus 使用
1. 引入依赖
在使用之前先要引入如下依赖:
implementation 'org.greenrobot:eventbus:3.1.1
2. 定义事件
定义一个事件的封装对象,使用该对象作为通信的信息类:
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;
}
}
3. 订阅事件
假设定义一个Activity用来订阅事件:
订阅的时候要注册和取消注册。
注册一般是在 onCreate 和 onStart 里注册,尽量不要在 onResume,可能出现多次注册的情况,比如下面这个异常:EventBusException: Subscriber class already registered to event class
取消注册要写到 onDestroy 方法里,不要写到 onStop 里,生命周期有时会出现异常的。
public class Activity1 extends Activity{
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
EventBus.getDefault().register(this);
}
@Subscribe(threadMode = ThreadMode.MAIN, priority = 1)
public void messageEvent(MessageEvent messageEvent){
//订阅事件,接受到消息后打印
Log.d("eventBus","message:"+messageEvent.getMessage());
}
@Override
protected void onDestroy() {
super.onDestroy();
EventBus.getDefault().unregister(this);
}
}
4. 发送事件
假设定义一个Activity1用来订阅事件
public class Activity2 extends Activity{
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main2);
findViewById(R.id.button).setOnClickListener(new View.OnClickListener() {
@Override
public void onClick(View view) {
sendMessage();
}
});
}
public void sendMessage(){
EventBus.getDefault().post(new MessageEvent("Hello EventBus!"));//发送事件
}
}
三、EventBus 优先级
1. priority属性代表优先级
priority用来指定订阅方法的优先级,是一个整数类型的值,默认是0,值越大表示优先级越大。在某个事件被发布出来的时候,优先级较高的订阅方法会首先接受到事件。
@Subscribe(threadMode = ThreadMode.POSTING) //默认是0
@Subscribe(threadMode = ThreadMode.POSTING, priority = 1)
@Subscribe(threadMode = ThreadMode.POSTING, priority = 2)
以上消息接受顺序:2 - 1 - 0
2. 优先级高的订阅方法,可以取消事件分发
类似于广播,当取消事件的继续分发,排在后面优先级低的订阅则不能收到消息。
但如果需要终止事件分发,订阅方法的threadMode的值必须都置为ThreadMode.POSTING
只有在该模式下才可以取消线程,否则容易导致如下异常:EventBusException: This method may only be called from inside event handling methods on the posting thread
@Subscribe(threadMode = ThreadMode.POSTING, priority = 2)
public void messageEvent1(MessageEvent messageEvent){
// 终止事件的继续分发
EventBus.getDefault().cancelEventDelivery(messageEvent);
}