如何在Ktor请求中监听SSE客户端断开事件以停止推送并清理资源？

这个问题确实是Ktor SSE场景里常见的痛点——默认情况下只有在发送下一次事件时才会检测到客户端断开，导致不必要的资源消耗。不过好在有几种可靠的方式来监听客户端断开事件，及时停止发送SSE并清理相关资源：

1. 利用协程取消机制（推荐） #

Ktor的请求处理逻辑是运行在协程中的，当客户端主动断开连接（比如关闭浏览器窗口），对应的请求协程会被自动取消。我们可以利用这个特性，在发送SSE的循环中检查协程状态，或者直接捕获协程取消异常来触发清理操作。

示例代码：

get("/sse") {
    call.respondTextWriter(contentType = ContentType.Text.EventStream) {
        try {
            while (true) {
                // 检查协程是否仍处于活跃状态，客户端断开会触发协程取消
                coroutineContext.ensureActive()
                
                // 发送SSE事件
                write("data: 当前时间: ${System.currentTimeMillis()}\n\n")
                flush()
                
                delay(1000) // 每秒发送一次事件
            }
        } catch (e: CancellationException) {
            // 客户端断开连接，执行资源清理逻辑
            println("客户端已断开，开始清理资源")
            // 示例：取消订阅、关闭数据库连接、释放缓存等
        }
    }
}

这种方式和Ktor的生命周期深度绑定，是最可靠的方案，不需要额外的状态检查。

2. 主动检查连接状态 #

你也可以直接通过call.request.connection.isClosed属性来判断客户端连接是否已经关闭，在发送循环中加入这个检查：

示例代码：

get("/sse") {
    call.respondTextWriter(contentType = ContentType.Text.EventStream) {
        while (!call.request.connection.isClosed) {
            write("data: 当前时间: ${System.currentTimeMillis()}\n\n")
            flush()
            
            delay(1000)
        }
        
        // 连接关闭后执行清理
        println("客户端连接已关闭，清理资源")
    }
}

不过要注意，isClosed的状态更新可能存在微小延迟，所以更建议和协程取消机制结合使用，双重保障。

3. 注册连接关闭回调 #

Ktor的Connection对象提供了onClose方法，可以注册一个回调函数，当连接关闭时立即触发：

示例代码：

get("/sse") {
    // 模拟需要清理的资源，比如一个后台订阅任务
    val backgroundJob = launch {
        println("初始化后台资源")
        awaitCancellation() // 等待取消信号
        println("清理后台资源")
    }

    // 注册连接关闭回调，触发资源清理
    call.request.connection.onClose {
        backgroundJob.cancel()
    }

    call.respondTextWriter(contentType = ContentType.Text.EventStream) {
        try {
            while (true) {
                coroutineContext.ensureActive()
                write("data: 当前时间: ${System.currentTimeMillis()}\n\n")
                flush()
                delay(1000)
            }
        } catch (e: CancellationException) {
            // 协程取消时也清理资源
            backgroundJob.cancel()
        }
    }
}

这种方式适合需要提前感知连接关闭、执行异步清理操作的场景。

总结 #

最推荐的方式是结合协程取消机制，因为它和Ktor的请求生命周期完全同步，能准确捕获客户端断开事件。如果需要更精细化的控制，可以搭配连接状态检查或onClose回调，确保资源被及时释放。

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