配套依赖(build.gradle.kts)
implementation("androidx.lifecycle:lifecycle-viewmodel-compose:2.11.0")
一、ViewModel 标准模板(UI状态存放)
核心:私有可变 MutableStateFlow,对外暴露只读 StateFlow;修改逻辑收敛在 ViewModel 内部
// viewmodel/index.kt
package cn.xuejs.myapplication.viewmodel
import androidx.lifecycle.ViewModel
import kotlinx.coroutines.flow.MutableStateFlow
import kotlinx.coroutines.flow.asStateFlow
import kotlinx.coroutines.flow.StateFlow
class CounterViewModel : ViewModel() {
// 私有可变源
private val _count = MutableStateFlow(0)
// 对外只读状态流
val count: StateFlow<Int> = _count.asStateFlow()
fun add() {
_count.value += 1
}
fun reset() {
_count.value = 0
}
}
Compose 页面消费:
@Composable
fun MainPage(
viewModel: CounterViewModel = viewModel()
) {
// collectAsStateWithLifecycle:跟随页面生命周期,后台自动暂停收集,省电
val count by viewModel.count.collectAsStateWithLifecycle()
Column(modifier = Modifier.systemBarsPadding()) {
Text("${count}")
Button(onClick = { viewModel.add() }) {
Text("+1")
}
Button(onClick = { viewModel.reset() }) {
Text("reset")
}
}
}
二、Flow 总览区分
| 类型 | 冷热 | 特点 | 典型用途 |
|---|---|---|---|
| Flow | 冷流 | 不collect就不执行;每一次collect都是独立从头执行;无默认值 | 一次性数据流、网络请求、本地读取、序列生成 |
| StateFlow | 热流 | 必须初始化、持有当前值;新订阅者直接拿到最新值;相同值自动去重;可缓存 | UI状态(计数器、页面加载态、表单数据) |
| SharedFlow | 热流 | 可配置回放replay;不自带当前值;多条订阅同时接收同一份发射;不会自动去重 | 一次性事件:Toast、弹窗、页面跳转、消息通知 |
一句话口诀: Flow 做一次性数据流;StateFlow 存UI状态;SharedFlow 发一次性事件。
三、Flow(冷流)
冷流:订阅才开始跑,多个订阅互相独立,每次collect从头走一遍
// 方式1:flow{} 构建器(最常用,支持delay、emit)
fun numberFlow(): Flow<Int> = flow {
emit(1)
delay(1000)
emit(2)
delay(1000)
emit(3)
}
// 方式2:flowOf 直接发射固定值
val fixedFlow = flowOf(10, 20, 30)
中间算子(不触发执行,链式转换)
flowOf(1,2,3)
.map { it * 2 } // 转换:值映射
.filter { it > 2 } // 过滤:只保留符合条件
.onEach { println(it) } // 每个数据经过时回调(埋点、日志)
示例:多订阅独立执行
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
enableEdgeToEdge()
val getNumberFlow = flow {
emit(1)
delay(1000)
emit(2)
delay(1000)
emit(3)
}
println("aaa")
lifecycleScope.launch {
println("TEST begin")
getNumberFlow.collect { println("TEST $it") }
println("TEST finished")
}
lifecycleScope.launch {
println("TEST1 begin")
getNumberFlow.collect { println("TEST1 $it") }
println("TEST1 finished")
}
setContent { }
}
现象:两个collect会各自独立计时、独立发射,互不共享。
四、StateFlow(UI状态专用热流)
重点特性:
- 热流,创建即存在,不需要等待collect
- 强制初始值,永远持有最新状态
- 新订阅上来直接拿到最新值
- 新值和旧值相等时,自动去重,不会通知下游
- 适合:页面状态、计数器、开关、列表数据
对比几种存放状态方案(重点理解生命周期)
- object 全局单例:整个App进程存活,跨页面共享,旋转不会重置;进程被杀才清空
object GlobalCounter {
private val _count = MutableStateFlow(0)
val count: StateFlow<Int> = _count.asStateFlow()
fun add() { _count.value++ }
}
- ViewModel 页面级:绑定ViewModelStoreOwner,屏幕旋转保留;页面真正退出(pop/finish)才清空 ✅【推荐UI状态】
class CounterVm : ViewModel() {
private val _count = MutableStateFlow(0)
val count: StateFlow<Int> = _count.asStateFlow()
fun add() { _count.value++ }
}
- 直接在onCreate里new普通类:Activity旋转重建 → onCreate重新执行 → 实例重新创建,状态归零 ❌
- remember { } :Compose重组不会重建;但是屏幕旋转(Activity重建)会销毁重建,状态归零 ❌
// remember 仅保护Compose重组,不能抵抗配置变更(旋转)
val counter = remember { Counter() }
val count by counter.count.collectAsStateWithLifecycle()
消费示例
@Composable
fun StateFlowDemoPage() {
val vm: CounterVm = viewModel()
val count by vm.count.collectAsStateWithLifecycle()
Text("计数:$count")
Button(onClick = { vm.add() }) { Text("+1") }
}
五、SharedFlow(一次性事件热流)
特性:
- 热流,支持多订阅同时接收
- 没有默认值,不会保存状态
- replay:回放数量,replay=0 = 没订阅收到消息直接丢掉
- 不会自动去重;适合一次性事件:Toast、弹窗、路由跳转、提示消息
⚠️ 坑:emit是挂起函数,必须在协程里发射
class EventManager {
// replay=0:不缓存,无订阅者时消息丢失
private val _msgFlow = MutableSharedFlow<String>(replay = 0)
val msgFlow: SharedFlow<String> = _msgFlow
suspend fun sendMsg(text: String) {
_msgFlow.emit(text)
}
}
Compose 页面使用:
@Composable
fun SharedFlowEventPage() {
val eventMgr = remember { EventManager() }
val scope = rememberCoroutineScope()
LaunchedEffect(Unit) {
eventMgr.msgFlow.collect { msg ->
println("收到事件:$msg")
// Toast.makeText(this@MainActivity, msg, Toast.LENGTH_SHORT).show()
}
}
Column {
Button(onClick = {
scope.launch {
eventMgr.sendMsg("你点击了按钮")
}
}) {
Text("发送一次性事件")
}
}
}
为什么事件不用StateFlow? StateFlow会持有值,页面重建/重新collect时,会重复收到上一次的Toast消息,造成弹窗重复弹出。SharedFlow(replay=0) 不会缓存,适合只消费一次的事件。
六、高频总结清单(面试/开发速查)
- Flow:冷流,订阅才执行,多次collect多次执行 → 数据查询、读取
- StateFlow:热流、带当前值、自动去重 → UI状态(ViewModel首选)
- SharedFlow:热流、无默认值、可多订阅、replay控制回放 → 一次性事件
collectAsStateWithLifecycle:生产标准写法,优于collectAsState,后台暂停收集- remember:只能防Compose重组,扛不住屏幕旋转
- ViewModel:依托ViewModelStore,配置变更(旋转)不销毁,页面真正退出才onCleared
- 预览里面new ViewModel要写在组合lambda外面,规避 Lint
Constructing a view model in a composable