Kotlin协程的JVM实现源码分析（上）

本文从协程的启动launch源码入手分析，协程JVM实现分为两篇：

协程启动和执行源码分析
无栈协程和 Continuation

基本环境：

IntelliJ IDEA 2023.3.2
Kotlin 1.8.20
kotlinx-coroutines-core 1.7.3
gradle 8.2

一、协程的启动和执行

以 GlobalScope.launch 启动协程分析：

kotlin 复制代码

public fun CoroutineScope.launch(
    context: CoroutineContext = EmptyCoroutineContext,
    start: CoroutineStart = CoroutineStart.DEFAULT,
    block: suspend CoroutineScope.() -> Unit
): Job {
    val newContext = newCoroutineContext(context)
    val coroutine = if (start.isLazy)
        LazyStandaloneCoroutine(newContext, block) else
        StandaloneCoroutine(newContext, active = true)
    coroutine.start(start, coroutine, block)
    return coroutine
}

调用关系： CoroutineScope.launch -> StandaloneCoroutine.start ->
CoroutineStart.invoke -> block.startCoroutineCancellable。

1. startCoroutineCancellable 启动流程

启动协程，默认执行 block.startCoroutineCancellable 扩展方法：

kotlin 复制代码

internal fun <R, T> (suspend (R) -> T).startCoroutineCancellable(
    receiver: R, completion: Continuation<T>,
    onCancellation: ((cause: Throwable) -> Unit)? = null
) =
    runSafely(completion) {
        createCoroutineUnintercepted(receiver, completion).intercepted().resumeCancellableWith(Result.success(Unit), onCancellation)
    }

说明：

createCoroutineUnintercepted, 创建 Continuation；
intercepted，拦截生成 DispatchedContinuation；
resumeCancellableWith，调度器派发执行协程。

intercepted()

关键在 intercepted() 方法：

获取 ContinuationInterceptor，默认值是 Dispatchers.Default,
使用 CoroutineDispatcher.interceptContinuation 生成 DispatchedContinuation

kotlin 复制代码

// ContinuationImpl 拦截方法
@Transient
private var intercepted: Continuation<Any?>? = null

public fun intercepted(): Continuation<Any?> =
    intercepted
        ?: (context[ContinuationInterceptor]?.interceptContinuation(this) ?: this)
            .also { intercepted = it }

// Dispatchers.Default 源码
public final override fun <T> interceptContinuation(continuation: Continuation<T>): Continuation<T> =
    DispatchedContinuation(this, continuation)

resumeCancellableWith

DispatchedContinuation.resumeCancellableWith 实现了调度器（线程池）的任务派发，也就是 Runnable：

kotlin 复制代码

inline fun resumeCancellableWith(
    result: Result<T>,
    noinline onCancellation: ((cause: Throwable) -> Unit)?
) {
    val state = result.toState(onCancellation)
    if (dispatcher.isDispatchNeeded(context)) {
        _state = state
        resumeMode = MODE_CANCELLABLE
        dispatcher.dispatch(context, this)
    } else {
        executeUnconfined(state, MODE_CANCELLABLE) {
            if (!resumeCancelled(state)) {
                resumeUndispatchedWith(result)
            }
        }
    }
}

默认执行到 ：
dispatcher.dispatch(context, this)，此时调度器派发执行。
DispatchedContinuation 实现了 Runnable 接口， run() 调用即开始执行阶段，接下来分析。

2. DispatchedContinuation

DispatchedContinuation 继承 DispatchedTask，委托了 Contanuation。

协程的最终执行：

DispatchedContinuation.resumeCancellableWith -> dispatcher.dispatch()

-> DispatchedTask.run() -> DispatchedContinuation.continuation.resumeWith。

最终 DispatchedContinuation.continuation 也就是我们 launch {} 块生成的 SuspendLambda 类对象。

ContinuationImpl

无论是 launch {} 块生成的 SuspendLambda类，还是 suspend fun 函数生成 ContinuationImpl 匿名类。

它们都继承 BaseContinuationImpl。

基类 BaseContinuationImpl，实现了 resumeWith：

kotlin 复制代码

try {
    val outcome = invokeSuspend(param)
    if (outcome === COROUTINE_SUSPENDED) return
    Result.success(outcome)
} catch (exception: Throwable) {
    Result.failure(exception)
}

调用了抽象 invokeSuspend，也就是 launch {} 块编译后的代码。

执行完成后，会执行协程 completion.resumeWith(outcome)，最终完成。

resumeWith -> onCompletionInternal -> onCompleted 或 onCancelled

launch {} 块编译代码分析

launch {} 和 async {} 编译后，都继承 SuspendLambda。

反编译.class，通过 jadx-gui 看到块代码一般是下面形式：

java 复制代码

public static final class AnonymousClass1 extends SuspendLambda implements Function2<CoroutineScope, Continuation<? super Unit>, Object> {
    int label;

    @NotNull
    public final Continuation<Unit> create(@Nullable Object value, @NotNull Continuation<?> continuation) {
        return new AnonymousClass1(continuation);
    }

    @Nullable
    public final Object invoke(@NotNull CoroutineScope p1, @Nullable Continuation<? super Unit> continuation) {
        return create(p1, continuation).invokeSuspend(Unit.INSTANCE);
    }

    @Nullable
    public final Object invokeSuspend(@NotNull Object $result) {
        // launch {} 执行代码块 逻辑，会编译到这里
        ...
    }
}

小结

通过launch启动协程源码分析，了解了：

Dispatchers 调度器何时派发任务
协程 Continuation 挂起、执行和恢复

补充类图

Continuation

Continuation context resumeWith(result) BaseContinuationImpl resumeWith(result) invokeSuspend(result) ContinuationImpl SuspendLambda RestrictedContinuationImpl RestrictedSuspendLambda

DispatchedContinuation

DispatchedContinuation dispatcher continuation resumeWith(result) resumeCancellableWith(result) DispatchedTask run() Runnable

关键类和文件

kotlin.coroutines.Continuation.kt
kotlin.coroutines.CoroutineContext
kotlin.coroutines.jvm.internal.BaseContinuationImpl.kt 对应 Continuation 默认实现。
kotlinx.coroutines.CoroutineStart 启动线程方式、调用

Kotlin协程的JVM实现源码分析（上）

一、协程的启动和执行

1. startCoroutineCancellable 启动流程

intercepted()

resumeCancellableWith

2. DispatchedContinuation

ContinuationImpl

launch {} 块编译代码分析

小结

补充类图

Continuation

DispatchedContinuation

关键类和文件

文档