kotlin 01flow-StateFlow 完整教程

一 Android StateFlow 完整教程:从入门到实战

StateFlow 是 Kotlin 协程库中用于状态管理的响应式流,特别适合在 Android 应用开发中管理 UI 状态。本教程将带全面了解 StateFlow 的使用方法。

1. StateFlow 基础概念

1.1 什么是 StateFlow?

StateFlow 是 Kotlin 协程提供的一种热流(Hot Flow),它具有以下特点:

  • 总是有当前值(初始值必须提供)
  • 只保留最新值
  • 支持多个观察者
  • 与 LiveData 类似但基于协程

1.2 StateFlow vs LiveData

特性StateFlowLiveData
生命周期感知否(需配合 lifecycleScope)
需要初始值
基于协程观察者模式
线程控制通过 Dispatcher主线程
背压处理自动处理自动处理

2. 基本使用

2.1 添加依赖

在 build.gradle 中添加:

dependencies {implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4"implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4"implementation "androidx.lifecycle:lifecycle-viewmodel-ktx:2.5.1"implementation "androidx.lifecycle:lifecycle-runtime-ktx:2.5.1"
}

2.2 创建 StateFlow

class MyViewModel : ViewModel() {// 私有可变的StateFlowprivate val _uiState = MutableStateFlow<UiState>(UiState.Loading)// 公开不可变的StateFlowval uiState: StateFlow<UiState> = _uiState.asStateFlow()sealed class UiState {object Loading : UiState()data class Success(val data: String) : UiState()data class Error(val message: String) : UiState()}fun loadData() {viewModelScope.launch {_uiState.value = UiState.Loadingtry {val result = repository.fetchData()_uiState.value = UiState.Success(result)} catch (e: Exception) {_uiState.value = UiState.Error(e.message ?: "Unknown error")}}}
}

2.3 在 Activity/Fragment 中收集 StateFlow

class MyActivity : AppCompatActivity() {private val viewModel: MyViewModel by viewModels()override fun onCreate(savedInstanceState: Bundle?) {super.onCreate(savedInstanceState)lifecycleScope.launch {repeatOnLifecycle(Lifecycle.State.STARTED) {viewModel.uiState.collect { state ->when (state) {is MyViewModel.UiState.Loading -> showLoading()is MyViewModel.UiState.Success -> showData(state.data)is MyViewModel.UiState.Error -> showError(state.message)}}}}}private fun showLoading() { /*...*/ }private fun showData(data: String) { /*...*/ }private fun showError(message: String) { /*...*/ }
}

3. 高级用法

3.1 结合 SharedFlow 处理一次性事件

class EventViewModel : ViewModel() {private val _events = MutableSharedFlow<Event>()val events = _events.asSharedFlow()sealed class Event {data class ShowToast(val message: String) : Event()object NavigateToNextScreen : Event()}fun triggerEvent() {viewModelScope.launch {_events.emit(Event.ShowToast("Hello World!"))}}
}// 在Activity中收集
lifecycleScope.launch {repeatOnLifecycle(Lifecycle.State.STARTED) {viewModel.events.collect { event ->when (event) {is EventViewModel.Event.ShowToast -> showToast(event.message)EventViewModel.Event.NavigateToNextScreen -> navigateToNext()}}}
}

3.2 状态合并 (combine)

val userName = MutableStateFlow("")
val userAge = MutableStateFlow(0)val userInfo = combine(userName, userAge) { name, age ->"Name: $name, Age: $age"
}// 收集合并后的流
userInfo.collect { info ->println(info)
}

3.3 状态转换 (map, filter, etc.)

val numbers = MutableStateFlow(0)val evenNumbers = numbers.filter { it % 2 == 0 }.map { "Even: $it" }evenNumbers.collect { println(it) }

4. 性能优化

4.1 使用 stateIn 缓存 StateFlow

val networkFlow = flow {// 模拟网络请求emit(repository.fetchData())
}val cachedState = networkFlow.stateIn(scope = viewModelScope,started = SharingStarted.WhileSubscribed(5000), // 5秒无订阅者停止initialValue = "Loading..."
)

4.2 避免重复收集

