乐趣区

关于android:Kotlin就几行代码-用SharedFlow写个FlowEventBus

jiezi

背景

跨页面通信是一个比拟常见的场景，通常咱们会抉择应用 EventBus，但EventBus 无奈感知生命周期，收到音讯就会回调，所以有了 LiveData 之后很快就有了LiveEventBus。不过它也有毛病，比方不能切换接管线程。当初 SharedFlow 稳固了，那是不是也能搞一波？

于是有了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()
    ...

}

Android 高级开发零碎进阶笔记、最新面试温习笔记 PDF，我的 GitHub

文末

您的点赞珍藏就是对我最大的激励！
欢送关注我，分享 Android 干货，交换 Android 技术。
对文章有何见解，或者有何技术问题，欢送在评论区一起留言探讨！

退出移动版