Kotlin - Flow 中创建流的方式

1. flow

• 描述: 创建一个冷流，从给定的 suspendable block 中生成值。冷流意味着每次应用终端操作时，block 会被调用。
• 使用场景: 适用于自定义流的生成。

fun fibonacci(): Flow<BigInteger> = flow {
    var x = BigInteger.ZERO
    var y = BigInteger.ONE
    while (true) {
        emit(x)
        val temp = x
        x = y
        y += temp
    }
}

// 使用
fibonacci().take(10).collect { println(it) }

2. asFlow (无参)

• 描述: 将一个函数转换为产生单个值的冷流。
• 使用场景: 适用于将普通函数转换为流。

val singleValueFlow = { 42 }.asFlow()

// 使用
singleValueFlow.collect { println(it) } // 输出: 42

3. asFlow (带 suspend)

• 描述: 将一个 suspend 函数转换为产生单个值的冷流。
• 使用场景: 适用于将 suspend 函数转换为流。

suspend fun remoteCall(): String = "Hello, World!"

fun remoteCallFlow(): Flow<String> = ::remoteCall.asFlow()

// 使用
remoteCallFlow().collect { println(it) } // 输出: Hello, World!

4. Iterable.asFlow

• 描述: 从给定的可迭代对象创建一个冷流。
• 使用场景: 适用于将集合转换为流。

val listFlow = listOf(1, 2, 3).asFlow()

// 使用
listFlow.collect { println(it) } // 输出: 1, 2, 3

5. Iterator.asFlow

• 描述: 从给定的迭代器创建一个冷流。
• 使用场景: 适用于将迭代器转换为流。

val iteratorFlow = listOf(1, 2, 3).iterator().asFlow()

// 使用
iteratorFlow.collect { println(it) } // 输出: 1, 2, 3

6. Sequence.asFlow

• 描述: 从给定的序列创建一个冷流。
• 使用场景: 适用于将序列转换为流。

val sequenceFlow = sequenceOf(1, 2, 3).asFlow()

// 使用
sequenceFlow.collect { println(it) } // 输出: 1, 2, 3

7. flowOf

• 描述: 创建一个流，产生指定的元素。
• 使用场景: 适用于快速生成多个值的流。

val flowOfNumbers = flowOf(1, 2, 3)

// 使用
flowOfNumbers.collect { println(it) } // 输出: 1, 2, 3

8. emptyFlow

• 描述: 返回一个空流。
• 使用场景: 适用于需要返回无元素的流的情况。

val empty = emptyFlow<Int>()

// 使用
empty.collect { println(it) } // 不会输出任何东西

9. Array.asFlow

• 描述: 从给定数组创建一个冷流。
• 使用场景: 适用于将数组转换为流。

val arrayFlow = arrayOf(1, 2, 3).asFlow()

// 使用
arrayFlow.collect { println(it) } // 输出: 1, 2, 3

10. IntArray.asFlow

• 描述: 从给定的整数数组创建一个冷流。
• 使用场景: 适用于将整数数组转换为流。

val intArrayFlow = intArrayOf(1, 2, 3).asFlow()

// 使用
intArrayFlow.collect { println(it) } // 输出: 1, 2, 3

11. LongArray.asFlow

• 描述: 从给定的长整型数组创建一个冷流。
• 使用场景: 适用于将长整型数组转换为流。

val longArrayFlow = longArrayOf(1L, 2L, 3L).asFlow()

// 使用
longArrayFlow.collect { println(it) } // 输出: 1, 2, 3

12. IntRange.asFlow

• 描述: 从给定的整数范围创建一个冷流。
• 使用场景: 适用于将范围转换为流。

val rangeFlow = (1..3).asFlow()

// 使用
rangeFlow.collect { println(it) } // 输出: 1, 2, 3

13. LongRange.asFlow

• 描述: 从给定的长整型范围创建一个冷流。
• 使用场景: 适用于将长整型范围转换为流。

val longRangeFlow = (1L..3L).asFlow()

// 使用
longRangeFlow.collect { println(it) } // 输出: 1, 2, 3

14. channelFlow

• 描述: 创建一个允许并发发送元素的冷流。可以使用 ProducerScope 发送元素。
• 使用场景: 适用于需要从多个协程并发发送数据的情况。

fun <T> channelFlowExample(): Flow<T> = channelFlow {
    launch {
        send("Hello")
    }
    launch {
        send("World")
    }
}

// 使用
channelFlowExample<String>().collect { println(it) } // 输出: Hello, World (顺序可能不同)

15. callbackFlow

• 描述: 创建一个冷流，允许从异步回调中发送元素。使用 ProducerScope 发送元素。
• 使用场景: 适用于将基于回调的 API 转换为流。

fun flowFromCallbackApi(api: CallbackBasedApi): Flow<String> = callbackFlow {
    val callback = object : Callback {
        override fun onNextValue(value: String) {
            trySend(value).isSuccess
        }

        override fun onCompleted() {
            close()
        }
    }
    api.register(callback)
    awaitClose { api.unregister(callback) }
}

// 使用
flowFromCallbackApi(myApi).collect { println(it) }

总结

这些函数提供了灵活的方式来创建流，适应各种场景，从简单的值到复杂的异步数据流。通过理解这些函数的使用，可以有效地处理异步数据。