StateFlow
和 SharedFlow
是 Kotlin 协程(Coroutines) 提供的两种 响应式数据流(Reactive Streams),用于在应用程序中处理异步数据流,类似于 RxJava 的 Observable
或 Flowable
,但更轻量且与 Kotlin 协程深度集成。
1. StateFlow
(状态流)
StateFlow
是一种 热流(Hot Flow),它会存储当前的状态值,并在状态变化时通知所有订阅者。
特点
-
必须有初始值(不能为空)。
-
只保留最新的值(新订阅者会立即收到当前值)。
-
是
SharedFlow
的特殊情况(相当于replay=1
的SharedFlow
)。 -
适用于 UI 状态管理(如
ViewModel
暴露 UI 状态)。
示例
// 定义 StateFlow(通常在 ViewModel 中)
private val _counterState = MutableStateFlow(0) // 初始值 0
val counterState: StateFlow<Int> = _counterState.asStateFlow()// 更新值
fun increment() {_counterState.value++ // 自动通知所有订阅者
}// 在 Activity/Fragment 中监听
lifecycleScope.launch {viewModel.counterState.collect { value ->textView.text = "Count: $value"}
}
2. SharedFlow
(共享流)
SharedFlow
也是一种 热流,但它不存储状态,而是用于 广播事件(如一次性事件、通知等)。
特点
-
没有初始值(可以发送任意数量的数据)。
-
可以配置缓存大小(
replay
控制新订阅者能收到多少历史数据)。 -
适用于事件总线、通知等场景(如 Toast 消息、导航事件)。
示例
// 定义 SharedFlow(通常在 ViewModel 中)
private val _toastEvent = MutableSharedFlow<String>() // 无初始值
val toastEvent: SharedFlow<String> = _toastEvent.asSharedFlow()// 发送事件
fun showToast(message: String) {viewModelScope.launch {_toastEvent.emit(message) // 发送事件}
}// 在 Activity/Fragment 中监听
lifecycleScope.launch {viewModel.toastEvent.collect { message ->Toast.makeText(this, message, Toast.LENGTH_SHORT).show()}
}
StateFlow
vs SharedFlow
特性 | StateFlow | SharedFlow |
---|---|---|
初始值 | ✅ 必须有 | ❌ 不需要 |
缓存历史数据 | 仅最新值 | 可配置 (replay ) |
适用场景 | UI 状态管理(如 LiveData 替代) | 事件总线、通知 |
是否热流 | ✅ 是 | ✅ 是 |
线程安全 | ✅ 是(协程作用域内) | ✅ 是 |
因此,以下面这段代码举例:
/*** 应用中心数据变化,更新应用中心小组件的显示*/private fun WidgetSelectorViewModel.observerAppList() = coroutineScope.launch {appWidgets.onEach { list ->Log.d(TAG, "observerAppList setDataList")gridAdapterApp.setDataList(list)appItemBinding?.groupNoData?.isVisible = list.isEmpty()}.launchIn(coroutineScope)}
功能总结:
这段代码的主要作用是监听应用小组件列表(appWidgets)的变化,每当列表更新时:
将新列表设置给网格适配器(gridAdapterApp)以更新UI
根据列表是否为空来显示或隐藏"无数据"的提示
所有这些操作都在协程中异步执行
这是一种典型的响应式编程模式,通过观察数据流来自动更新UI,避免了手动刷新数据的需要。
首先是函数定义:
private fun WidgetSelectorViewModel.observerAppList() = coroutineScope.launch {
-
这是一个 WidgetSelectorViewModel 的扩展函数
-
函数是私有的(private)
-
返回一个协程启动器(launch)
-
函数名为 observerAppList(),表示它用于观察应用列表
其次是函数体:
appWidgets.onEach { list ->gridAdapterApp.setDataList(list)appItemBinding?.groupNoData?.isVisible = list.isEmpty()
}.launchIn(coroutineScope)
-
appWidgets
可能是一个StateFlow
或SharedFlow
(取决于它的定义)。 -
onEach
会在每次数据变化时执行,更新 UI。 -
launchIn(coroutineScope)
表示在指定的协程作用域内启动这个流。
总结
-
StateFlow
→ 用于 UI 状态管理(如LiveData
的替代)。 -
SharedFlow
→ 用于 事件通知(如 Toast、导航事件)。 -
两者都是 热流,即使没有订阅者也会发送数据。
-
通常结合
ViewModel
+collect
使用,实现响应式 UI 更新。
如果你的 appWidgets
是一个应用列表的状态,那它更适合用 StateFlow
;如果是临时事件(如刷新完成通知),则更适合 SharedFlow
。