協(xié)程的狀態(tài)機

這一章會以下面的代碼為例解析一下協(xié)程啟動，掛起以及恢復(fù)的流程：

1. private suspend fun getId(): String { 
2.     return GlobalScope.async(Dispatchers.IO) { 
3.         delay(1000) 
4.         "hearing" 
5.     }.await() 
6. } 
7.  
8. private suspend fun getAvatar(id: String): String { 
9.     return GlobalScope.async(Dispatchers.IO) { 
10.         delay(1000) 
11.         "avatar-$id" 
12.     }.await() 
13. } 
14.  
15. fun main() { 
16.     GlobalScope.launch { 
17.         val id = getId() 
18.         val avatar = getAvatar(id) 
19.         println("${Thread.currentThread().name} - $id - $avatar") 
20.     } 
21. } 

上面 main 方法中，GlobalScope.launch 啟動的協(xié)程體在執(zhí)行到 getId 后，協(xié)程體會掛起，直到 getId 返回可用結(jié)果，才會 resume launch 協(xié)程，執(zhí)行到 getAvatar 也是同樣的過程。協(xié)程內(nèi)部實現(xiàn)使用狀態(tài)機來處理不同的掛起點，將 GlobalScope.launch 協(xié)程體字節(jié)碼反編譯成 Java 代碼，大致如下(有所刪減)：

