一、EventBus简介
1、EventBus是一款针对Android优化的发布/订阅事件总线
2、EventBus主要功能是代替Intent、Handler、BroadCast等在Activity,Fragment,Service线程之间传递消息的。
3、EventBus代码开销小、更加优雅、彻底解耦
二、使用步骤
1:添加依赖
在 module 级build.gradle中添加依赖:
dependencies {
def eventbus_version = '3.2.0'
implementation "org.greenrobot:eventbus:$eventbus_version"
}
使用编译时索引时,还需要依赖 注解处理工具,注意:纯 Java 项目和 Kotlin 使用的注解处理工具不同:
Java 项目使用annotationProcessor
Kotlin 项目使用kapt
// Java:
android {
defaultConfig {
javaCompileOptions {
annotationProcessorOptions {
arguments = [ eventBusIndex : 'com.have.a.good.MyEventBusAppIndex' ]
}
}
}
}
dependencies {
def eventbus_version = '3.2.0'
implementation "org.greenrobot:eventbus:$eventbus_version"
annotationProcessor "org.greenrobot:eventbus-annotation-processor:$eventbus_version"
}
//Kotlin
apply plugin: 'kotlin-android'
apply plugin: 'kotlin-android-extensions'
apply plugin: 'kotlin-kapt' // ensure kapt plugin is applied
dependencies {
def eventbus_version = '3.2.0'
implementation "org.greenrobot:eventbus:$eventbus_version"
kapt "org.greenrobot:eventbus-annotation-processor:$eventbus_version"
}
kapt {
arguments {
arg('eventBusIndex', 'com.have.a.good.MyEventBusAppIndex')
}
}
2:注册与注销
EventBus不需要去做任何初始化,可以直接上手,只不过要注意两个条件,在你需要接收的页面去注册以及解绑。
@Override
public void onStart() {
super.onStart();
EventBus.getDefault().register(this);
}
@Override
public void onStop() {
EventBus.getDefault().unregister(this);
super.onStop();
}
3:发送数据
这里可以稍微了解一下原理,怎样发送数据或者传递消息呢,可以直接调用EventBus的getDefault()拿到EventBus的实例,再post方法传递数据,例如:
EventBus.getDefault().post(new DeleteEvent());
这里我们注意一下,post里面的参数对象是一个object,你可以传int,string甚至class等等,这里我选择传入一个类用于区分消息,这个类是自定义的一个普通类,你可以什么也不做,也可以在里面带参,例如:
这样,数据就已经传递完成了
4:接收数据
接收数据页面有四个函数,功能各不同,这里先用其中之一,展示一下
@Subscribe(threadMode = ThreadMode.MAIN)
public void onMessageEvent(DeleteEvent event) {
}
上面已经接收到数据了,你可以在该方法中去实现你想要做的事情。
三、EventBus内置的4种线程模型
1、ThreadMode.POSTING
如果使用事件处理函数指定了线程模型为PostThread,那么该事件在哪个线程发布出来的,事件处理函数就会在这个线程中运行,也就是说发布事件和接收事件在同一个线程。在线程模型为PostThread的事件处理函数中尽量避免执行耗时操作,因为它会阻塞事件的传递,甚至有可能会引起ANR。
2、ThreadMode.MAIN
如果使用事件处理函数指定了线程模型为MainThread,那么不论事件是在哪个线程中发布出来的,该事件处理函数都会在UI线程中执行。该方法可以用来更新UI,但是不能处理耗时操作。
3、ThreadMode.BACKGROUND
如果使用事件处理函数指定了线程模型为BackgroundThread,那么如果事件是在UI线程中发布出来的,那么该事件处理函数就会在新的线程中运行,如果事件本来就是子线程中发布出来的,那么该事件处理函数直接在发布事件的线程中执行。在此事件处理函数中禁止进行UI更新操作。
4、ThreadMode.ASYNC
如果使用事件处理函数指定了线程模型为Async,那么无论事件在哪个线程发布,该事件处理函数都会在新建的子线程中执行。同样,此事件处理函数中禁止进行UI更新操作。