// 错误方式 - 每次重组都会创建新的收集器
@Composable
fun MyComposable(viewModel: MyViewModel) {val state by viewModel.state.collectAsState()// ...
}// 正确方式 - 使用 derivedStateOf 或 remember
@Composable
fun MyComposable(viewModel: MyViewModel) {val state by remember { viewModel.state }.collectAsState()// ...
}

5. 测试 StateFlow

5.1 单元测试

@Test
fun `test state flow`() = runTest {val viewModel = MyViewModel()val results = mutableListOf<MyViewModel.UiState>()val job = launch {viewModel.uiState.collect { results.add(it) }}viewModel.loadData()advanceUntilIdle()assertEquals(3, results.size) // Loading, Success/ErrorassertTrue(results[0] is MyViewModel.UiState.Loading)job.cancel()
}

5.2 使用 Turbine 测试库

dependencies {testImplementation "app.cash.turbine:turbine:0.12.1"
}@Test
fun `test with turbine`() = runTest {val viewModel = MyViewModel()viewModel.uiState.test {viewModel.loadData()assertEquals(MyViewModel.UiState.Loading, awaitItem())val success = awaitItem()assertTrue(success is MyViewModel.UiState.Success)cancelAndIgnoreRemainingEvents()}
}

6. 常见问题解答

Q1: StateFlow 和 LiveData 哪个更好?

StateFlow 更适合协程环境,LiveData 更简单但功能较少。新项目推荐 StateFlow。

Q2: 如何处理背压(Backpressure)?

StateFlow 自动处理背压,只保留最新值。

Q3: 为什么我的收集器没有收到更新?

检查:

  1. 是否在正确的生命周期范围内收集
  2. Flow 是否有发射新值
  3. 是否在正确的协程上下文中

Q4: 如何避免内存泄漏?

使用 repeatOnLifecycleflowWithLifecycle 确保只在活跃生命周期收集。

7. 完整示例项目

以下是一个完整的 ViewModel 示例:

class UserViewModel(private val userRepository: UserRepository) : ViewModel() {private val _userState = MutableStateFlow<UserState>(UserState.Loading)val userState: StateFlow<UserState> = _userState.asStateFlow()private val _events = MutableSharedFlow<UserEvent>()val events: SharedFlow<UserEvent> = _events.asSharedFlow()init {loadUser()}fun loadUser() {viewModelScope.launch {_userState.value = UserState.Loadingtry {val user = userRepository.getUser()_userState.value = UserState.Success(user)} catch (e: Exception) {_userState.value = UserState.Error(e.message ?: "Unknown error")_events.emit(UserEvent.ShowErrorToast("Failed to load user"))}}}fun updateUserName(name: String) {viewModelScope.launch {val currentUser = (_userState.value as? UserState.Success)?.user ?: return@launchval updatedUser = currentUser.copy(name = name)_userState.value = UserState.Success(updatedUser)userRepository.updateUser(updatedUser)}}sealed class UserState {object Loading : UserState()data class Success(val user: User) : UserState()data class Error(val message: String) : UserState()}sealed class UserEvent {data class ShowErrorToast(val message: String) : UserEvent()}
}

通过本教程,应该已经掌握了 StateFlow 的核心用法。StateFlow 是构建响应式 Android 应用的强大工具,结合协程可以提供更简洁、更安全的状态管理方案。

二 stateFlow和sharedFlow的区别

关于 StateFlowSharedFlow 的问题非常关键。它们都是 Kotlin Flow 的“热流”(hot stream)变种,广泛用于 事件驱动编程状态管理。下面逐条详细解答问题:


✅ 1. StateFlow 和 SharedFlow 的区别?能否互相转换?

特性StateFlowSharedFlow
是否需要初始值✅ 是(必须有)❌ 否(可选)
是否有当前值 .value✅ 是❌ 没有
是否支持粘性订阅(可立即获取最新值)✅ 是(始终有当前值)❌ 否(默认非粘性,取决于 replay)
用于什么状态管理(UI 状态)一次性事件(导航、吐司等)
是否自动重发✅ 是:新订阅者立即拿到当前值❌ 否(需设置 replay > 0 才能重发)
是否支持多次发送相同值❌ 否(相同值不会触发 collect)✅ 是
是否丢失事件❌ 不会丢(始终保留一个最新值)✅ 可能丢(如果没有设置 replay 或 buffer)

