背景
跨页面通信是一个比较常见的场景,通常我们会选择使用EventBus
,但EventBus
无法感知生命周期,收到消息就会回调,所以有了LiveData
之后很快就有了LiveEventBus
。不过它也有缺点,比如不能切换接收线程。现在SharedFlow
稳定了,那是不是也能搞一波?
于是有了FlowEventBus
常用消息总线对比
消息总线 | 延迟发送 | 有序接收消息 | Sticky | 生命周期感知 | 跨进程/APP | 线程分发 |
---|---|---|---|---|---|---|
EventBus | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ |
RxBus | ❌ | ✅ | ✅ | ❌ | ❌ | ✅ |
LiveEventBus | ✅ | ✅ | ✅ | ✅ | ✅ | ❌ |
FlowEventBus | ✅ | ✅ | ✅ | ✅ | ❌ | ✅ |
设计构思
通过学习 从 LiveData 迁移到 Kotlin 数据流 得到思路:
- SharedFlow作为事件载体 :
优点: - 依托协程轻松切换线程
- 可以通过replay实现粘性效果
- 可以被多个观察者订阅
- 无观察者自动清除事件不会造成积压
结合 Lifecycle 感知生命周期,做到响应时机可控 。
不仅可以全局范围的事件,也可以单页面内的通信而不透传到别的页面,如:Activity内部,Fragment内部通信。
依赖库版本
关键在于 kotlinx-coroutines > 1.4.x
和 lifecycle-runtime-ktx > 2.3.x
API
以下示例中的
*Event
均是随意定义的类,只是测试时为了区分事件而定义的名字
事件发送
//全局范围
postEvent(AppScopeEvent("form TestFragment"))
//Fragment 内部范围
postEvent(fragment,FragmentEvent("form TestFragment"))
//Activity 内部范围
postEvent(requireActivity(),ActivityEvent("form TestFragment"))
复制代码
事件监听
//接收 Activity Scope事件
observeEvent<ActivityEvent>(scope = requireActivity()) {
...
}
//接收 Fragment Scope事件
observeEvent<FragmentEvent>(scope = fragment) {
...
}
//接收 App Scope事件
observeEvent<AppScopeEvent> {
...
}
复制代码
Like ObserveForever:
//此时需要指定协程范围
observeEvent<GlobalEvent>(scope = coroutineScope) {
...
}
复制代码
延迟发送
postEvent(CustomEvent(value = "Hello Word"),1000)
复制代码
线程切换
observeEvent<ActivityEvent>(Dispatchers.IO) {
...
}
复制代码
指定可感知的最小生命状态
observeEvent<ActivityEvent>(minActiveState = Lifecycle.State.DESTROYED) {
...
}
复制代码
以粘性方式监听
observeEvent<GlobalEvent>(isSticky = true) {
...
}
复制代码
移除粘性事件
removeStickyEvent(StickyEvent::class.java)
removeStickyEvent(fragment,StickyEvent::class.java)
removeStickyEvent(activity,StickyEvent::class.java)
复制代码
原理
以上功能依托于Kotlin协程的SharedFlow
和Lifecycle
因此实现起来非常简单。
- 粘性事件
MutableSharedFlow<Any>(
replay = if (isSticky) 1 else 0,
extraBufferCapacity = Int.MAX_VALUE //避免挂起导致数据发送失败
)
复制代码
- 生命周期感知
fun <T> LifecycleOwner.launchWhenStateAtLeast(
minState: Lifecycle.State,
block: suspend CoroutineScope.() -> T
) {
lifecycleScope.launch {
lifecycle.whenStateAtLeast(minState, block)
}
}
复制代码
- 切换线程
whenStateAtLeast
由于执行的block
默认是在主线程,因此需要手动切换线程:
lifecycleOwner.launchWhenStateAtLeast(minState) {
flow.collect { value ->
lifecycleOwner.lifecycleScope.launch(dispatcher) {
onReceived.invoke(value as T)
}
}
}
复制代码
- 延迟事件
viewModelScope.launch {
delay(time)
flow.emit(value)
}
复制代码
-
有序分发
Flow
本身就是有序的 -
全局单例
使用全局ViewModel
,主要是因为有ViewModelScope
,可以避免使用GlobalScope
,如果想要单页面内部组件通信,那就使用ActivityScope的ViewModel就行了:
object ApplicationScopeViewModelProvider : ViewModelStoreOwner {
private val eventViewModelStore: ViewModelStore = ViewModelStore()
override fun getViewModelStore(): ViewModelStore {
return eventViewModelStore
}
private val mApplicationProvider: ViewModelProvider by lazy {
ViewModelProvider(
ApplicationScopeViewModelProvider,
ViewModelProvider.AndroidViewModelFactory.getInstance(EventBusInitializer.application)
)
}
fun <T : ViewModel> getApplicationScopeViewModel(modelClass: Class<T>): T {
return mApplicationProvider[modelClass]
}
}
复制代码
ViewModel内部有2个map
,分别是粘性和非粘性:
internal class EventBusViewModel : ViewModel() {
private val eventFlows: HashMap<String, MutableSharedFlow<Any>> = HashMap()
private val stickyEventFlows: HashMap<String, MutableSharedFlow<Any>> = HashMap()
...
}
复制代码
总结
站在巨人的肩膀上的同时也可以简单了解下原理。不过挺复杂的,需要下点功夫😄
附送上 Github地址 :github.com/biubiuqiu0/…