Kotlin StateFlow 源码解析

前言

在之前的文章已经分析了SharedFlow原理,在这个基础上再来分析StateFlow就简单多了。Kotlin SharedFlow 源码解析

StateFlow使用与特性分析

如下代码,创建了一个StateFlow对象,必须有个初始值,这里设置为1。发射了3条数据,但是收集者只收到value为3的这条数据。

  runBlocking {
        val stateFlow = MutableStateFlow(1)
        stateFlow.value = 2
        stateFlow.value = 3
        stateFlow.value = 3

        launch {
            stateFlow.collect {
                delay(3000)
                print("collect2 :$it")
            }
        }
    }

StateFlow最新的收集者只能收到最新的1条数据;如果数据相同,不会收到重复的数据。StateFlow可以看作如下定义的ShareFlow。

 MutableSharedFlow<Int>(replay = 1, extraBufferCapacity = 0, onBufferOverflow = BufferOverflow.DROP_OLDEST)

StateFlow源码分析

初始化

public fun <T> MutableStateFlow(value: T): MutableStateFlow<T> = StateFlowImpl(value ?: NULL)

StateFlow并没有像SharedFlow那样采用缓存数组,只是用atomic引用类型的状态值,来保存最新的值。

private class StateFlowImpl<T>(
    initialState: Any 
) : AbstractSharedFlow<StateFlowSlot>(), MutableStateFlow<T>, CancellableFlow<T>, FusibleFlow<T> {
    private val _state = atomic(initialState) // 保存状态值
    private var sequence = 0 // 状态值更新的序列号

    @Suppress("UNCHECKED_CAST")
    public override var value: T
        get() = NULL.unbox(_state.value)
        set(value) { updateState(null, value ?: NULL) } //CAS方式更新数据

    override fun compareAndSet(expect: T, update: T): Boolean =
        updateState(expect ?: NULL, update ?: NULL)
} 

在StateFlow中一般有3种方式发射数据,emitsetValue,compareAndSet,但是无论哪种方式最终都是调用updateState方法,所以我们直接看这个方法就好。

发射数据

 private fun updateState(expectedState: Any?, newState: Any): Boolean {
        var curSequence = 0
        var curSlots: Array<StateFlowSlot?>? = this.slots // benign race, we will not use it
        synchronized(this) {
            val oldState = _state.value
          //看过CAS原理的同学能很好理解这句话的意思,内存值和预期值不同,直接返回false;说明是线程安全的,内存值和预期值相同,才会更新数据
            if (expectedState != null && oldState != expectedState) return false // CAS support
          //如果2次发射的值相同,则丢弃,也就是做了防抖
            if (oldState == newState) return true // Don't do anything if value is not changing, but CAS -> true
          //CAS方式更新值
            _state.value = newState

            curSequence = sequence
          //状态更新序号变为偶数
            if (curSequence and 1 == 0) { // even sequence means quiescent state flow (no ongoing update)
                curSequence++ // +1,变成基数
                sequence = curSequence
            } else {
                // 序号是奇数,说明该值已经更新过,立即返回
                sequence = curSequence + 2 // +2,可以保持继续奇数
                return true // updated
            }
            curSlots = slots // read current reference to collectors under lock
        }

这里大家暂时只需要关心2件事情,StateFlow通过CAS的方式保存和更新数据;如果前后2次发射的数据相同,会丢弃后一次,也就是说相同数据的发射,做了防抖过滤。

收集数据

 override suspend fun collect(collector: FlowCollector<T>) {
        val slot = allocateSlot() //分配槽位,和ShareFlow是一样的
        try {
            if (collector is SubscribedFlowCollector) collector.onSubscription()
            val collectorJob = currentCoroutineContext()[Job]
            var oldState: Any? = null 
            // 也是和ShareFlow一样的方式,开启了一个死循环获取数据
            while (true) {
                val newState = _state.value
                //  check协程是否取消
                collectorJob?.ensureActive()
                // 空安全检查,如果前后2次发射数据不同,就会调用FlowCollector的emit方法,
                //也就是会执行到collect{ }中的代码块
                if (oldState == null || oldState != newState) {
                    collector.emit(NULL.unbox(newState))
                    oldState = newState
                }
               
                  // 修改状态,如果之前不是PENGDING状态
                 if (!slot.takePending()) {
                      // 则挂起等待新数据更新
                      slot.awaitPending()
                }

            }
        } finally {
          // 释放已分配的StateFlowSlot类型的对象
            freeSlot(slot)
        }
    }

这个方法,我们暂时也不需要关注太多。只需要知道也是和ShareFlow一样,开启了死循环来获取数据,数据的获取就是前面通过atomic定义的_state,所以state数据的收发都是通过CAS完成的。获取到数据之后,会调用FlowCollectoremit方法,也就是会执行到collect{ }中的代码块,这一点在之前文章介绍过。一个案例让你秒懂kotlin flow原理

收集者(订阅者)的管理

同ShareFlow,StateFlow也是用到了AbstractSharedFlow类,因此二者订阅者管理的逻辑大致相同。区别是ShareFlow订阅者数组中存储的对象类为SharedFlowSlot,而StateFlow中存储的对象为StateFlowSlot

private val NONE = Symbol("NONE")

@SharedImmutable
private val PENDING = Symbol("PENDING")

// StateFlow 的每一个收集者都会分配一个卡槽
private class StateFlowSlot : AbstractSharedFlowSlot<StateFlowImpl<*>>() {
     //用于存储StateFlowSlot的状态,一共有4个这状态,初始值为null
    private val _state = atomic<Any?>(null)

    override fun allocateLocked(flow: StateFlowImpl<*>): Boolean {
        // 如果_state的值不为null,表示槽位已被占用
        if (_state.value != null) return false // not free
      //_state的值为null,表示槽位可用,将_state的值设置为NONE,表示已被分配
        _state.value = NONE // allocated
        return true
    }

    override fun freeLocked(flow: StateFlowImpl<*>): Array<Continuation<Unit>?> {
        //释放槽位
        //将_state的值设置为null,表示槽位现在可用。返回一个空的Continuation数组,表示没有更多的操作需要执行
        _state.value = null // free now
        return EMPTY_RESUMES // nothing more to do
    }

StateFlowSlot类型的对象共有四种状态:

  • null:表示已经空闲释放,可以分配给消费者收集器

  • NONE: 表示已经分配给消费者接收器,但既没有挂起,也没有在处理当前的数据。

  • PENDING:表示表示上游已更新新值,待发送给收集器。

  • CancellableContinuationImpl<Unit>:表示收集器已挂起在等待上游数据

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

推荐阅读更多精彩内容