用途
该技能用于在 Kotlin 协程的三种流类型之间做选择:Flow、SharedFlow 和 StateFlow。它面向设计对外暴露值流的 API、把基于回调的代码重构为协程友好的流,以及在 UI 状态、服务端推送事件、周期性轮询等场景中不确定该用哪种流变体的情况。
不适用的情况:单个异步值应使用 suspend fun 或 Deferred<T>;一次性全部可得的有界值列表应使用 List<T> 或 Sequence<T>。
主要能力
Flow<T> —— 冷流
构造上是惰性的;生产代码只在收集者开始收集时运行,并且每个新的收集者都会从头重新运行。每个收集者获得各自独立的执行。
val temperatures: Flow<Reading> = flow {
while (true) {
emit(sensor.read())
delay(1.seconds)
}
}
// Collecting twice = two independent sensor-reading loops.
适用场景:每个消费者产生值的工作相同,且希望每次都是全新运行;流代表一次查询或一条转换管道;不存在需要共享的“当前值”概念。
SharedFlow<T> —— 热流、广播
单一生产路径;所有收集者看到相同的发射。没有必须的当前值。可选地缓冲并向迟到的订阅者重放过去的发射。
class NotificationBus {
private val _events = MutableSharedFlow<Notification>(replay = 0, extraBufferCapacity = 64)
val events: SharedFlow<Notification> = _events.asSharedFlow()
suspend fun publish(n: Notification) = _events.emit(n)
}
适用场景:多个订阅者必须看到相同的发射;流代表事件(通知、导航命令、广播更新);不存在规范的“当前值”,发射是离散事件。
StateFlow<T> —— 热流、合并、带当前值
SharedFlow 的特化:始终恰好有一个当前值,连续重复的值会被丢弃。收集者立即收到当前值,随后收到每次后续更新。
class UserState {
private val _user = MutableStateFlow<User?>(null)
val user: StateFlow<User?> = _user.asStateFlow()
fun update(newUser: User?) { _user.value = newUser }
}
适用场景:存在消费者关心的有意义的“当前值”(UI 状态、连接状态、当前用户);迟到的订阅者应立即看到当前状态而无需等待下一次更新;否则需要构建 BehaviorSubject 风格的构造(Rx 术语)。
使用方式
快速决策表
| 使用场景 | 选择 |
|---|---|
| 数据库查询 / 分页 / HTTP 流 | Flow(冷流) |
| 通知 / 一次性事件 / 命令 | SharedFlow |
| UI 状态 / 连接状态 / 当前用户 | StateFlow |
| 单个异步值 | suspend fun / Deferred |
决策启发式
- 如果每个收集者应获得各自独立的运行,用冷 Flow。
- 如果所有收集者共享单一生产路径,用热流。
- 如果当前值是契约的一部分,用 StateFlow;如果发射是没有“当前”概念的事件,用 SharedFlow。
- 合并是 StateFlow 的默认行为;应根据真实订阅者需求审慎配置 SharedFlow 的 replay 和 extraBufferCapacity。
反模式
- 公开暴露 MutableSharedFlow / MutableStateFlow —— 破坏封装。应暴露只读的 SharedFlow / StateFlow 接口,保持可变侧私有。
- 用冷 Flow 承载所有订阅者都应看到的事件 —— 迟到的订阅者会静默错过更早的发射。
- 用 StateFlow 承载事件 —— 合并会丢弃与当前值恰好相同的事件。
- 手动用 MutableList 缓冲事件并把它当作“流”暴露 —— 这是对 SharedFlow 的糟糕重造。
相关技能
- kp-flow-operators —— 转换与组合流。
- gof-observer —— Flow / SharedFlow / StateFlow 是 Kotlin 中一等公民的 Observer 实现。
- gof-kotlin-idioms —— Observer 部分也涉及这些内容。
参考资料
- Kotlin Design Patterns and Best Practices(Alexey Soshin),第 7 章(Controlling the Data Flow)。
- Kotlin 协程官方指南 —— Flows。