一個案例讓你秒懂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閱讀 228,363評論 6 532
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,497評論 3 416
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,305評論 0 374
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,962評論 1 311
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,727評論 6 410
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,193評論 1 324
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,257評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,411評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,945評論 1 335
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,777評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,978評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,519評論 5 359
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,216評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,642評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,878評論 1 286
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,657評論 3 391
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,960評論 2 373

推薦閱讀更多精彩內容