如何不使用JVM debug参数在日志中输出Kotlin协程名称

不需要开启-Dkotlinx.coroutines.debug JVM参数，通过MDC（映射调试上下文）+ 协程上下文传递+日志框架配置即可实现协程名打印，性能比debug模式更好，生产环境可用，具体实现步骤如下：

1. 引入协程SLF4J适配依赖 #

首先引入官方提供的kotlinx-coroutines-slf4j依赖，用来解决协程切换线程时的MDC上下文传递问题，注意依赖版本需要和你项目中使用的kotlinx-coroutines-core版本保持一致。
Gradle配置：

dependencies {
    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-slf4j:1.7.3")
}

Maven配置：

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-coroutines-slf4j</artifactId>
    <version>1.7.3</version>
</dependency>

2. 实现协程名自动注入MDC #

自定义协程上下文元素，在协程绑定到执行线程时，自动把协程上下文中的CoroutineName写入MDC，协程执行完成后清理对应MDC字段，避免线程复用时字段串扰：

import kotlinx.coroutines.CoroutineContext
import kotlinx.coroutines.CoroutineName
import kotlinx.coroutines.ThreadContextElement
import kotlinx.coroutines.slf4j.MDCContext
import org.slf4j.MDC

class CoroutineNameMdcElement : ThreadContextElement<Unit> {
    companion object Key : CoroutineContext.Key<CoroutineNameMdcElement>
    override val key: CoroutineContext.Key<*> = Key

    override fun updateThreadContext(context: CoroutineContext) {
        val coroutineName = context[CoroutineName]?.name ?: "unnamed"
        MDC.put("coroutineName", coroutineName)
    }

    override fun restoreThreadContext(context: CoroutineContext, oldState: Unit) {
        MDC.remove("coroutineName")
    }
}

// 封装业务全局协程Scope，默认注入MDC上下文元素，业务侧直接使用该Scope启动协程即可
val appScope = CoroutineScope(
    Dispatchers.Default + CoroutineNameMdcElement() + MDCContext()
)

MDCContext()用来保证协程切换线程时，其他MDC字段（如链路追踪traceId）也能正常传递，不会出现上下文丢失。

3. 配置日志框架读取MDC字段打印 #

Logback配置 #

修改logback.xml，在日志输出pattern中加入%X{coroutineName}占位符即可：

<configuration>
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{coroutineName}] %-5level %logger{36} - %msg%n</pattern>
        </encoder>
    </appender>
    <root level="info">
        <appender-ref ref="CONSOLE" />
    </root>
</configuration>

Spring Boot配置文件方式 #

如果是Spring Boot项目，不需要单独写logback.xml，直接在application.properties中配置日志格式即可：

logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{coroutineName}] %-5level %logger{36} - %msg%n
logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%X{coroutineName}] %-5level %logger{36} - %msg%n

4. 业务使用 #

启动协程时传入CoroutineName指定协程名，日志中就会自动打印对应名称：

appScope.launch(CoroutineName("order-payment-handler")) {
    log.info("开始处理支付回调") // 日志输出会自带[order-payment-handler]标识
    // 业务逻辑
}

• 该方案性能远高于开启debug JVM参数的模式：debug参数会在协程创建、调度切换时生成大量额外调试信息，仅适合本地开发临时使用，不适合生产环境；MDC注入方案几乎无额外性能开销，生产环境可直接部署。
• 若不想自定义CoroutineNameMdcElement，也可在协程执行逻辑内手动调用MDC接口赋值协程名，但统一封装协程Scope的方式可避免遗漏，维护成本更低。
• 协程内部通过withContext切换调度线程（如切到Dispatchers.IO）时，MDC上下文会自动传递，不需要额外做适配。

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