使用Dispatchers.Main.immediate时StateFlow测试不发射值的问题

问题场景 #

ViewModel中通过viewModelScope.launch更新MutableStateFlow的值，但在测试代码里只能收集到初始值，无法获取后续更新。只有在业务代码的launch块中添加yield()或delay()，测试才能拿到新值；换成MutableSharedFlow也能缓解该问题。使用环境：Kotlin 1.9.10，协程核心及测试库1.8.1。

为什么yield()/delay()能解决问题？ #

这本质是协程调度优先级的问题：

• 测试用的runTest默认使用TestDispatcher，它是单线程调度器，所有协程任务都在同一个线程队列里执行。
• 测试代码中如果直接在主协程里调用stateFlow.collect，这个挂起函数会一直占用线程（因为StateFlow是热流，收集不会自动结束），导致viewModelScope.launch里的更新任务被卡在队列中，根本没机会执行。
• yield()或delay()会让当前正在执行的收集协程主动暂停，释放线程给队列里的其他任务（也就是launch里的更新代码），这样StateFlow的新值就能被发射出去，收集协程恢复后就能拿到新值。

不依赖yield()/delay()的解决方案 #

1. 使用advanceUntilIdle()触发所有待执行协程 #

runTest提供的advanceUntilIdle()方法会让TestDispatcher执行完队列中所有待处理的协程任务，直到没有活跃任务。同时要注意：不要在runTest的主协程中直接调用collect，因为collect会阻塞线程，需要把收集逻辑放到单独的launch协程里：

// ViewModel代码
class TestViewModel : ViewModel() {
    val stateFlow = MutableStateFlow("initial")

    fun updateState() {
        viewModelScope.launch {
            stateFlow.value = "updated"
        }
    }
}

// 测试代码
@Test
fun testStateFlowUpdate() = runTest {
    val viewModel = TestViewModel()
    val collectedValues = mutableListOf<String>()
    
    // 将collect放到单独的launch，避免阻塞主测试协程
    launch {
        viewModel.stateFlow.collect {
            collectedValues.add(it)
        }
    }
    
    viewModel.updateState()
    advanceUntilIdle() // 执行所有待处理的协程任务
    
    assert(collectedValues == listOf("initial", "updated"))
}

2. 给ViewModel注入测试调度器 #

通过依赖注入的方式给ViewModel指定调度器，测试时传入TestDispatcher，这样可以更精准地控制协程执行时机：

// 改造后的ViewModel，支持注入调度器
class TestViewModel(private val dispatcher: CoroutineDispatcher = Dispatchers.Main) : ViewModel() {
    val stateFlow = MutableStateFlow("initial")

    fun updateState() {
        viewModelScope.launch(dispatcher) {
            stateFlow.value = "updated"
        }
    }
}

// 测试代码
@Test
fun testStateFlowUpdate() = runTest {
    val testDispatcher = UnconfinedTestDispatcher(testScheduler)
    val viewModel = TestViewModel(testDispatcher)
    val collectedValues = mutableListOf<String>()
    
    launch {
        viewModel.stateFlow.collect {
            collectedValues.add(it)
        }
    }
    
    viewModel.updateState()
    advanceUntilIdle()
    
    assert(collectedValues == listOf("initial", "updated"))
}

关于MutableSharedFlow的“缓解”效果 #

SharedFlow能缓解问题并非它本身解决了调度问题，而是因为默认的MutableSharedFlow(replay = 0)不会缓存值，当emit新值时，如果此时收集协程刚好被调度到（比如测试中collect在单独协程），就能拿到值。但这只是巧合，核心问题还是协程调度，所以不要依赖SharedFlow来规避测试问题，还是要通过正确的调度控制来解决。

内容的提问来源于stack exchange，提问作者nepa