暂停直到 StateFlow 达到所需状态之一并返回结果

Question

考虑一个密封的 class 状态。

sealed class State {
    object Unknown : State()
    object Loading : State()
    object Success : State()
    data class Failure(val exception: Exception)
}

我有一个状态流，消费者可以在其中主动收听状态更新。

val state:State = MutableStateFlow(State.Unknown)

现在，我也想有一个简单的挂起方法，等待状态达到成功或失败，这样只需要一次结果的消费者就不需要知道状态流了。

如何实现？

Answer 1

我能够想出以下扩展功能，看起来工作正常。

suspend fun waitForResult(): State  {
    val resultStates = setOf(State.Success::class, State.Failure::class)
    return state.waitForStates(resultStates)
}

suspend fun <T : Any> StateFlow<T>.waitForStates(states: Set<KClass<out T>>): T = coroutineScope {
    var currentValue = value

    // not needed for correctness, just an optimisation
    if (currentValue::class in states) {
        return currentValue
    }

    coroutineScope {
        collect {
            if (it::class in states) {
                currentValue = it
                cancel()
            }
        }
    }

    return currentValue
}

Answer 2

虽然您已经想出了一个可行的解决方案，但为了简单起见，您可能希望使用内置的 Flow.first { ... } 运算符。

suspend fun waitForResult(): State  {
    val resultStates = setOf(State.Success::class, State.Failure::class)
    return state.first { it::class in resultStates }
}

暂停直到 StateFlow 达到所需状态之一并返回结果

Suspending until StateFlow reaches one of the desired states and returning the result

generics

kotlin

kotlin-coroutines

kotlin-stateflow