如何在Ktor路由处理器中运行后台任务及管控长时任务生命周期

1. 在路由处理器中运行后台任务 #

直接在路由处理逻辑中启动后台任务时，不要使用请求上下文的协程作用域（call.coroutineContext）——因为请求结束后该作用域会被自动取消，导致未完成的任务中断。

正确的做法是使用Ktor应用级的协程作用域，它与应用生命周期绑定，不受单个请求的影响：

routing {
    get("/start-background-task") {
        // 借助应用实例的launch方法启动后台任务
        call.application.launch {
            // 后台任务逻辑，比如异步处理文件、调用外部API
            delay(3000)
            println("后台任务执行完毕")
        }
        // 立即给客户端返回响应，无需等待任务完成
        call.respondText("后台任务已启动")
    }
}

2. 绑定长时任务到服务器/应用生命周期 #

如果需要任务与整个应用同生共死（应用启动时可初始化，关闭时自动终止），可以自定义一个全局的应用级协程作用域：

// 定义全局作用域的属性键
private val AppGlobalScopeKey = AttributeKey<CoroutineScope>("AppGlobalScopeKey")

// 扩展Application，获取或创建全局协程作用域
val Application.globalScope: CoroutineScope
    get() = attributeOrNull(AppGlobalScopeKey) ?: run {
        // 使用SupervisorJob确保子任务异常不扩散
        val scope = CoroutineScope(SupervisorJob() + Dispatchers.Default)
        attributes.put(AppGlobalScopeKey, scope)
        // 监听应用停止事件，自动取消全局作用域的所有任务
        environment.monitor.subscribe(ApplicationStopping) {
            scope.cancel("应用即将关闭")
        }
        scope
    }

// 在路由中使用全局作用域启动长时任务
routing {
    get("/start-long-task") {
        call.application.globalScope.launch {
            // 长时任务逻辑，比如定时数据同步、消息监听
            while (isActive) {
                println("长时任务运行中...")
                delay(10000)
            }
        }
        call.respondText("长时任务已启动")
    }
}

当应用关闭时，globalScope会被自动取消，所有关联的长时任务也会终止。

3. 避免兄弟任务异常导致取消 #

默认的Job会在任一子任务抛出未捕获异常时，取消整个作用域内的所有兄弟任务。要避免这种情况，核心是使用**SupervisorJob**：

• SupervisorJob仅会取消出错的子任务，其他兄弟任务不受影响
• 配合CoroutineExceptionHandler捕获异常，防止异常传播到作用域

示例代码：

// 全局异常处理器，捕获任务中的未处理异常
val taskExceptionHandler = CoroutineExceptionHandler { _, throwable ->
    println("任务执行出错：${throwable.message}")
}

// 使用带SupervisorJob的作用域
val safeScope = CoroutineScope(SupervisorJob() + Dispatchers.Default)

// 启动两个兄弟任务
safeScope.launch(taskExceptionHandler) {
    // 模拟任务1抛出异常
    throw RuntimeException("任务1执行失败")
}

safeScope.launch {
    delay(1500)
    println("任务2执行成功") // 不受任务1异常影响，会正常执行
}

在自定义的应用级globalScope中已经使用了SupervisorJob，所以基于它启动的后台任务默认就是相互隔离的，单个任务异常不会连累其他任务。

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