1. BuildersKt.launch$default((CoroutineScope)GlobalScope.INSTANCE, (CoroutineContext)null, 
2.     (CoroutineStart)null, (Function2)(new Function2((Continuation)null) { 
3.     int label; 
4.  
5.     public final Object invokeSuspend( 
6.  
7.  Object $result) { 
8.         Object var10000; 
9.         String id; 
10.         label17: { 
11.             CoroutineScope $this$launch; 
12.             switch(this.label) { 
13.             case 0: // a 
14.                 ResultKt.throwOnFailure($result); 
15.                 $this$launch = this.p$; 
16.                 this.label = 1; // label置為1 
17.                 var10000 = getId(this); 
18.                 if (var10000 == COROUTINE_SUSPENDED) { 
19.                     return COROUTINE_SUSPENDED; 
20.                 } 
21.                 // 若此時已經(jīng)有結(jié)果，則不掛起，直接break 
22.                 break; 
23.             case 1: // b 
24.                 ResultKt.throwOnFailure($result); 
25.                 var10000 = $result; 
26.                 break; 
27.             case 2: // d 
28.                 id = (String)this.L$1; 
29.                 ResultKt.throwOnFailure($result); 
30.                 var10000 = $result; 
31.                 break label17; // 退出label17 
32.             default: 
33.                 throw new IllegalStateException("call to 'resume' before 'invoke' with coroutine"); 
34.             } 
35.             // c 
36.             id = (String)var10000; 
37.             this.L$1 = id; // 將id賦給L$1 
38.             this.label = 2; // label置為2 
39.             var10000 = getAvatar(id, this); 
40.             if (var10000 == COROUTINE_SUSPENDED) { 
41.                 return COROUTINE_SUSPENDED; 
42.             } 
43.         } 
44.         // e 
45.         String avatar = (String)var10000; 
46.         String var5 = var9.append(var10001.getName()).append(" - ").append(id).append(" - ").append(avatar).toString(); 
47.         System.out.println(var5); 
48.         return Unit.INSTANCE; 
49.     } 
50.  
51.      
52.  
53.  
54.     public final Continuation create( 
55.  
56.  Object value,  
57.  
58.  Continuation completion) { 
59.         Intrinsics.checkParameterIsNotNull(completion, "completion"); 
60.         Function2 var3 = new <anonymous constructor>(completion); 
61.         var3.p$ = (CoroutineScope)value; 
62.         return var3; 
63.     } 
64.  
65.     public final Object invoke(Object var1, Object var2) { 
66.         return ((<undefinedtype>)this.create(var1, (Continuation)var2)).invokeSuspend(Unit.INSTANCE); 
67.     } 
68. } 

這里我們根據(jù)上面的注釋以及字母標(biāo)簽來看一下執(zhí)行流程(invokeSuspend 方法會在協(xié)程體中的 suspend 函數(shù)得到結(jié)果后被調(diào)用，具體是在哪里被調(diào)用的稍后會講到)：

• a: launch 協(xié)程體剛執(zhí)行到 getId 方法時，getId 方法的返回值將是 COROUTINE_SUSPENDED, 此時直接 return, 則 launch 協(xié)程體中 getId 后面的代碼暫時不會執(zhí)行，即 launch 協(xié)程體被掛起(非阻塞, 該線程依舊會做其它工作)。這里將 label 置為了 1. 而若此時 getId 已經(jīng)有結(jié)果(內(nèi)部沒有調(diào)用 delay 之類的 suspend 函數(shù)等)，則不掛起，而是直接 break。
• b: 若上面 a 中 getId 返回 COROUTINE_SUSPENDED, 則當(dāng) getId 有可用結(jié)果返回后，會重新執(zhí)行 launch 協(xié)程體的 invokeSuspend 方法，根據(jù)上面的 label==1, 會執(zhí)行到這里檢查一下 result 沒問題的話就 break, 此時 id 賦值給了 var10000。
• c: 在 a 中若直接 break 或 在 b 中得到 getId 的結(jié)果然后 break 后，都會執(zhí)行到這里，得到 id 的值并把 label 置為2。然后調(diào)用 getAvatar 方法，跟 getId 類似，若其返回 COROUTINE_SUSPENDED 則 return，協(xié)程被掛起，等到下次 invokeSuspend 被執(zhí)行，否則離開 label17 接著執(zhí)行后續(xù)邏輯。
• d: 若上面 c 中 getAvatar 返回 COROUTINE_SUSPENDED, 則當(dāng) getAvatar 有可用結(jié)果返回后會重新調(diào)用 launch 協(xié)程體的 invokeSuspend 方法，此時根據(jù) label==2 來到這里并取得之前的 id 值，檢驗 result(即avatar)，然后break label17。
• e: c 中直接返回了可用結(jié)果 或 d 中 break label17 后，launch 協(xié)程體中的 suspend 函數(shù)都執(zhí)行完畢了，這里會執(zhí)行剩下的邏輯。

suspend 函數(shù)不會阻塞線程，且 suspend 函數(shù)不一定會掛起協(xié)程，如果相關(guān)調(diào)用的結(jié)果已經(jīng)可用，則繼續(xù)運行而不掛起，例如 async{} 返回值 Deferred 的結(jié)果已經(jīng)可用時，await()掛起函數(shù)可以直接返回結(jié)果，不用再掛起協(xié)程。

這一節(jié)看了一下 launch 協(xié)程體反編譯成 Java 后的代碼邏輯，關(guān)于 invokeSuspend 是何時怎么被調(diào)用的，將會在下面講到。

協(xié)程的創(chuàng)建與啟動

這一節(jié)以 CoroutineScope.launch {} 默認參數(shù)為例，從源碼角度看看 Kotlin 協(xié)程是怎樣創(chuàng)建與啟動的：

1. public fun CoroutineScope.launch( 
2.     context: CoroutineContext = EmptyCoroutineContext, 
3.     start: CoroutineStart = CoroutineStart.DEFAULT, 
4.     block: suspend CoroutineScope.() -> Unit 
5. ): Job { 
6.     val newContext = newCoroutineContext(context) 
7.     val coroutine = if (start.isLazy) LazyStandaloneCoroutine(newContext, block) else StandaloneCoroutine(newContext, active = true) 
8.     coroutine.start(start, coroutine, block) 
9.     return coroutine 
10. } 
11.  
12. // AbstractCoroutine.kt 
13. // receiver: StandaloneCoroutine 
14. // block: suspend StandaloneCoroutine.() -> Unit 
15. // private open class StandaloneCoroutine(...) : AbstractCoroutine<Unit>(...) {} 
16. // public abstract class AbstractCoroutine<in T>(...) : JobSupport(active), Job, Continuation<T>, CoroutineScope {} 
17. public fun <R> start(start: CoroutineStart, receiver: R, block: suspend R.() -> T) { 
18.     // 調(diào)用 CoroutineStart 中的 invoke 方法 
19.     start(block, receiver, this) 
20. } 
21.  
22. public enum class CoroutineStart { 
23.     // block - StandaloneCoroutine.() -> Unit 
24.     // receiver - StandaloneCoroutine 
25.     // completion - StandaloneCoroutine<Unit> 
26.     public operator fun <R, T> invoke(block: suspend R.() -> T, receiver: R, completion: Continuation<T>): Unit = 
27.         when (this) { 
28.             // 根據(jù) start 參數(shù)的類型調(diào)用不同的方法 
29.             DEFAULT -> block.startCoroutineCancellable(receiver, completion) 
30.             ATOMIC -> block.startCoroutine(receiver, completion) 
31.             UNDISPATCHED -> block.startCoroutineUndispatched(receiver, completion) 
32.             LAZY -> Unit // will start lazily 
33.         } 
34. } 

接下來看看 startCoroutineCancellable 方法：

1. // receiver - StandaloneCoroutine 
2. // completion - StandaloneCoroutine<Unit> 
3. internal fun <R, T> (suspend (R) -> T).startCoroutineCancellable(receiver: R, completion: Continuation<T>) = 
4.     runSafely(completion) { 
5.         createCoroutineUnintercepted(receiver, completion).intercepted().resumeCancellableWith(Result.success(Unit)) 
6.     } 

createCoroutineUnintercepted 方法創(chuàng)建了一個 Continuation 類型(協(xié)程)的實例，即創(chuàng)建了一個協(xié)程：

1. public actual fun <R, T> (suspend R.() -> T).createCoroutineUnintercepted( 
2.     receiver: R, completion: Continuation<T> 
3. ): Continuation<Unit> { 
4.     return if (this is BaseContinuationImpl) create(receiver, completion) else // ... 
5. } 

調(diào)用的是 (suspend (R) -> T) 的 createCoroutineUnintercepted 方法，(suspend (R) -> T) 就是協(xié)程體。直接看上面示例代碼中 GlobalScope.launch 編譯后的字節(jié)碼，可以發(fā)現(xiàn) CoroutineScope.launch 傳入的 lambda 表達式被編譯成了繼承 SuspendLambda 的子類：

1. final class Main$main$1 extends kotlin/coroutines/jvm/internal/SuspendLambda implements kotlin/jvm/functions/Function2 

其繼承關(guān)系為: SuspendLambda -> ContinuationImpl -> BaseContinuationImpl -> Continuation, 因此走 create(receiver, completion) 方法，從上面反編譯出的 Java 代碼可以看到 create 方法創(chuàng)建了一個 Continuation 實例，再看一下 Kotlin 代碼編譯后的字節(jié)碼(包名已省略)：

1. public final create(Ljava/lang/Object;Lkotlin/coroutines/Continuation;)Lkotlin/coroutines/Continuation; 
2. // ... 
3. NEW Main$main$1 

從上面可以看到，create 方法創(chuàng)建了 Main$main$1 實例，而其繼承自 SuspendLambda, 因此 create 方法創(chuàng)建的 Continuation 是一個 SuspendLambda 對象。

即 createCoroutineUnintercepted 方法創(chuàng)建了一個 SuspendLambda 實例。然后看看 intercepted 方法：

1. public actual fun <T> Continuation<T>.intercepted(): Continuation<T> = 
2.     // 如果是ContinuationImpl類型，則調(diào)用intercepted方法，否則返回自身 
3.     // 這里的 this 是 Main$main$1 實例 - ContinuationImpl的子類 
4.     (this as? ContinuationImpl)?.intercepted() ?: this 
5.  
6. // ContinuationImpl 
7. public fun intercepted(): Continuation<Any?> = 
8.     // context[ContinuationInterceptor]是 CoroutineDispatcher 實例 
9.     // 需要線程調(diào)度 - 返回 DispatchedContinuation，其 continuation 參數(shù)值為 SuspendLambda 
10.     // 不需要線程調(diào)度 - 返回 SuspendLambda 
11.     intercepted ?: (context[ContinuationInterceptor]?.interceptContinuation(this) ?: this).also { intercepted = it } 
12.  
13. // CoroutineDispatcher 
14. // continuation - SuspendLambda -> ContinuationImpl -> BaseContinuationImpl 
15. public final override fun <T> interceptContinuation(continuation: Continuation<T>): Continuation<T> = 
16.     DispatchedContinuation(this, continuation) 

接下來看看 resumeCancellableWith 是怎么啟動協(xié)程的，這里還涉及到Dispatchers線程調(diào)度的邏輯：

1. internal class DispatchedContinuation<in T>(      
2.  
3.  val dispatcher: CoroutineDispatcher,      
4.  
5.  val continuation: Continuation<T> 
6. ) : DispatchedTask<T>(MODE_ATOMIC_DEFAULT), CoroutineStackFrame, Continuation<T> by continuation { 
7.     public fun <T> Continuation<T>.resumeCancellableWith(result: Result<T>): Unit = when (this) { 
8.         // 進行線程調(diào)度，最后也會執(zhí)行到continuation.resumeWith方法 
9.         is DispatchedContinuation -> resumeCancellableWith(result) 
10.         // 直接執(zhí)行continuation.resumeWith方法 
11.         else -> resumeWith(result) 
12.     } 
13.  
14.     inline fun resumeCancellableWith(result: Result<T>) { 
15.         val state = result.toState() 
16.         // 判斷是否需要線程調(diào)度 
17.         if (dispatcher.isDispatchNeeded(context)) { 
18.             _state = state 
19.             resumeMode = MODE_CANCELLABLE 
20.             // 需要調(diào)度則先進行調(diào)度 
21.             dispatcher.dispatch(context, this) 
22.         } else { 
23.             executeUnconfined(state, MODE_CANCELLABLE) { 
24.                 if (!resumeCancelled()) { 
25.                     // 不需要調(diào)度則直接在當(dāng)前線程執(zhí)行協(xié)程 
26.                     resumeUndispatchedWith(result) 
27.                 } 
28.             } 
29.         } 
30.     } 
31.  
32.     inline fun resumeUndispatchedWith(result: Result<T>) { 
33.         withCoroutineContext(context, countOrElement) { 
34.             continuation.resumeWith(result) 
35.         } 
36.     } 
37. } 

• 當(dāng)需要線程調(diào)度時，則在調(diào)度后會調(diào)用 DispatchedContinuation.continuation.resumeWith 來啟動協(xié)程，其中 continuation 是 SuspendLambda 實例;
• 當(dāng)不需要線程調(diào)度時，則直接調(diào)用 SuspendLambda.resumeWith 來啟動協(xié)程。

resumeWith 方法調(diào)用的是父類 BaseContinuationImpl 中的 resumeWith 方法：

1. internal abstract class BaseContinuationImpl(public val completion: Continuation<Any?>?) : Continuation<Any?>, CoroutineStackFrame, Serializable { 
2.     public final override fun resumeWith(result: Result<Any?>) { 
3.         // ... 
4.         val outcome = invokeSuspend(param) 
5.         // ... 
6.     } 
7. } 

因此，協(xié)程的啟動是通過 BaseContinuationImpl.resumeWith 方法調(diào)用到了子類 SuspendLambda.invokeSuspend 方法，然后通過狀態(tài)機來控制順序運行。

協(xié)程的掛起和恢復(fù)

Kotlin 編譯器會為 協(xié)程體 生成繼承自 SuspendLambda 的子類，協(xié)程的真正運算邏輯都在其 invokeSuspend 方法中。上一節(jié)介紹了 launch 是怎么創(chuàng)建和啟動協(xié)程的，在這一節(jié)我們再看看當(dāng)協(xié)程代碼執(zhí)行到 suspend 函數(shù)后，協(xié)程是怎么被掛起的 以及 當(dāng) suspend 函數(shù)執(zhí)行完成得到可用結(jié)果后是怎么恢復(fù)協(xié)程的。

Kotlin 協(xié)程的內(nèi)部實現(xiàn)使用了 Kotlin 編譯器的一些編譯技術(shù)，當(dāng) suspend 函數(shù)被調(diào)用時，都有一個隱式的參數(shù)額外傳入，這個參數(shù)是 Continuation 類型，封裝了協(xié)程 resume 后執(zhí)行的代碼邏輯。

1. private suspend fun getId(): String { 
2.     return GlobalScope.async(Dispatchers.IO) { 
3.         delay(1000) 
4.         "hearing" 
5.     }.await() 
6. } 
7.  
8. // Decompile成Java 
9. final Object getId( 
10.  
11.  Continuation $completion) { 
12.     // ... 
13. } 

其中傳入的 $completion 參數(shù)，從上一節(jié)可以看到是調(diào)用 getId 方法所在的協(xié)程體對象，也就是一個 SuspendLambda 對象。Continuation的定義如下：

1. public interface Continuation<in T> { 
2.     public val context: CoroutineContext 
3.  
4.     public fun resumeWith(result: Result<T>) 
5. } 

將 getId 方法編譯后的字節(jié)碼反編譯成 Java 代碼如下(為便于閱讀，刪減及修改了部分代碼)：

1. final Object getId( 
2.  
3.  Continuation $completion) { 
4.     // 新建與啟動協(xié)程 
5.     return BuildersKt.async$default((CoroutineScope)GlobalScope.INSTANCE, (CoroutineContext)Dispatchers.getIO(), (CoroutineStart)null, (Function2)(new Function2((Continuation)null) { 
6.         int label;  
7.  
8.         public final Object invokeSuspend( 
9.  
10.  Object $result) { 
11.             switch(this.label) { 
12.             case 0: 
13.                 ResultKt.throwOnFailure($result); 
14.                 this.label = 1; 
15.                 if (DelayKt.delay(1000L, this) == COROUTINE_SUSPENDED) { 
16.                     return COROUTINE_SUSPENDED; 
17.                 } 
18.                 break; 
19.             case 1: 
20.                 ResultKt.throwOnFailure($result); 
21.                 break; 
22.             default: 
23.                 throw new IllegalStateException("call to 'resume' before 'invoke' with coroutine"); 
24.             } 
25.             return "hearing"; 
26.         } 
27.  
28.         // ... 
29.     }), 2, (Object)null).await($completion); // 調(diào)用 await() suspend 函數(shù) 
30. } 

結(jié)合協(xié)程的狀態(tài)機一節(jié)，當(dāng)上面的 launch 協(xié)程體執(zhí)行到 getId 方法時, 會根據(jù)其返回值是否為 COROUTINE_SUSPENDED 來決定是否掛起，由于 getId 的邏輯是通過 async 啟動一個新的協(xié)程，協(xié)程體內(nèi)調(diào)用了 suspend delay 方法，然后通過 await suspend 函數(shù)等待結(jié)果，當(dāng) async 協(xié)程沒完成時, await 會返回 COROUTINE_SUSPENDED, 因此 launch 協(xié)程體的 invokeSuspend 方法直接 return COROUTINE_SUSPENDED 值執(zhí)行完成，此時 launch 啟動的協(xié)程處于掛起狀態(tài)但不阻塞所處線程，而 async 啟動的協(xié)程開始執(zhí)行。

我們看一下 async 的源碼：

1. public fun <T> CoroutineScope.async(...): Deferred<T> { 
2.     val newContext = newCoroutineContext(context) 
3.     val coroutine = if (start.isLazy) LazyDeferredCoroutine(newContext, block) else 
4.         DeferredCoroutine<T>(newContext, active = true) 
5.     coroutine.start(start, coroutine, block) 
6.     return coroutine 
7. } 

默認情況下，上面的 coroutine 取 DeferredCoroutine 實例，于是我們看一下其 await 方法以及在 async 協(xié)程執(zhí)行完成后，是怎么恢復(fù) launch 協(xié)程的：

1. private open class DeferredCoroutine<T>( 
2.     parentContext: CoroutineContext, active: Boolean 
3. ) : AbstractCoroutine<T>(parentContext, active), Deferred<T>, SelectClause1<T> { 
4.     override suspend fun await(): T = awaitInternal() as T 
5. } 
6.  
7. // JobSupport 
8. internal suspend fun awaitInternal(): Any? { 
9.     while (true) { // lock-free loop on state 
10.         val state = this.state 
11.         if (state !is Incomplete) { 
12.             // 已經(jīng)完成，則直接返回結(jié)果 
13.             if (state is CompletedExceptionally) { // Slow path to recover stacktrace 
14.                 recoverAndThrow(state.cause) 
15.             } 
16.             return state.unboxState() 
17.         } 
18.         // 不需要重試時直接break，執(zhí)行awaitSuspend 
19.         if (startInternal(state) >= 0) break 
20.     } 
21.     return awaitSuspend() // slow-path 
22. } 
23.  
24. // suspendCoroutineUninterceptedOrReturn: 獲取當(dāng)前協(xié)程，且掛起當(dāng)前協(xié)程(返回COROUTINE_SUSPENDED)或不掛起直接返回結(jié)果 
25. private suspend fun awaitSuspend(): Any? = suspendCoroutineUninterceptedOrReturn { uCont -> 
26.     val cont = AwaitContinuation(uCont.intercepted(), this) 
27.     cont.disposeOnCancellation(invokeOnCompletion(ResumeAwaitOnCompletion(this, cont).asHandler)) 
28.     cont.getResult() 
29. } 

上面 awaitInternal 的大致邏輯是當(dāng)掛起函數(shù)已經(jīng)有結(jié)果時則直接返回，否則掛起父協(xié)程，然后 invokeOnCompletion 方法將 ResumeAwaitOnCompletion 插入一個隊列(state.list)中，源碼就不再貼出了。接著看看在 async 執(zhí)行完成后是怎么調(diào)用 ResumeAwaitOnCompletion 來 resume 被掛起的協(xié)程的。注意：不要繞進 async 協(xié)程體中 delay 是怎么掛起和恢復(fù) async 協(xié)程的這一邏輯，我們不需要關(guān)注這一層!

接著 async 協(xié)程的執(zhí)行往下看，從前面可知它會調(diào)用 BaseContinuationImpl.resumeWith 方法來執(zhí)行協(xié)程邏輯，我們詳細看一下這個方法，在這里會執(zhí)行該協(xié)程的 invokeSuspend 函數(shù)：

1. internal abstract class BaseContinuationImpl( 
2.     public val completion: Continuation<Any?>? 
3. ) : Continuation<Any?>, CoroutineStackFrame, Serializable { 
4.     public final override fun resumeWith(result: Result<Any?>) { 
5.         var current = this 
6.         var param = result 
7.         while (true) { 
8.             with(current) { 
9.                 val completion = completion!! // fail fast when trying to resume continuation without completion 
10.                 val outcome: Result<Any?> = 
11.                     try {// 調(diào)用 invokeSuspend 方法執(zhí)行協(xié)程邏輯 
12.                         val outcome = invokeSuspend(param) 
13.                         // 協(xié)程掛起時返回的是 COROUTINE_SUSPENDED，即協(xié)程掛起時，resumeWith 執(zhí)行結(jié)束 
14.                         // 再次調(diào)用 resumeWith 時協(xié)程掛起點之后的代碼才能繼續(xù)執(zhí)行 
15.                         if (outcome === COROUTINE_SUSPENDED) return 
16.                         Result.success(outcome) 
17.                     } catch (exception: Throwable) { 
18.                         Result.failure(exception) 
19.                     } 
20.                 releaseIntercepted() // this state machine instance is terminating 
21.                 if (completion is BaseContinuationImpl) { 
22.                     // unrolling recursion via loop 
23.                     current = completion 
24.                     param = outcome 
25.                 } else { 
26.                     // top-level completion reached -- invoke and return 
27.                     completion.resumeWith(outcome) 
28.                     return 
29.                 } 
30.             } 
31.         } 
32.     } 
33. } 

我們從上面的源碼可以看到，在 createCoroutineUnintercepted 方法中創(chuàng)建的 SuspendLambda 實例是 BaseContinuationImpl 的子類對象，其 completion 參數(shù)為下：

• launch: if (isLazy) LazyStandaloneCoroutine else StandaloneCoroutine
• async: if (isLazy) LazyDeferredCoroutine else DeferredCoroutine

上面這幾個類都是 AbstractCoroutine 的子類。而根據(jù) completion 的類型會執(zhí)行不同的邏輯：

• BaseContinuationImpl: 執(zhí)行協(xié)程邏輯
• 其它: 調(diào)用 resumeWith 方法，處理協(xié)程的狀態(tài)，協(xié)程掛起后的恢復(fù)即與它有關(guān)

在上面的例子中 async 啟動的協(xié)程，它也會調(diào)用其 invokeSuspend 方法執(zhí)行 async 協(xié)程邏輯，假設(shè) async 返回的結(jié)果已經(jīng)可用時，即非 COROUTINE_SUSPENDED 值，此時 completion 是 DeferredCoroutine 對象，因此會調(diào)用 DeferredCoroutine.resumeWith 方法，然后返回，父協(xié)程的恢復(fù)邏輯便是在這里。

1. // AbstractCoroutine 
2. public final override fun resumeWith(result: Result<T>) { 
3.     val state = makeCompletingOnce(result.toState()) 
4.     if (state === COMPLETING_WAITING_CHILDREN) return 
5.     afterResume(state) 
6. } 

在 makeCompletingOnce 方法中，會根據(jù) state 去處理協(xié)程狀態(tài)，并執(zhí)行上面插入 state.list 隊列中的 ResumeAwaitOnCompletion.invoke 來恢復(fù)父協(xié)程，必要的話還會把 async 的結(jié)果給它，具體代碼實現(xiàn)太多就不貼了，不是本節(jié)的重點。直接看 ResumeAwaitOnCompletion.invoke 方法：

1. private class ResumeAwaitOnCompletion<T>( 
2.     job: JobSupport, private val continuation: CancellableContinuationImpl<T> 
3. ) : JobNode<JobSupport>(job) { 
4.     override fun invoke(cause: Throwable?) { 
5.         val state = job.state 
6.         assert { state !is Incomplete } 
7.         if (state is CompletedExceptionally) { 
8.             // Resume with with the corresponding exception to preserve it 
9.             continuation.resumeWithException(state.cause) 
10.         } else { 
11.             // resume 被掛起的協(xié)程 
12.             continuation.resume(state.unboxState() as T) 
13.         } 
14.     } 
15. } 

這里的 continuation 就是 launch 協(xié)程體，也就是 SuspendLambda 對象，于是 invoke 方法會再一次調(diào)用到 BaseContinuationImpl.resumeWith 方法，接著調(diào)用 SuspendLambda.invokeSuspend, 然后根據(jù) label 取值繼續(xù)執(zhí)行接下來的邏輯!

suspendCoroutineUninterceptedOrReturn

接下來我們看一下怎么將一個基于回調(diào)的方法改造成一個基于協(xié)程的 suspend 方法，要實現(xiàn)這個需求，重點在于 suspendCoroutineUninterceptedOrReturn 方法，根據(jù)注釋，這個方法的作用是: Obtains the current continuation instance inside suspend functions and either suspends currently running coroutine or returns result immediately without suspension. 即獲取當(dāng)前協(xié)程的實例，并且掛起當(dāng)前協(xié)程或不掛起直接返回結(jié)果。函數(shù)定義如下：

1. public suspend inline fun <T> suspendCoroutineUninterceptedOrReturn(crossinline block: (Continuation<T>) -> Any?): T { 
2.     // ... 
3. } 

根據(jù) block 的返回值，有兩種情況：

• 如果 block 返回 COROUTINE_SUSPENDED, 意味著 suspend 函數(shù)會掛起當(dāng)前協(xié)程而不會立即返回結(jié)果。這種情況下, block 中的 Continuation 需要在結(jié)果可用后調(diào)用 Continuation.resumeWith 來 resume 協(xié)程。
• 如果 block 返回的 T 是 suspend 函數(shù)的結(jié)果，則協(xié)程不會被掛起, block 中的 Continuation 不會被調(diào)用。

調(diào)用 Continuation.resumeWith 會直接在調(diào)用者的線程 resume 協(xié)程，而不會經(jīng)過 CoroutineContext 中可能存在的 ContinuationInterceptor。建議使用更安全的 suspendCoroutine 方法，在其 block 中可以同步或在異步線程調(diào)用 Continuation.resume 和 Continuation.resumeWithException:

1. public suspend inline fun <T> suspendCoroutine(crossinline block: (Continuation<T>) -> Unit): T { 
2.     contract { callsInPlace(block, InvocationKind.EXACTLY_ONCE) } 
3.     return suspendCoroutineUninterceptedOrReturn { c: Continuation<T> -> 
4.         // 調(diào)用攔截器 
5.         val safe = SafeContinuation(c.intercepted()) 
6.         block(safe) 
7.         safe.getOrThrow() 
8.     } 
9. } 

此外除了 suspendCoroutine 方法，還有 suspendCancellableCoroutine, suspendAtomicCancellableCoroutine, suspendAtomicCancellableCoroutineReusable 等方法都可以用來將異步回調(diào)的方法封裝成 suspend 函數(shù)。

下面來看一個例子來介紹怎么將異步回調(diào)函數(shù)封裝成 suspend 函數(shù)：

1. class NetFetcher { 
2.     // 將下面的 request 方法封裝成 suspend 方法 
3.     suspend fun requestSuspend(id: Int): String = suspendCoroutine { continuation -> 
4.         request(id, object : OnResponseListener { 
5.             override fun onResponse(response: String) { 
6.                 continuation.resume(response) 
7.             } 
8.  
9.             override fun onError(error: String) { 
10.                 continuation.resumeWithException(Exception(error)) 
11.             } 
12.         }) 
13.     } 
14.  
15.     fun request(id: Int, listener: OnResponseListener) { 
16.         Thread.sleep(5000) 
17.         if (id % 2 == 0) { 
18.             listener.onResponse("success") 
19.         } else { 
20.             listener.onError("error") 
21.         } 
22.     } 
23.  
24.     interface OnResponseListener { 
25.         fun onResponse(response: String) 
26.         fun onError(error: String) 
27.     } 
28. } 
29.  
30. object Main { 
31.     fun main() { 
32.         requestByCoroutine() 
33.     } 
34.  
35.     // 使用回調(diào) 
36.     private fun requestByCallback() { 
37.         NetFetcher().request(21, object : NetFetcher.OnResponseListener { 
38.             override fun onResponse(response: String) { 
39.                 println("result = $response") 
40.             } 
41.  
42.             override fun onError(error: String) { 
43.                 println("result = $error") 
44.             } 
45.         }) 
46.     } 
47.  
48.     // 使用協(xié)程 
49.     private fun requestByCoroutine() { 
50.         GlobalScope.launch(Dispatchers.Main) { 
51.             val result = withContext(Dispatchers.IO) { 
52.                 try { 
53.                     NetFetcher().requestSuspend(22) 
54.                 } catch (e: Exception) { 
55.                     e.message 
56.                 } 
57.             } 
58.       

為加深理解，再介紹一下 Kotlin 提供的兩個借助 suspendCancellableCoroutine 實現(xiàn)的掛起函數(shù): delay & yield。

delay

delay 方法借助了 suspendCancellableCoroutine 方法來掛起協(xié)程：

1. public suspend fun delay(timeMillis: Long) { 
2.     if (timeMillis <= 0) return // don't delay 
3.     return suspendCancellableCoroutine sc@ { cont: CancellableContinuation<Unit> -> 
4.         cont.context.delay.scheduleResumeAfterDelay(timeMillis, cont) 
5.     } 
6. } 
7.  
8. override fun scheduleResumeAfterDelay(timeMillis: Long, continuation: CancellableContinuation<Unit>) { 
9.     postDelayed(Runnable { 
10.         with(continuation) { resumeUndispatched(Unit) } 
11.     }, timeMillis) 
12. } 

可以看出這里 delay 的邏輯類似于 Handle 機制，將 resumeUndispatched 封裝的 Runnable 放到一個隊列中，在延遲的時間到達便會執(zhí)行 resume 恢復(fù)協(xié)程。

yield

yield 方法作用是掛起當(dāng)前協(xié)程，這樣可以讓該協(xié)程所在線程運行其他邏輯，當(dāng)其他協(xié)程執(zhí)行完成或也調(diào)用 yield 讓出執(zhí)行權(quán)時，之前的協(xié)程可以恢復(fù)執(zhí)行。

1. launch(Dispatchers.Main) { 
2.     repeat(3) { 
3.         println("job1 $it") 
4.         yield() 
5.     } 
6. } 
7. launch(Dispatchers.Main) { 
8.     repeat(3) { 
9.         println("job2 $it") 
10.         yield() 
11.     } 
12. } 
13.  
14. // output 
15. job1 0 
16. job2 0 
17. job1 1 
18. job2 1 
19. job1 2 
20. job2 2 

看一下 yield 的源碼：

1. public suspend fun yield(): Unit = suspendCoroutineUninterceptedOrReturn sc@ { uCont -> 
2.     val context = uCont.context 
3.     // 如果協(xié)程沒有調(diào)度器，或者像 Unconfined 一樣沒有進行調(diào)度則直接返回 
4.     val cont = uCont.intercepted() as? DispatchedContinuation<Unit> ?: return@sc Unit 
5.     if (cont.dispatcher.isDispatchNeeded(context)) { 
6.         // this is a regular dispatcher -- do simple dispatchYield 
7.         cont.dispatchYield(context, Unit) 
8.     } else { 
9.         // This is either an "immediate" dispatcher or the Unconfined dispatcher 
10.         // ... 
11.     } 
12.     COROUTINE_SUSPENDED 
13. } 
14.  
15. // DispatchedContinuation 
16. internal fun dispatchYield(context: CoroutineContext, value: T) { 
17.     _state = value 
18.     resumeMode = MODE_CANCELLABLE 
19.     dispatcher.dispatchYield(context, this) 
20. } 
21.  
22. public open fun dispatchYield(context: CoroutineContext, block: Runnable): Unit = dispatch(context, block) 

可知 dispatchYield 會調(diào)用到 dispatcher.dispatch 方法將協(xié)程分發(fā)到調(diào)度器隊列中，這樣線程可以執(zhí)行其他協(xié)程，等到調(diào)度器再次執(zhí)行到該協(xié)程時，會 resume 該協(xié)程。

總結(jié)

通過上面協(xié)程的工作原理解析，可以從源碼中發(fā)現(xiàn) Kotlin 中的協(xié)程存在著三層包裝：

• 第一層包裝: launch & async 返回的 Job, Deferred 繼承自 AbstractCoroutine, 里面封裝了協(xié)程的狀態(tài)，提供了 cancel 等接口;
• 第二層包裝: 編譯器生成的 SuspendLambda 子類，封裝了協(xié)程的真正執(zhí)行邏輯，其繼承關(guān)系為 SuspendLambda -> ContinuationImpl -> BaseContinuationImpl, 它的 completion 參數(shù)就是第一層包裝實例;
• 第三層包裝: DispatchedContinuation, 封裝了線程調(diào)度邏輯，它的 continuation 參數(shù)就是第二層包裝實例。

這三層包裝都實現(xiàn)了 Continuation 接口，通過代理模式將協(xié)程的各層包裝組合在一起，每層負責(zé)不同的功能，如下圖：

原文地址：https://ljd1996.github.io/2021/05/19/Kotlin%E7%AC%94%E8%AE%B0%E4%B9%8B%E5%8D%8F%E7%A8%8B%E5%B7%A5%E4%BD%9C%E5%8E%9F%E7%90%86/?utm_source=tuicool&utm_medium=referral