🔁 能否互相转换?

不能直接转换,因为它们底层设计不同。但可以人为地模拟:

val sharedFlow = MutableSharedFlow<Int>(replay = 1)
val stateFlow = sharedFlow.stateIn(scope, SharingStarted.Eagerly, initialValue)

或者从 StateFlow 获取 SharedFlow 的行为:

val stateFlow: StateFlow<Int> = MutableStateFlow(0)
val sharedFlow = stateFlow.shareIn(scope, SharingStarted.Lazily)

✅ 2. 是不是 StateFlow 就是 SharedFlow 多了 .value 和初始值?

可以这么说,但这只是表面。它们的语义不同:

  • StateFlow 表示的是状态的容器(如 ViewModel 中的 UI 状态)。
  • SharedFlow 更像是事件的通道,没有“当前状态”的概念。
// StateFlow 的特点
println(stateFlow.value) // 始终可以拿到当前值// SharedFlow 没有 value,只能 collect
sharedFlow.collect { event -> ... }

✅ 3. 如何处理“被压的”问题(Backpressure、丢失事件)?

📌 StateFlow

  • 没有丢失问题:永远保留最后一个值。
  • 新订阅者会立刻收到当前值。
  • 不支持 backpressure,因为没有队列:只有一个值。
val sf = MutableStateFlow(0)
sf.value = 1
sf.value = 2
// collect 会立即收到 2(中间的1不会被保留)

📌 SharedFlow

  • 默认不保留任何事件replay = 0,无 buffer)。
  • 如果事件很快发送但没人 collect,就直接丢失
  • 可以设置 replayextraBufferCapacity 来控制:
val shared = MutableSharedFlow<Int>(replay = 2,extraBufferCapacity = 5
)
  • 设置 onBufferOverflow = BufferOverflow.DROP_OLDEST/ DROP_LATEST / SUSPEND 控制丢弃策略。

✅ 使用建议总结

需求推荐使用
需要保存并暴露当前状态(如 UI 状态)StateFlow
需要发送一次性事件,如 Toast、导航SharedFlow
想在订阅时立即拿到最后值StateFlow
想发送多个相同值SharedFlow(StateFlow 会去重)

三 MutableStateFlow 是如何更新值的?

_seatLevel.value = newValue_seatLevel.update { ... } 都可以用来更新 MutableStateFlow 的值,但它们在 并发安全性使用场景 上有区别:


1. _seatLevel.value = newValue(直接赋值)

  • 作用:直接设置 MutableStateFlow 的新值。
  • 特点
    • 非原子操作:如果在多线程环境下,直接赋值可能会导致竞态条件(Race Condition),因为 value 的读写不是线程安全的。
    • 简单直接:适用于单线程或确定不会并发更新的场景。
  • 示例
    _seatLevel.value = 5 // 直接设置新值
    

2. _seatLevel.update { ... }(原子更新)

  • 作用:以 原子方式 计算并更新 MutableStateFlow 的值。
  • 特点
    • 原子操作update 是线程安全的,内部使用 CAS (Compare-And-Swap) 机制,确保在并发环境下不会出现数据竞争。
    • 基于当前值计算:可以访问当前值(current),并返回新值。
    • 适合条件更新:适用于需要依赖当前值进行计算的场景(如递增、条件过滤等)。
  • 示例
    _seatLevel.update { current ->if (newLevel in 0..100) newLevel else current
    }
    
    这里:
    • current 是当前 _seatLevel 的值。
    • 返回的值会作为新值(如果 newLevel 不在 0..100 范围内,则保持原值)。

关键区别

特性_seatLevel.value = newValue_seatLevel.update { ... }
线程安全❌ 非原子操作,可能竞态条件✅ 原子操作,线程安全
是否依赖当前值❌ 直接赋值,不关心当前值✅ 可以访问当前值并计算新值
适用场景单线程或确定无并发更新多线程环境或需要条件更新

