如何在CoroutineExceptionHandler中获取失败子协程的名称？

我给CoroutineScope添加了CoroutineExceptionHandler，原本可以通过Context获取CoroutineName来识别失败的协程，操作很便捷。但在使用结构化并发嵌套协程时，获取到的名称却是父协程的，而非实际失败的子协程名称。我希望能知晓具体失败的子协程，有没有办法获取失败子协程的Context而非父协程的？

简化后的示例代码如下：

import kotlinx.coroutines.CoroutineExceptionHandler
import kotlinx.coroutines.CoroutineName
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.delay
import kotlinx.coroutines.joinAll
import kotlinx.coroutines.launch
import java.util.concurrent.CompletableFuture
import kotlin.coroutines.CoroutineContext

val awaiter = CompletableFuture<Void>()

val exceptionHandler: CoroutineExceptionHandler
    get() = CoroutineExceptionHandler { context, t ->
        val name = context[CoroutineName.Key]?.name
        println("Actual Failure in coroutine $name")
        awaiter.complete(null)
    }

val coroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.IO + exceptionHandler)

val clientName = "client1"

fun main() {
    coroutineScope.launch(CoroutineName("HandleClient-$clientName")) {
        val task1 = launch(CoroutineName("Task1-$clientName") + exceptionHandler) {
            println("Expect Failure in coroutine Task1-$clientName")
            throw RuntimeException("I failed")
        }

        val task2 = launch(CoroutineName("Task2-$clientName") + exceptionHandler) {
            delay(1000)
        }

        joinAll(task1, task2)
        awaiter.get()
    }
}

问题核心原因 #

结构化并发机制下，子协程的CoroutineExceptionHandler不会被触发。子协程抛出的异常会向上传播到父协程，最终由父协程的Handler处理，因此你拿到的是父协程的Context。这是Kotlin协程的设计规则：只有直接在CoroutineScope下启动的顶级协程，其ExceptionHandler才会生效，嵌套子协程的Handler会被忽略。

具体解决方法 #

方法1：为子协程创建独立的CoroutineScope #

让子协程成为独立的顶级协程，使其自身的ExceptionHandler生效，从而获取到子协程的Context：

val task1 = CoroutineScope(coroutineContext + CoroutineName("Task1-$clientName") + exceptionHandler).launch {
    println("Expect Failure in coroutine Task1-$clientName")
    throw RuntimeException("I failed")
}

修改后，ExceptionHandler收到的context就是子协程的上下文，能正确输出Task1-client1的名称。

方法2：在子协程内部捕获异常 #

直接在子协程中用try-catch捕获异常，通过coroutineContext直接获取当前协程的信息，无需依赖外部ExceptionHandler：

val task1 = launch(CoroutineName("Task1-$clientName")) {
    try {
        println("Expect Failure in coroutine Task1-$clientName")
        throw RuntimeException("I failed")
    } catch (t: Throwable) {
        val name = coroutineContext[CoroutineName.Key]?.name
        println("Actual Failure in coroutine $name")
        awaiter.complete(null)
    }
}

这种方式更直接，能准确拿到失败子协程的名称，同时保留结构化并发的特性。

修改后的完整示例（方法1版本） #

import kotlinx.coroutines.CoroutineExceptionHandler
import kotlinx.coroutines.CoroutineName
import kotlinx.coroutines.CoroutineScope
import kotlinx.coroutines.Dispatchers
import kotlinx.coroutines.SupervisorJob
import kotlinx.coroutines.delay
import kotlinx.coroutines.joinAll
import kotlinx.coroutines.launch
import java.util.concurrent.CompletableFuture
import kotlin.coroutines.CoroutineContext

val awaiter = CompletableFuture<Void>()

val exceptionHandler: CoroutineExceptionHandler
    get() = CoroutineExceptionHandler { context, t ->
        val name = context[CoroutineName.Key]?.name
        println("Actual Failure in coroutine $name")
        awaiter.complete(null)
    }

val coroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.IO + exceptionHandler)

val clientName = "client1"

fun main() {
    coroutineScope.launch(CoroutineName("HandleClient-$clientName")) {
        // 为子协程创建独立CoroutineScope
        val task1 = CoroutineScope(coroutineContext + CoroutineName("Task1-$clientName") + exceptionHandler).launch {
            println("Expect Failure in coroutine Task1-$clientName")
            throw RuntimeException("I failed")
        }

        val task2 = launch(CoroutineName("Task2-$clientName")) {
            delay(1000)
        }

        joinAll(task1, task2)
        awaiter.get()
    }
}

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