kotlin 协程上下文那点事

用线程做类比的话,协程的 context 可以认为是协程的“线程私有变量”,同时这个私有变量是不可变的。也就是说,我们在创建一个协程的时候,他的 context 携带的信息就已经确定了下来。由于协程是很轻量的,在需要改变协程上下文的时候,我们可以直接新创建一个协程,所以不可变性不算是一个大问题。

它的两个跟我们我们日常开发联系比较大的方法如下:

@SinceKotlin("1.3")
public interface CoroutineContext {
    interface Key<E : Element>
    
    public operator fun <E : Element> get(key: Key<E>): E?
    public operator fun plus(context: CoroutineContext): CoroutineContext
    
    // 注:省略了 fold 和 minusKey
}

context 可以认为是一个 map,通过它的 get 方法可以取出集合里的内容,比如:

val interceptor: ContinuationInterceptor? = context[ContinuationInterceptor]

interceptor 我们下篇文章再聊。这里用来做索引的 ContinuationInterceptor 其实是类 ContinuationInterceptor 的 companion object,并且这个伴生对象继承了 CoroutineContext.Key<ContinuationInterceptor>。初看起来这种写法有点奇怪,但习惯了以后还是不得不承认这个是很优雅的设计(相当于一个协变类型的 map)。下面我们看看如何给 context 带上自定义的信息。

Element 是集合里的内容:

interface CoroutineContext {
    // ...

    /**
     * An element of the [CoroutineContext]. An element of the coroutine context is a singleton context by itself.
     */
    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
    }
}

实现它很简单:

class CoroutineName(val name: String) : CoroutineContext.Element {
    // companion object 是一个类对象,理所应当的,它能继承其他类
    companion object : CoroutineContext.Key<CoroutineName>
    override val key = CoroutineName
}

fun main() = runBlocking {
    GlobalScope.launch(Dispatchers.IO + CoroutineName("my coroutine")) {
        // CoroutineName 的 companion object 继承的是 Key<CoroutineName>,
        // 所以 coroutineContext[CoroutineName] 的类型是 CoroutineName?
        val name = coroutineContext[CoroutineName]?.name ?: "no name"
        println("name = $name")
    }
    Unit
}
// 打印:
// name = my coroutine

// 或者更常见的:
// 这里的 + 使用的是 CoroutineContext 里定义的 operator plus
someCoroutineScope.launch(Dispatchers.IO + CoroutineName("my coroutine")) {
    val name = coroutineContext[CoroutineName]?.name ?: return
    // ...
}

由于这种定义 context 是固定的模型,kotlin 还提供了一个便捷类:

class CoroutineName(val name: String) : AbstractCoroutineContextElement(CoroutineName) {
    companion object : CoroutineContext.Key<CoroutineName>
}

关于协程上下文,最后还剩下的问题是,我们如何拿到它。其中一种方法在上面的例子中我们已经看到:

public interface CoroutineScope {
    /**
     * The context of this scope.
     */
    public val coroutineContext: CoroutineContext
}

传递给 CoroutineScope.launch() 的 lambda 有一个类型为 CoroutineScope 的 receiver,这就是前面我们能够直接使用 coroutineContext 的原因。

另一个获取 context 的途径是 Continuation,例如:

interface Callback {
    fun onResult(enabled: Boolean)
}
fun isFeatureXEnabled(callback: Callback) {
    // ...
}

suspend fun isFeatureXEnabled() = suspendCoroutine { conn: Continuation<Boolean> ->
    isFeatureXEnabled(object : Callback {
        override fun onResult(enabled: Boolean) {
            val context = conn.context
            conn.resume(enabled)
        }
    })
}

Continuationcontext 字段就是 CoroutineContext

@SinceKotlin("1.3")
public interface Continuation<in T> {
    public val context: CoroutineContext
    public fun resumeWith(result: Result<T>)
}

关于协程上下文的内容差不多就是这些了,如果读者有想分享出来的内容,欢迎给我留言。

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

推荐阅读更多精彩内容