EventBus 简介与实践

本文基于EvnetBus 3.1.1 文中监听和订阅同义 Android开发角度 kotlin

EventBus是什么

EventBus

eventBus顾名思义就是事件总线,实际上就是一个 事件发布者/事件监听者(订阅者) 的框架, 发布者发布Event，Bus自动处理与分发,监听者被动的接受。
在加入了这个框架后,我们需要做的非常简单,只需要发送时间,然后在需要的地方接受就可以了,不需要关注这两者是如何建立联系的,从而快速稳定地实现不同地方不同线程信息传递,极大简化异步和各种跳转时的通信。

EventBus的优势(官方):

• 简化了组件之间的通信
  • 事件发送者和接收者的解耦
  • 很好地工作在Activities, Fragments,后台线程中
  • 避免复杂且容易出错的依赖关系和生命周期问题
• 使代码更简单
• 很快(EventBus 3.x 版本性能非常好,官方自称是同类框架中最快的)
• 很小(~50 K)
• 在实践中被一亿多安装的应用程序所证明
• 具有高级特性，如线程分发、订阅者优先级等

如何使用EventBus

1.EventBus添加到项目中

Android项目当然是使用Gradle

implementation 'org.greenrobot:eventbus:3.1.1'

2.定义事件

该步骤可选,可以跳过该部分直接阅读后面
项目实践中的事件封装：

/**
 * [code]是该事件的识别编号，[data]为传输的数据，默认为空
 */
data class EventMessage<T>(val code: Int, val data: T? = null)

需要说明的是，EventBus的事件分发由"event"的类型event.getClass()决定发给那个接收者的。封装成EventMessage<T>的形式，但EventBus并不会区分泛型

//EventCode是自定义的一系列const Int值
fun xxx(){
EventBus.getDefault().post(EventMessage(EventCode.EventPostTest, "12345"))
EventBus.getDefault().post(EventMessage(EventCode.EventPostTest2, 123))
}
@Subscribe(threadMode = ThreadMode.MAIN)
fun onReceiveEvent1(event: EventMessage<String>) 

@Subscribe(threadMode = ThreadMode.MAIN)
fun onReceiveEvent2(event: EventMessage<Int>) 

onReceiveEvent1和onReceiveEvent2都会接收到前面两次post事件，也不会自动转型，EventBus将吞下这次异常不会崩溃（有logcat打印），可以通过event.code 或者类型判断解决.既然这么封装了，实际中肯定是用code来区分的

@Subscribe(threadMode = ThreadMode.MAIN)
fun onReceiveEvent1(event: EventMessage<String>) {
    if (event.data is String) {
        LogUtils.e(event.data + " String 的接收者")
    }
}
@Subscribe(threadMode = ThreadMode.MAIN)
fun onReceiveEvent2(event: EventMessage<Int>) {
    if (event.code == EventCode.EventPostTest2) {
        LogUtils.e("${event.data} Int 的接收者")
    }
}

3.准备订阅者

声明并用注释标明一个订阅方法

@Subscribe(threadMode = ThreadMode.MAIN)
fun onReceiveEvent2(event: EventMessage<Int>) {
    if (event.code == EventCode.EventPostTest2) {
        LogUtils.e("${event.data} Int 的接收者")
    }
}

• 参数 非常重要，决定收到什么样的事件
• 方法名是随意的，但根据多次实验假设你有fun1 fun2 fun3三个订阅者，无论其在代码中的顺序如何，执行顺序就是fun1 fun2 fun3,这条结论并未从源码验证
• 注释 @Subscribe 标明这是一个EventBus的订阅者
  说明一下 @Subscribe 注释的参数，三个参数全部为可选
  • threadMode默认为ThreadMode.POSTING
    • POSTING哪个线程发送，监听方法直接同线程被调用，事件传递开销最少，事件处理程序必须快速返回，否则可能导致主线程阻塞
    • MAIN显然将在Android的主线程执行。如果发布线程是主线程，监听方法直接执行，否者将排队等待（类似handle），必须不能执行耗时操作
    • MAIN_ORDERED 3.1.1新加入的，执行在主线程，与MAIN不同的是，一定会排队执行
    • BACKGROUND如果事件发送在非主线程，直接调用监听方法。在主线程的话，EventBus将在一个单一的后台线程中排队执行，同样不应该执行耗时任务，避免阻塞
    • ASYNC 将在单独的线程中被调用并且总是独立于发布线程和主线程，适合执行耗时操作，EventBus使用一个线程池来有效地重用完成的异步任务，但依然应该避免同时触发大量长时间运行的异步方法，以限制并发线程的数量
  • sticky默认为false
    sticky = true时，订阅方法(参数类型为T)会获得最后一个被sticky发送的T类型事件，即被"粘在缓存中"的每个类型中的最后一个,可用于页面跳转时传送数据，可避免序列化 诸如TransactionTooLargeException之类
  • priority默认为0，相同线程中的监听者的执行顺序,数字越大越先，注意相同线程!!!

注册和取消注册订阅者

Android中，通常在生命周期中进行：

override fun onStart() {
    super.onStart()
    EventBus.getDefault().register(this)
}
override fun onStop() {
    super.onStop()
    EventBus.getDefault().unregister(this)
}

4.发送事件

    EventBus.getDefault().post(EventMessage(EventCode.EventPostTest, "coair"))

发送普通事件

    EventBus.getDefault().postSticky(EventMessage(EventCode.EventPostTest,null))

发送sticky事件，最后一个该类型的事件将"粘"在缓存中，以待相应订阅者获取，可重复获取

实践封装

直接点，为了减少行数 删了注释

object MyBus {
    fun register(subscriber: Any) {
        val eventBus = EventBus.getDefault()
        if (!eventBus.isRegistered(subscriber)) {
            eventBus.register(subscriber)
        }
    }
    fun unregister(subscriber: Any) {
        val eventBus = EventBus.getDefault()
        if (eventBus.isRegistered(subscriber)) {
            eventBus.unregister(subscriber)
        }
    }
    fun post(event: EventMessage<*>) {
        EventBus.getDefault().post(event)
    }
    fun postSticky(event: EventMessage<*>) {
        EventBus.getDefault().postSticky(event)
    }
}
data class EventMessage<T>(val code: Int, val data: T? = null)

fun <T> Int.todo(event: EventMessage<T>, t: (T?) -> Unit) {
    if (event.code == this) {
        t(event.data)
    }
}

abstract class BaseActivity : AppCompatActivity() {
    override fun onStart() {
        super.onStart()
        if (isRegisteredEventBus()) {
            MyBus.register(this)
        }
    }
    override fun onStop() {
        super.onStop()
        if (isRegisteredEventBus()) {
            MyBus.unregister(this)
        }
    }
    open fun isRegisteredEventBus() = false
    open val uiEvents: Map<Int, (Any?) -> Unit> = mapOf()
    @Subscribe(threadMode = ThreadMode.MAIN)
    fun onReceiveEvent(event: EventMessage<*>) {
        uiEvents.forEach { code, func ->
            code.todo(event) {
                func(it)
            }
        }
    }
}

使用：这种封装方式单纯的更新UI还是挺方便的

class MainActivity : BaseBackActivity() {
    override fun isRegisteredEventBus() = true
    override val uiEvents = mapOf(
        EventCode.EventPostTest to ::justToast
    )

    private fun justToast(s: Any?) =...
}

结语

EventBus是个使用很简单的库，也有和RxAndroid结合的使用方法，结合实际自行选择，感谢阅读