一个案例让你秒懂kotlin flow原理

前言

都2023年了,Kotlin协程和Flow大家都用的很熟了吧。Kotlin Flow 的主要作用是简化异步数据处理的开发,提高代码的可读性和可维护性,并提高应用程序的性能和效率。

看一个demo,然后思考2个问题

runBlocking {
        flow {
            println("wait exe emit 1")
            emit(1)
            println("wait exe emit 2")
            emit(2)
        }.collect {
            println("collect value : $it")
        }
    }

执行结果

wait exe emit 1
collect value : 1
wait exe emit 2
collect value : 2

从打印结果可以看出,flow代码块中的emit方法和collect代码块中的print是交替执行的。另外,如果不调用collect方法,是没有任何打印的。

再来看一个改造的demo

runBlocking {
         flow {
            emit(1)
            emit(2)
        }.collect(object :FlowCollector<Int>{
            override suspend fun emit(value: Int) {
                println(value)
            }
        })
    }

demo2和demo1从执行结果来看是一样的,区别是把collect方法从lambda变成了接口实现的方式。

接下来,我们就思考并解决如下问题

  • flow,collect的执行顺序为什么是这样的?
  • 为什么必须调用collect方法才能执行flow代码块?

源码解析

Flow对象的创建

flow{ }的实现

//Creates a _cold_ flow from the given suspendable [block].
public fun <T> flow(@BuilderInference block: suspend 
FlowCollector<T>.() -> Unit): Flow<T> = SafeFlow(block)

可以看到flow()里面需要传入了FlowCollector的扩展方法,同时会返回一个Flow对象,Flow就是个接口。

这个FlowCollector接口是不是很熟悉,上面demo2中collect参数就是它。

public interface FlowCollector<in T> {

    /**
     * Collects the value emitted by the upstream.
     * This method is not thread-safe and should not be invoked concurrently.
     */
    public suspend fun emit(value: T)
}

这个接口的作用是:下游收集上游发出的值

再来看下Flow接口

public interface Flow<out T> {
    /**
     * Accepts the given [collector] and [emits][FlowCollector.emit] values into it.
     * This method should never be implemented or used directly.
     *
     * The only way to implement the `Flow` interface directly is to extend [AbstractFlow].
     * To collect it into a specific collector, either `collector.emitAll(flow)` or `collect { ... }` extension
     * should be used. Such limitation ensures that the context preservation property is not violated and prevents most
     * of the developer mistakes related to concurrency, inconsistent flow dispatchers and cancellation.
     */
    @InternalCoroutinesApi
    public suspend fun collect(collector: FlowCollector<T>)
}

它只有一个collect方法,作用是:收集上游emit方法发射的数据

大家先记住这2个接口,后面流程都是围绕这2个接口来完成的。

上面flow方法源码提到了,会创建一个SafeFlow对象

private class SafeFlow<T>(private val block: suspend FlowCollector<T>.() -> Unit) : AbstractFlow<T>() {
    override suspend fun collectSafely(collector: FlowCollector<T>) {
//3.调用block
        collector.block()
    }
}

public abstract class AbstractFlow<T> : Flow<T>, CancellableFlow<T> {

    @InternalCoroutinesApi
//1.调用collect方法
    public final override suspend fun collect(collector: FlowCollector<T>) {
        val safeCollector = SafeCollector(collector, coroutineContext)
        try {
//2.调用抽象方法collectSafely
            collectSafely(safeCollector)
        } finally {
            safeCollector.releaseIntercepted()
        }
    }


    public abstract suspend fun collectSafely(collector: FlowCollector<T>)
}

这段代码就是我们理清楚文章开头提出的2个疑问的关键所在,下面分析下。

demo中的flow{ }.collect{ }可以拆成2部分,先创建SafeFlow对象,它是继承了AbstractFlow这个抽象类,然后调用它的collect方法,关键流程就是上面注释中的3个步骤。

可以看出最后是调用了block(),那这个block又是哪里来的呢?还记得flow{ }的实现吗?

public fun <T> flow(@BuilderInference block: suspend 
FlowCollector<T>.() -> Unit): Flow<T> = SafeFlow(block)

这个block就是flow方法的参数这个block啊,它是FlowCollector的一个扩展函数,这个block其实就是我们flow { }大括号中的代码块啊,这个就是一个lambda表达式的语法而已。

所以,调用collect方法,最终是执行了flow { }中的代码块。现在能理解为什么必须要调用collect这个收集方法才能触发上游的数据发射了吧,这也解释了为什么flow{}是冷流,因为必须要有收集者才能触发上游的数据发射。

flow { }代码块中每次调用emit方法,会执行到collect{ }中的代码块,实际上就是执行的FlowCollector这个接口的emit方法啊,只不过collect{ }用了lambda来简化而已。

用一张图来总结


image.png
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,716评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,558评论 1 294
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 109,431评论 0 244
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,127评论 0 209
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,511评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,692评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,915评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,664评论 0 202
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,412评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,616评论 2 245
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,105评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,424评论 2 254
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,098评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,096评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,869评论 0 197
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,748评论 2 276
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,641评论 2 271

推荐阅读更多精彩内容