ViewModel中的StateFlow和SharedFlow，使用建议以及单元测试

最新推荐文章于 2024-08-23 14:43:00 发布

别说我真不会Android

最新推荐文章于 2024-08-23 14:43:00 发布

阅读量339

点赞数

本文链接：https://blog.csdn.net/Maniu_666/article/details/129937653

版权

本文探讨了在ViewModel中使用StateFlow和SharedFlow的选择，并给出了业务场景下的建议。强调在ViewModel中应暴露热流以避免资源浪费。文章还详细介绍了如何在Compose中收集流以及单元测试StateFlow和SharedFlow的方法，包括使用Turbine库测试SharedFlow。

摘要由CSDN通过智能技术生成

StateFlow和SharedFlow都是kotlin中的数据流，官方概念简介如下：

StateFlow：一个状态容器式可观察数据流，可以向其收集器发出当前状态和新状态。是热数据流。

SharedFlow：SharedFlow是StateFlow的可配置性极高的泛化数据流（StateFlow继承于SharedFlow）

对于两者的基本使用以及区别，此处不做详解，可以参考官方文档。本文会给出一些关于如何在业务中选择选择合适热流(hot flow)的建议，以及单元测试代码。

StateFlow的一般用法如下图所示：

以读取数据库数据为例，Repository负责从数据库读取相应数据并返回一个flow，在ViewModel收集这个flow中的数据并更新状态(StateFlow)，在MVVM模型中，ViewModel中暴露出来的StateFlow应该是UI层中唯一的可信数据来源，注意是唯一，这点跟使用LiveData的时候不同。

我们应该在ViewModel中暴露出热流(StateFlow或者SharedFlow)而不是冷流(Flow)

如果我们如果暴露出的是普通的冷流，会导致每次有新的流收集者时就会触发一次emit，造成资源浪费。所以如果Repository提供的只有简单的冷流怎么办？很简单，将之转换成热流就好了！通常可以采用以下两种方式：

1、还是正常收集冷流，收集到一个数据就往另外构建的StateFlow或SharedFlow发送

2、使用stateIn或shareIn拓展函数转换成热流

既然官方给我们提供了拓展函数，那肯定是直接使用这个方案最好，使用方式如下：

private const val DEFAULT_TIMEOUT = 500L

@HiltViewModel
class MyViewModel @Inject constructor(
    userRepository: UserRepository
): ViewModel() {
   

    val userFlow: StateFlow<UiState> = userRepository
        .getUsers()
        .asResult() // 此处返回Flow<Result<User>>
        .map {
    result ->
            when(result) {
   
                is Result.Loading -> UiState.Loading

                is Result.Success -> UiState.Success(result.data)

                is Result.Error -> UiState.Error(result.exception)
            }
        }
        .stateIn(
            scope = viewModelScope,
            initialValue = UiState.Loading,
            started = SharingStarted.WhileSubscribed(DEFAULT_TIMEOUT) 
        )
        // started参数保证了当配置改变时不会重新触发订阅
}