如何选择?

  1. 如果只是简单赋值,且确定不会并发更新(例如 UI 线程中),可以直接用 value = newValue
  2. 如果涉及多线程,或需要基于当前值计算新值(如递增、条件过滤等),应该用 update { ... }

底层实现

  • update 内部使用了 while (true) + compareAndSet 机制,确保原子性:
    public inline fun update(function: (T) -> T) {while (true) {val prevValue = valueval nextValue = function(prevValue)if (compareAndSet(prevValue, nextValue)) {return}}
    }
    
    它会不断尝试更新,直到成功(避免并发冲突)。

总结

  • value = newValue:简单直接,但不适合并发场景。
  • update { ... }:线程安全,适合多线程或需要依赖当前值的更新。

在你的 updateLevel 函数中,由于涉及条件判断(newLevel in 0..100),使用 update 是更安全、更合理的选择。

四 为什么update 更新是原子性?

相关代码

public inline fun update(function: (T) -> T) {while (true) {val prevValue = valueval nextValue = function(prevValue)if (compareAndSet(prevValue, nextValue)) {return}}
} 

这段代码之所以能保证 MutableStateFlow 的更新是 原子性(Atomic) 的,关键在于它使用了 CAS(Compare-And-Swap) 机制,并通过 while (true) 循环确保最终成功更新。我们逐行分析其原子性保证:


1. compareAndSet(prevValue, nextValue) 是关键

compareAndSetAtomic 操作(底层基于 CPU 的 CAS 指令),它的行为是:

fun compareAndSet(expect: T, newValue: T): Boolean
  • 如果当前 value == expect(说明其他线程尚未修改),则更新为 newValue 并返回 true
  • 如果当前 value != expect(说明其他线程已经修改),则放弃更新并返回 false

由于 compareAndSet硬件级原子操作,它保证了:

  • 读取 value比较 expect写入 newValue 这三个步骤是 不可分割的(不会被其他线程打断)。

2. while (true) 循环的作用

如果 compareAndSet 失败(返回 false),说明其他线程已经修改了 value,此时:

  1. 重新读取最新的 valueval prevValue = value)。
  2. 重新计算 nextValuefunction(prevValue))。
  3. 再次尝试 compareAndSet,直到成功为止。

这种 乐观锁(Optimistic Locking) 策略确保了:

  • 即使多线程竞争,最终所有更新都会 按顺序应用(不会丢失任何修改)。
  • 不会发生 死锁(因为没有阻塞,只是重试)。

3. 为什么能保证原子性?

  • compareAndSet 是原子的:单次 compareAndSet 调用是线程安全的。
  • 循环直到成功:即使其他线程并发修改,当前线程最终会基于最新的值成功更新。
  • 函数式更新function(prevValue) 的计算是基于最新的 prevValue,不会出现脏数据。

4. 对比非原子更新的问题

如果直接用 value = newValue

// 非原子操作,可能导致竞态条件
_seatLevel.value = _seatLevel.value + 1

在多线程环境下:

  1. 线程 A 读取 value = 0
  2. 线程 B 读取 value = 0
  3. 线程 A 写入 value = 1
  4. 线程 B 写入 value = 1(本应是 2,但结果错误!)。

update 能避免这个问题:

_seatLevel.update { current -> current + 1 } // 线程安全

5. 原子性的直观体现

从代码中可以看出原子性的关键点:

  1. val prevValue = value:读取当前值(可能被其他线程修改)。
  2. val nextValue = function(prevValue):基于当前值计算新值。
  3. if (compareAndSet(prevValue, nextValue))
    • 只有 value 仍等于 prevValue 时才会更新。
    • 如果失败(说明其他线程已修改),则 重试,确保最终更新是基于最新值。

6. 类似机制的对比

  • Java 的 AtomicInteger
    atomicInt.updateAndGet(x -> x + 1); // 同样基于 CAS
    
  • 数据库的乐观锁
    UPDATE table SET value = newValue WHERE value = oldValue; -- 类似 CAS
    

总结

这段代码的原子性由以下两点保证:

  1. compareAndSet 的原子性:确保比较和更新的操作不可分割。
  2. 循环重试机制:确保并发冲突时最终能成功更新。

因此,update { ... } 是线程安全的,适合在多线程环境下使用,而直接 value = newValue 不是。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/diannao/81971.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

