Kotlin协程源码分析-5 状态机

港控/mmm° 2023-07-18 02:55 43阅读 0赞

上文链接：[Kotlin协程源码分析-4 状态机][Kotlin_-4]

在上文中最后一行 “挂起函数的`Continuation`对象如何才能获取？”。“如何返回一个挂起标识符`COROUTINE_SUSPENDED`”。本文将做就这两个问题详细介绍

### 获取挂起函数的`Continuation`对象 ###

你可以直接看`kotlin`协程库实现方式得到答案。这里直接给出答案。

suspend fun mySuspendOne() = suspendCoroutineUninterceptedOrReturn<String> {
         continuation ->
    	//传入的continuation就是SuspendLambda对象，也就是我们自己写一个lambda编译后的对象
        //启动一个线程。一秒后回调continuation函数
        thread {
        
            TimeUnit.SECONDS.sleep(1)
            logD("我将调用Continuation返回一个数据")
            //调用又会重新调用BaseContinuationImpl的resumeWith函数
            continuation.resume("hello world")
        }
    
        logD("mySuspendOne 函数返回")
        //因为我们这个函数没有返回正确结果，所以必须返回一个挂起标识,否则BaseContinuationImpl会认为完成了任务。 
        // 并且我们的线程又在运行没有取消，这将很多意想不到的结果
        kotlin.coroutines.intrinsics.COROUTINE_SUSPENDED
    }

上面的代码会在编译后变成如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70]

上面其实很危险，如果我们函数忘记写返回`COROUTINE_SUSPENDED`那么默认返回`Unit`，`BaseContinuationImpl`在`resumeWith`判断不是挂起标识，那么会认为完成了任务，此时会回调监听的完成的`Continuation`对象.这自然会引起很多意外的现象.  
`Kotlin`考虑到这种情况下推荐我们使用如下的方法获取当前`continuation`

suspend fun mySafeSuspendOne() = suspendCoroutine<String> {
         continuation ->
    
        //传入的continuation就是SuspendLambda对象，也就是我们自己写一个lambda编译后的对象
        //启动一个线程。一秒后回调continuation函数
        thread {
        
            TimeUnit.SECONDS.sleep(1)
            logD("我将调用Continuation返回一个数据")
            //调用又会重新调用BaseContinuationImpl的resumeWith函数
            continuation.resume("hello world")
        }
    
        logD("mySuspendOne 函数返回")
        //suspendCoroutine函数很聪明的帮我们判断返回结果如果不是想要的对象，自动返回kotlin.coroutines.intrinsics.COROUTINE_SUSPENDED
    }

我们简单看下`suspendCoroutine`实现

public suspend inline fun <T> suspendCoroutine(crossinline block: (Continuation<T>) -> Unit): T =
        suspendCoroutineUninterceptedOrReturn {
         c: Continuation<T> ->
        	//封装一个代理Continuation对象
            val safe = SafeContinuation(c.intercepted())
            block(safe)
            //根据block返回结果判断要不要返回COROUTINE_SUSPENDED
            safe.getOrThrow()
        }

这里先跳过`SafeContinuation`代理对象的分析。 简单理解就是帮你判断是不是要返回`COROUTINE_SUSPENDED`(当然这个`SafeContinuation`还有栈相关的内容)。

我们来一个案例

//com.example.studycoroutine.chapter.five.FiveDemo.kt
    
    suspend fun mySuspendOne() = suspendCoroutineUninterceptedOrReturn<String> {
         continuation ->
    
        //传入的continuation就是SuspendLambda对象，也就是我们自己写一个lambda编译后的对象
        //启动一个线程。一秒后回调continuation函数
        thread {
        
            TimeUnit.SECONDS.sleep(1)
            logD("我将调用Continuation返回一个数据")
            //调用又会重新调用BaseContinuationImpl的resumeWith函数
            continuation.resume("hello world")
        }
    
        logD("mySuspendOne 函数返回")
        //因为我们这个函数没有返回正确结果，所以必须返回一个挂起标识,否则BaseContinuationImpl会认为完成了任务。
        // 并且我们的线程又在运行没有取消，这将很多意想不到的结果
        kotlin.coroutines.intrinsics.COROUTINE_SUSPENDED
    }
    
    suspend fun mySafeSuspendOne() = suspendCoroutine<String> {
         continuation ->
    
        //传入的continuation就是SuspendLambda对象，也就是我们自己写一个lambda编译后的对象
        //启动一个线程。一秒后回调continuation函数
        thread {
        
            TimeUnit.SECONDS.sleep(1)
            logD("我将调用Continuation返回一个数据")
            //调用又会重新调用BaseContinuationImpl的resumeWith函数
            continuation.resume("hello world ")
        }
    
        logD("mySuspendOne 函数返回")
        //suspendCoroutine函数很聪明的帮我们判断返回结果如果不是想要的对象，自动返回kotlin.coroutines.intrinsics.COROUTINE_SUSPENDED
    
    }
    
    fun testFiveOne() {
        
    
    
        val myCoroutine = MyCoroutine()
        val mystartSuspend: suspend () -> String = {
        
            mySuspendOne()
            mySafeSuspendOne()
        }
    
        //启动协程
        mystartSuspend.startCoroutine(myCoroutine)
    
        logD("启动协程，由于两个挂起函数延迟返回结果所以这句话会先打出来")
    }

