前言
在最近的三篇中,标题都是 ***** 看这一篇就够了,而这篇关于Flow的,我认怂了,只能说 看这一篇 带你入门~,因为我发现Flow牵扯的东西实在是太多了,就像RxJava别说两篇 可能五篇也是说不完的。
为什么需要Flow
首先我们来回顾下Kotlin中我们如何使用挂起函数,我们在main方法中,调用挂起函数返回一组数据,代码如下所示:
suspend fun loadData(): List<Int> { delay(1000) return listOf(1, 2, 3) } fun main() { runBlocking { loadData().forEach { value -> println(value) } } }
运行main函数,结果为 1s后 输出1 2 3
那么我们想一下,如果loadData中的数据集合,并不是一起返回的,比如从网络中先获取到了1 在获取到了2 最后再获取到了3 ,那么这样如果我们仍然在返回最后一个结果(其实也不知道)时一并返回数据,会造成资源浪费并且用户体验不好,那么我们如何解决这个问题呢?
上面挂起函数的返回类型是List类型,那么就必定只能一次性返回数据,此时,Flow就出场了~
Flow的基础使用
构建器
我们改写loadData方法,返回类型修改为Flow<Int> ,并构造一个flow,在flow中 每隔一秒,发送一个数据用来模拟延迟获取值,代码如下所示:
fun loadData() = flow { for (i in 1..3) { delay(1000) emit(i) } } fun main() { runBlocking { loadData1().collect { println(it) } } }
运行结果即是,每隔1秒钟,打印出来一个数字,emit 方法用于发射值,collect方法是收集值,这里需要注意的是,我们可以看到 在main方法协程中,我们可以直接调用loadData的方法,这是因为flow构建块中的代码 就是一个suspend函数。这样一来我们就实现了对数据的逐步加载,而不需要等待所有的数据返回。
接下来我们在main方法中调用多次loadData方法而不调用collect,看会有什么现象。修改代码如下所示:
fun loadData1() = flow { println("进入加载数据的方法") for (i in 1..3) { delay(1000) emit(i) } } fun main() { runBlocking { println("第一次准备调用加载数据的方法") var data = loadData1() println("第二次准备调用加载数据的方法") var data2 = loadData1() data2.collect { println(it) } } }
然后我们运行main方法,打印结果如下所示:
第一次准备调用加载数据的方法 第二次准备调用加载数据的方法 进入加载数据的方法 1 2 3 Process finished with exit code 0
我们会发现,如果我们没有调用flow的collect方法,其实不会进入flow的代码块中,也就是说 Flow中的代码直到被collect调用的时候才会运行,否则会立即返回。
Flow的取消
如果我们需要定时取消Flow中代码块的执行,只需要使用withTimeoutOrNull函数添加超时时间即可,比如上述方法我们是在三秒内返回123,我们限定其在2500毫秒内执行完毕
fun main() { runBlocking { withTimeoutOrNull(2500){ loadData1().collect { println(it) } } } }
我们运行main方法,则只有1 2 两个数字进行了打印
1 2 Process finished with exit code 0
Flow的操作符
类似集合的函数是Api,Flow中也有许多操作符,这里我们简单举几个例子:
map
使用map我们可以将最终结果映射为其他类型,代码如下所示:
fun changeData(value: Int): String { return "打印的结果是:${value}" } fun main() { runBlocking { loadData1().map { changeData(it) }.collect{ println(it) } } }
我们通过map操作符将结果映射为字符串的形式,运行main 打印结果如下所示:
打印的结果是:1 打印的结果是:2 打印的结果是:3 Process finished with exit code 0
filter操作符
通过filter 我们可以对结果集添加过滤条件,如下所示,我们仅打印出大于1的值
runBlocking { loadData1().filter { it > 1 }.collect { println(it) } }
故 打印结果如下所示:
2 3 Process finished with exit code 0
所有的操作符都是可以一起使用的,并非只能单独使用。
我们上面调用的collect是末端操作符,在Flow中除了collect之外 还有toList、reduce、fold等操作符。
toList操作符我们可以很明显的知道意为转换为list集合,而reduce 和 fold 则可将最终的值转为单一的值。
fun main() { runBlocking { var data = loadData1().reduce { a, b -> a + b } println(data) } }
如上代码,我们将Flow的每个结果最终求和,打印结果如下所示:
6 Process finished with exit code 0
flowOn
Flow的代码块是执行在执行时的上下文中,比如 我们不能通过在flow中指定线程来运行Flow代码中的代码,如下所示:
fun loadData1() = flow { withContext(Dispatchers.Default){ for (i in 1..3) { delay(1000) emit(i) } } } fun main() { runBlocking { loadData1().collect { value -> println("Collected $value") } } }
此种运行方式,将会抛出异常
Exception in thread "main" java.lang.IllegalStateException: Module with the Main dispatcher had failed to initialize. For tests Dispatchers.setMain from kotlinx-coroutines-test module can be used at kotlinx.coroutines.internal.MissingMainCoroutineDispatcher.missing(MainDispatchers.kt:113) ... ...
那么我们如何指定Flow代码块中的上下文呢,我们需要使用flowOn操作符,我们将Flow代码块中的代码指定在IO线程中,代码如下所示:
fun loadData1() = flow { for (i in 1..3) { delay(1000) emit(i) } }.flowOn(Dispatchers.IO)
这样我们就把Flow代码块中的事情放到了IO线程中。
buffer操作符
我们在Kotlin 协程 看这一篇就够了 中曾了解过,协程可以提升并发请求的效率,而在Flow代码块中,每当有一个处理结果 我们就可以收到,但如果处理结果也是耗时操作,我们来看下需要多长时间来处理,我们在打印前间隔两秒,并记录开始和完成的时间,代码如下所示:
var startTime: Long = 0 var endTime: Long = 0 fun loadData1() = flow { startTime = System.currentTimeMillis() / 1000 for (i in 1..3) { delay(1000) emit(i) } } fun main() { runBlocking { loadData1().collect { value -> delay(2000) println("$value") } endTime = System.currentTimeMillis() / 1000 println("处理时间:${endTime - startTime}s") } }
运行main方法得到结果如下:
1 2 3 处理时间:9s Process finished with exit code 0
我们可以看到,处理三个数据,一共使用了9秒钟的时间。
buffer操作符可以使发射和收集的代码并发运行,从而提高效率,我们添加buffer代码如下所示:
fun main() { runBlocking { loadData1().buffer().collect { value -> delay(2000) println("$value") } endTime = System.currentTimeMillis() / 1000 println("处理时间:${endTime - startTime}s") } }
再次运行main方法,结果如下所示:
1 2 3 处理时间:8s Process finished with exit code 0
由此看出,时间较少了接近1s(/1000为近似值),不要小看这小小的1秒,运行在手机上还是相当重要的~
zip操作符
zip操作符,可以合并两个flow,代码如下所示:
fun loadData1() = flow { for (i in 1..3) { delay(1000) emit("我是j:${i}") } } fun loadData2() = flow { for (i in 1..3) { delay(1000) emit("我是i:${i}") } } fun main() { runBlocking { loadData2().zip(loadData1()){ a,b -> "$a,$b" }.collect{ println(it) } } }
运行结果如下所示:
我是i:1,我是j:1 我是i:2,我是j:2 我是i:3,我是j:3 Process finished with exit code 0
除此之外,Flow还有Combine、flatMapConcat、flatMapMerge等操作符,这里就不再一一讲解了。
看了这么多,是否对Flow有所基本的了解了呢~
Flow 在 实际项目中的使用
未完待续,敬请期待。