Kotlin Coroutine 原理详解（2）-- 协程间的互动

2023-11-13 08:14:22

基础类分析

在讲解协程间是如何进行互动之前需要对协程的一些基础类进行讲解；

CoroutineContext

协程的上下文，可以看作是一个 map，在协程执行过程中充当设置项集合的角色；

get(key)

重载运算符方法，根据 key 获取相应的 element;

fold(initial, operation)

将 initial 和 element 合并并返回 initial，不同实现类对 operation 操作不同；

plus(context)

将两个 CortouineContext 合并，并返回一个新的 CoroutineContext,此处提供了一个默认实现；

public operator fun plus(context: CoroutineContext): CoroutineContext =
        if (context === EmptyCoroutineContext) this else // fast path -- avoid lambda creation
            context.fold(this) { acc, element ->
                val removed = acc.minusKey(element.key)
                if (removed === EmptyCoroutineContext) element else {
                    // make sure interceptor is always last in the context (and thus is fast to get when present)
                    val interceptor = removed[ContinuationInterceptor]
                    if (interceptor == null) CombinedContext(removed, element) else {
                        val left = removed.minusKey(ContinuationInterceptor)
                        if (left === EmptyCoroutineContext) CombinedContext(element, interceptor) else
                            CombinedContext(CombinedContext(left, element), interceptor)
                    }
                }
            }

具体逻辑如下：
为表述方便，将当前 CoroutineContext 称为 left，将传入的 CoroutineContext 称为 right;

如果 right 不是 EmptyCoroutineContext，则返回 left;
如果 right 不是 EmptyCoroutineContext，则 right 调用 fold 方法，传入 left 和 operation;

minusKey(key)

返回一个不包含指定 key 的 CoroutineContext;

Key

操作 CoroutineContext 所使用到的键，定义如下：

public interface Key<E : Element>

Element

操作 CoroutineContext 所返回的值，继承了 CoroutineContext 但是缩小了对 ContextContext 的使用范围；
定义如下：

public interface Element : CoroutineContext {
        /**
         * A key of this coroutine context element.
         */
        public val key: Key<*>

        public override operator fun <E : Element> get(key: Key<E>): E? =
            @Suppress("UNCHECKED_CAST")
            if (this.key == key) this as E else null

        public override fun <R> fold(initial: R, operation: (R, Element) -> R): R =
            operation(initial, this)

        public override fun minusKey(key: Key<*>): CoroutineContext =
            if (this.key == key) EmptyCoroutineContext else this
    }

接下来来看 CoroutineContext 的两个常见的实现类；

EmptyCoroutineContext

可以看作一个空的CoroutineContext，不存在任何元素；这是 CoroutineContext 的默认实现；
源码如下：

public object EmptyCoroutineContext : CoroutineContext, Serializable {
    private const val serialVersionUID: Long = 0
    private fun readResolve(): Any = EmptyCoroutineContext
    
    // 没有任何元素，直接返回 null; 下面的重载函数也是相似的实现；
    public override fun <E : Element> get(key: Key<E>): E? = null
    public override fun <R> fold(initial: R, operation: (R, Element) -> R): R = initial
    public override fun plus(context: CoroutineContext): CoroutineContext = context
    public override fun minusKey(key: Key<*>): CoroutineContext = this
    public override fun hashCode(): Int = 0
    public override fun toString(): String = "EmptyCoroutineContext"
}

CombinedContext

// 构造函数接收两个参数
internal class CombinedContext(
    private val left: CoroutineContext,
    private val element: Element
) : CoroutineContext, Serializable {

    // 先查 element，再递归查询 left；
    override fun <E : Element> get(key: Key<E>): E? {
        var cur = this
        while (true) {
            cur.element[key]?.let { return it }
            val next = cur.left
            if (next is CombinedContext) {
                cur = next
            } else {
                return next[key]
            }
        }
    }

    // left 先和 initial 进行递归合并得到 newLeft，然后 newLeft 和 element 进行合并；
    public override fun <R> fold(initial: R, operation: (R, Element) -> R): R =
        operation(left.fold(initial, operation), element)

    // 如果 element 包含 key，则直接返回 left；
    // 如果 left 不包含 key，返回当前 CombinedContext；
    // 如果 left 只包含了 key ，则返回 element；
    // 如果 left 不止包含了 key，则返回 新的 CombinedContext；
    public override fun minusKey(key: Key<*>): CoroutineContext {
        element[key]?.let { return left }
        val newLeft = left.minusKey(key)
        return when {
            newLeft === left -> this
            newLeft === EmptyCoroutineContext -> element
            else -> CombinedContext(newLeft, element)
        }
    }
}

从实现来看，CombinedContext 有点像链表；

CoroutineScope

为了方便在协程执行过程中访问 CoroutineContext 而创建的接口；

public interface CoroutineScope {
    // 只有一个接口方法，来提供 `CoroutineContext`
    public val coroutineContext: CoroutineContext
}

Job

Job用于构建协程间的父子层级，具有以下特性：

取消父协程会递归地取消子协程；
子协程异常失败会取消父协程及其他的子协程；SupervisorJob可以自定义这一行为；
父协程会等待所有的子协程完成。

// 继承了 Element 接口，是 CoroutineContext 所存储的对象
public interface Job : CoroutineContext.Element {
    // Job 具有以下三种状态
    public val isActive: Boolean
    public val isCompleted: Boolean
    public val isCancelled: Boolean
    
    // 开始执行协程，如果执行成功返回 true，如果已经执行或者执行过了返回 false
    public fun start(): Boolean
    // 取消协程
    public fun cancel(cause: CancellationException? = null)
    // 保存子协程
    public val children: Sequence<Job>
    // 与子协程建立关系，返回 ChildHanlde 以取消与父协程的关系
    public fun attachChild(child: ChildJob): ChildHandle
    // 阻塞当前父协程，直到当前子协程执行完
    public suspend fun join()、
    // 注册当前协程执行完成的回调；如果已经执行完则立即回调，如果没有执行完则等待状态变更后回调；
    public fun invokeOnCompletion(handler: CompletionHandler): DisposableHandle
}

下面是 Job 状态变更的流程图：

从上述接口的分析可以看出，Job 有一些父协程的特征但又不完全有，完全没有子协程的特征；Kotlin 又派生了两个接口来实现这些特征；

ChildJob

// 子协程接口
public interface ChildJob : Job {
    // 父协程取消子协程
    public fun parentCancelled(parentJob: ParentJob)
}

ParentJob

public interface ParentJob : Job {
    // 这个接口提供取消子协程的原因
    public fun getChildJobCancellationCause(): CancellationException
}

小结

取消父协程会递归地取消子协程

父协程通过children 字段保留了所有的子协程，通过ChildJob 接口中的 parentCancelled 方法来取消子协程；

子协程异常失败会取消父协程及其他的子协程

子协程通过ChildHandle 接口中childCancelled 方法来把消息传递给父协程；

父协程会等待所有的子协程完成

通过invokeOnCompletion 方法注册执行完成的回调，来感知子协程的执行情况；

码农公寓