开发搭载OneNet平台的物联网数据收发APP的设计与实现

一、开发环境与工具准备 工具安装 下载HBuilderX开发版(推荐使用开发版以避免插件兼容性问题)安装Node.js和npm(用于依赖管理及打包)配置Android Studio(本地打包需集成离线SDK)项目初始化 创建uni-app项目,选择“默认模板”或“空白模板”安装必要的UI库(如uView或Van…

HHsuite3 的 HHblits 和 HHsearch比较

HHblits 与 HHsearch 的核心区别及远源同源检测能力对比 一、核心功能与定位差异 特征HHblitsHHsearch核心目标快速迭代搜索,构建高质量多序列比对(MSA)和 Profile HMM,用于大规模序列聚类与初步同源筛选。高精度 Profile HMM-HMM 比对,用于深度同源检测与结构 / 功能预测…

【从零开始学习RabbitMQ | 第二篇】生成交换机到MQ的可靠性保障

目录 ​编辑前言 交换机 Direct交换机与Fanout交换机的差异 Topic交换机 Topic交换机相比Direct交换机的差异 生成我们的交换机&#xff0c;队列&#xff0c;以及绑定关系 基于代码去生成交换机和队列 基于注解去声明队列和交换机 消息转换器 消息队列的高可靠性 发送…

LeetCode 热题 100 22. 括号生成

LeetCode 热题 100 | 22. 括号生成 大家好&#xff0c;今天我们来解决一道经典的算法题——括号生成。这道题在 LeetCode 上被标记为中等难度&#xff0c;要求生成所有可能的并且有效的括号组合。这是一道非常经典的回溯法题目&#xff0c;非常适合用来练习递归和回溯的技巧。…

TestStand API 简介

TestStand API 简介 在自动化测试领域&#xff0c;TestStand 凭借其灵活的架构和强大的功能&#xff0c;成为众多开发者的首选工具。而 TestStand API&#xff08;Application Programming Interface&#xff0c;应用程序编程接口&#xff09;则是打开 TestStand 强大功能的 “…

如何修改 JAR 包中的源码

如何修改 JAR 包中的源码 前言一、准备工作二、将 JAR 当作 ZIP 打开并提取三、重写 Java 类方法 A&#xff1a;直接替换已编译的 .class方法 B&#xff1a;运行时类路径优先加载 四、修改 MyBatis&#xff08;或其他&#xff09;XML 资源五、重新打包 JAR&#xff08;命令行&a…

存算一体架构下的新型AI加速范式:从Samsung HBM-PIM看近内存计算趋势

引言&#xff1a;突破"内存墙"的物理革命 冯诺依曼架构的"存储-计算分离"设计正面临根本性挑战——在GPT-4等万亿参数模型中&#xff0c;数据搬运能耗已达计算本身的200倍。存算一体&#xff08;Processing-In-Memory, PIM&#xff09;技术通过‌在存储介…

蓝桥杯15届国赛 合法密码

问题描述 小蓝正在开发自己的 OJ 网站。他要求网站用户的密码必须符合以下条件&#xff1a; 长度大于等于 8 个字符&#xff0c;小于等于 16 个字符。必须包含至少 1 个数字字符和至少 1 个符号字符。 例如 **lanqiao2024!、-*/0601、8((>w<))8** 都是合法的密码。 而…

Jenkins忘记admin密码后的恢复步骤

提示&#xff1a;文章写完后&#xff0c;目录可以自动生成&#xff0c;如何生成可参考右边的帮助文档 文章目录 前言一、pandas是什么&#xff1f;二、使用步骤 1.引入库2.读入数据 总结 前言 提示&#xff1a;这里可以添加本文要记录的大概内容&#xff1a; 时间较长没有使用…

C++ - 仿 RabbitMQ 实现消息队列(1)(环境搭建)

C - 仿 RabbitMQ 实现消息队列&#xff08;1&#xff09;&#xff08;环境搭建&#xff09; 什么是消息队列核心特点核心组件工作原理常见消息队列实现应用场景优缺点 项目配置开发环境技术选型 更换软件源安装一些工具安装epel 软件源安装 lrzsz 传输工具安装git安装 cmake安装…

简单面试提问

Nosql非关系型数据库&#xff1a; Mongodb&#xff1a;开源、json形式储存、c编写 Redis&#xff1a;key-value形式储存&#xff0c;储存在内存&#xff0c;c编写 关系型数据库&#xff1a; sqlite;&#xff1a;轻量型、0配置、磁盘存储、支持多种语言 mysql&#xff1a;开源…

油气地震资料信号处理中的NMO(正常时差校正)

油气地震资料信号处理中的NMO&#xff08;正常时差校正&#xff09;介绍与应用 NMO基本概念 **正常时差校正&#xff08;Normal Moveout Correction&#xff0c;NMO&#xff09;**是地震资料处理中的一项关键技术&#xff0c;主要用于消除由于炮检距&#xff08;source-recei…

深度解析:从 GPT-4o“谄媚”到 Deepseek“物理腔”,透视大模型行为模式的底层逻辑与挑战

深度解析&#xff1a;从 GPT-4o“谄媚”到 AI“物理腔”&#xff0c;透视大模型行为模式的底层逻辑与挑战 标签&#xff1a;人工智能, GPT-4o, 大语言模型, AI伦理, 人机交互, 技术思考 大家好&#xff01;最近AI圈最火的“瓜”之一&#xff0c;莫过于OpenAI的GPT-4o模型在一…

Java引用RabbitMQ快速入门

这里写目录 Java发送消息给MQ消费者接收消息实现一个队列绑定多个消费者消息推送限制 Fanout交换机路由的作用Direct交换机使用案例 Java发送消息给MQ public void testSendMessage() throws IOException, TimeoutException {// 1.建立连接ConnectionFactory factory new Conn…

从读写分离到分布式服务:系统架构演进十阶段深度解析

第一阶段到第四阶段&#xff1a;架构进化四阶段&#xff1a;探索单体到集群的高可用性能优化之道-CSDN博客https://blog.csdn.net/pinbodeshaonian/article/details/147464084?spm1001.2014.3001.5502 以下是对从第五阶段到第十阶段详细的解释&#xff1a; 第五阶段&#xf…

Webug4.0靶场通关笔记07- 第9关反射XSS和第10关存储XSS

目录 第09关 反射型XSS 1.打开靶场 2.源码分析 3.渗透实战 第10关 存储型XSS 1.打开靶场 2.源码分析 3.渗透实战 本系列为通过《Webug4.0靶场通关笔记》的渗透集合&#xff0c;本文为反射型和存储型XSS漏洞关卡的渗透部分&#xff0c;通过对XSS关卡源码的代码审计找到漏…

Prometheus的安装部署

目录 一、概述 二、Prometheus的安装 1、二进制方式 1.1、下载系统安装包​编辑 1.2、解压 1.3、创建数据目录&#xff0c;服务运行用户 1.4、设置为系统服务&#xff08;创建服务运行脚本&#xff09; 1.5、启动服务&#xff0c;并通过浏览器访问验证 2、容器方式 2…

Jupyter Notebook为什么适合数据分析?

Jupyter Notebook 是一款超实用的 Web 应用程序&#xff0c;在数据科学、编程等诸多领域都发挥着重要作用。它最大的特点就是能让大家轻松创建和共享文学化程序文档。这里说的文学化程序文档&#xff0c;简单来讲&#xff0c;就是把代码、解释说明、数学公式以及数据可视化结果…

Python清空Word段落样式的方法

在 Python 中&#xff0c;你可以使用 python-docx 库来操作 Word 文档&#xff0c;包括清空段落样式。以下是几种清空段落样式的方法&#xff1a; 方法一&#xff1a;直接设置段落样式为"Normal" from docx import Documentdoc Document(your_document.docx) # 打…

macOS 上是否有类似 WinRAR 的压缩软件?

对于习惯使用 Windows 的用户来说&#xff0c;WinRAR 是经典的压缩/解压工具&#xff0c;但 macOS 系统原生并不支持 RAR 格式的解压&#xff0c;更无法直接使用 WinRAR。不过&#xff0c;macOS 平台上有许多功能相似甚至更强大的替代工具&#xff0c;以下是一些推荐&#xff1…