Spring MVC中Kotlin协程请求与响应线程不一致问题求助

问题背景 #

• 开发环境：
  • Spring Boot 2.6.1
  • Kotlin 1.6.0
• 核心现象：suspend函数中，请求初始线程为http-nio-port-exec-1，调用WebClient切换到reactor-1线程，抛出异常后@ExceptionHandler运行在http-nio-port-exec-2线程，线程上下文不一致导致MDC、traceId无法跨线程传递，链路追踪中断。

解决方案 #

1. 自定义协程上下文传播器，同步MDC与链路追踪信息 #

协程切换线程时不会自动传递MDC这类线程本地变量，需自定义协程上下文元素和拦截器实现手动传递：

定义MDC上下文元素

class MdcContext(val contextMap: Map<String, String>) : CoroutineContext.Element {
    companion object Key : CoroutineContext.Key<MdcContext>
    override val key: CoroutineContext.Key<*> = Key
}

实现协程上下文拦截器

class MdcCoroutineInterceptor : ContinuationInterceptor {
    override val key: CoroutineContext.Key<*> = ContinuationInterceptor

    override fun <T> interceptContinuation(continuation: Continuation<T>): Continuation<T> =
        object : Continuation<T> by continuation {
            override fun resumeWith(result: Result<T>) {
                // 取出协程上下文中保存的MDC信息
                val mdcContext = continuation.context[MdcContext]
                // 保存当前线程原始MDC
                val originalMdc = MDC.getCopyOfContextMap()

                try {
                    // 恢复协程上下文的MDC到当前线程
                    mdcContext?.let { MDC.setContextMap(it.contextMap) }
                    // 继续执行协程
                    continuation.resumeWith(result)
                } finally {
                    // 恢复当前线程原始MDC
                    originalMdc?.let { MDC.setContextMap(it) } ?: MDC.clear()
                }
            }
        }
}

2. 配置Spring协程上下文，自动注入自定义传播器 #

通过CoroutineContextCustomizer把自定义的MDC上下文和拦截器加入到Spring管理的协程上下文中：

@Component
class MdcCoroutineContextCustomizer : CoroutineContextCustomizer {
    override fun customize(context: CoroutineContext): CoroutineContext {
        // 从当前请求线程的MDC中获取上下文，加入到协程上下文
        return context + MdcContext(MDC.getCopyOfContextMap()) + MdcCoroutineInterceptor()
    }
}

3. 调整异常处理器，使其运行在协程上下文 #

把@ExceptionHandler方法改为suspend函数，Spring会自动在协程上下文中调用它，此时就能获取到传递过来的MDC和trace信息：

@ExceptionHandler(Exception::class)
suspend fun handleException(ex: Exception): ResponseEntity<ErrorResponse> {
    // 此时线程可能仍会切换，但MDC已通过协程上下文传递
    val traceId = MDC.get("traceId")
    return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR)
        .body(ErrorResponse(traceId, ex.message ?: "未知异常"))
}

额外注意事项 #

• 确保链路追踪的traceId存储在MDC中，这样自定义传播器就能自动同步
• 若使用Spring Cloud Sleuth等链路追踪组件，可替换上述MDC逻辑为Sleuth原生上下文传递机制
• 其他线程本地变量的传递，可参考上述模式扩展协程上下文元素

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