输出:

[main] mySuspendOne 函数返回
     [main] 启动协程，由于两个挂起函数所以这句话会先打出来
     [Thread-2] 我将调用Continuation返回一个数据
     [Thread-2] mySuspendOne 函数返回
     [Thread-3] 我将调用Continuation返回一个数据
     [Thread-3] MyCoroutine 回调resumeWith 返回的结果 hello world

对于上面的输出顺序读者必须弄清，弄清的时候等于弄清`Kotlin`协程核心编程思想。

那么这边手动梳理下流程：  
首先看下编译后`mystartSuspend`对象：

static final class MystartSuspend extends SuspendLambda implements Function1 {
        
        int label;
        Object result;
      
        public final Object invokeSuspend(Object $result) {
        
            Object SUSPEND_FLAG = IntrinsicsKt.getCOROUTINE_SUSPENDED();
            int current_statue= this.label;
            if(current_statue== 0) {
        
                ResultKt.throwOnFailure($result);
                this.label = 1;
                //（一）此处返回SUSPEND_FLAG，等mySuspendOne调用传入Continuation对象
                //重新调用到invokeSuspend函数
                if(FiveDemoKt.mySuspendOne(((Continuation)this)) == SUSPEND_FLAG) {
        
                    //(二) 相等所以返回挂起标识给父类结束本次调用。
                    return SUSPEND_FLAG;
                }
    
            label_21:
                this.label = 2;
                //(三) mySuspendOne调用传入Continuation的resume函数回调这
                result = FiveDemoKt.mySafeSuspendOne(((Continuation)this));
                //(四) 此处同样返回挂起标识（一个挂起函数没有立即返回结果那么必然要返回SUSPEND_FLAG）
                if(result == SUSPEND_FLAG) {
        
                //(五)
                    return SUSPEND_FLAG;
                }
            }
            else {
        
                if(current_statue!= 1) {
        
                    if(current_statue== 2) {
        
                    //(六) 最后返回结果，mySafeSuspendOne回调Continuation的resume的回到这
                        ResultKt.throwOnFailure($result);
                        return $result;
                    }
    
                    throw new IllegalStateException("call to \'resume\' before \'invoke\' with coroutine");
                }
    
                ResultKt.throwOnFailure($result);
                goto label_21;
            }
            return result;
        }
    }

上图吧:  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 1]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 2]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 3]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 4]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 5]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 6]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 7]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 8]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 9]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 10]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 11]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 12]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 13]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 14]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 15]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 16]

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 17]

那么看完上面的图示，我相信你应该明白所谓`kotlin`状态机就是接口回调罢了。明白状态机后面在学习`kotlin`协程就像玩一样。

--------------------

我们看到MyCoroutine有一个context对象这个是干嘛的？有什么用

--------------------

下回分析`kotlin`上下文

[Kotlin_-4]: https://blog.csdn.net/qfanmingyiq/article/details/105033167
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70]: /images/20230528/13eaf7fa361d4306b8b2324b6b3b29f4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 1]: /images/20230528/1ed80fb027c44e5a92756d7703734e49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 2]: /images/20230528/b2b79f872ed147b19469048ed033c9bd.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 3]: /images/20230528/30c7b8dfd5764b668ad3cdc1701e3623.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 4]: /images/20230528/cfbf1ef6054744d582bcf0abff40bed7.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 5]: /images/20230528/36686c17ff124c2f999dcfa2d08280b6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 6]: /images/20230528/14412320922349998c435dbb81180728.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 7]: /images/20230528/602fdad745934436adeb843c7f307187.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 8]: /images/20230528/acbf2714bb624826bde68c456ee4b0e4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 9]: /images/20230528/7225fe2dbcc6404e948b4ae9753cdfa3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 10]: /images/20230528/16ca5714d8274be2a8458f91e54ef798.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 11]: /images/20230528/311cf74b2c5349f9b806aad357df379b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 12]: /images/20230528/1f7fda8cf8914fb7a6b3e1e0a51405ac.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 13]: /images/20230528/0445752a0794403c83e74830e0dcba2c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 14]: /images/20230528/8c43041ff02c4820b504ae1e841ad285.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 15]: /images/20230528/b88fa71eb97848298961809d00dd3de6.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 16]: /images/20230528/7a416b78daed442bb424b64f3efb80d4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FmYW5taW5neWlx_size_16_color_FFFFFF_t_70 17]: /images/20230528/7d653eab433c4f48b3c7abac7e8ad683.png