如何为Kotlin的coroutineScope父协程设置名称？

在使用launch时，我们可以直接通过CoroutineName为协程命名：

launch(CoroutineName("test")) { ... }

但coroutineScope本身不支持直接传入命名参数，默认会显示类似job = "coroutine#1":ScopeCoroutine{Active}@5bf76be8的匿名标识。最简的解决方法是结合withContext(CoroutineName(...))来为coroutineScope设置名称，具体有两种常用方式：

方式一：用withContext包裹coroutineScope #

这种方式会让coroutineScope对应的协程直接继承设置的名称，调试器中会显示你指定的名称：

suspend fun test() = withContext(CoroutineName("test-scope")) {
    coroutineScope {
        // 这里的所有子协程也会继承该名称上下文
        launch {
            // 业务逻辑
        }
    }
}

方式二：在coroutineScope内部使用withContext #

如果只需要给coroutineScope内的特定代码块命名，可以在内部直接用withContext：

suspend fun test() = coroutineScope {
    withContext(CoroutineName("test-block")) {
        // 目标业务逻辑
    }
}

进阶复用：自定义扩展函数 #

如果需要频繁给coroutineScope命名，可以封装一个扩展函数，简化调用：

suspend fun <T> namedCoroutineScope(name: String, block: suspend CoroutineScope.() -> T): T =
    withContext(CoroutineName(name)) {
        coroutineScope(block)
    }

调用时直接使用：

suspend fun test() = namedCoroutineScope("test-scope") {
    // 业务逻辑
}

内容的提问来源于stack exchange，提问作者underflow