Server Plugin

HTTP 请求生命周期

必需依赖项: io.ktor:ktor-server-core

代码示例: server-http-request-lifecycle

支持的引擎: Netty, CIO

原生服务器

Ktor 支持 Kotlin/Native，允许您在没有额外运行时或虚拟机的情况下运行服务器。

支持: ✖️

默认情况下，即使客户端断开连接，Ktor 也会继续处理请求。 HttpRequestLifecycle 插件允许您在客户端断开连接时立即取消请求处理。

这对于长时间运行或资源密集型的请求非常有用，这些请求在客户端不再等待响应时应当停止执行。

安装并配置 HttpRequestLifecycle

要启用 HttpRequestLifecycle 插件，请使用 install 函数将其安装在您的应用程序模块中，并设置 cancelCallOnClose 属性：

import io.ktor.server.application.*
import io.ktor.server.http.HttpRequestLifecycle

fun Application.module() {
    install(HttpRequestLifecycle) {
        cancelCallOnClose = true
    }
}

启用 cancelCallOnClose 属性后，HttpRequestLifecycle 插件会为每个请求安装一个取消处理程序。当客户端断开连接时，只有处理该特定路由的协程会被取消。

取消会通过结构化并发传播，因此从请求协程启动的任何子协程（例如，使用 launch 或 async）也会被取消。在下一个挂起点会抛出 CancellationException。

处理取消

您可以捕获 CancellationException 来执行清理操作，例如释放资源或停止后台工作：

fun Application.module() {
    install(HttpRequestLifecycle) {
        cancelCallOnClose = true
    }

    routing {
        get("/long-process") {
            try {
                while (isActive) {
                    delay(10_000)
                    log.info("Very important work.")
                }
                call.respond("Completed")
            } catch (e: CancellationException) {
                log.info("Cleaning up resources.")
            }
        }
    }
}

协程取消是协作式的。阻塞或 CPU 密集型代码不会自动中断。 如果请求处理执行长时间运行的工作，请调用 call.coroutineContext.ensureActive() 以响应取消。

要了解更多信息，请参阅 协程取消。

有关完整示例，请参阅 server-http-request-lifecycle。

限制

此插件仅在 CIO 和 Netty 引擎上得到完全支持。基于 servlet 的引擎（或其他不支持的引擎）无法可靠地检测客户端断开连接。只有当服务器尝试写入响应时，才能检测到取消。