如何在Ktor(Netty)服务端配置keep-alive超时时间

关于tcpKeepAlive配置的参数说明 #

Netty配置项中的布尔值tcpKeepAlive是操作系统原生TCP层的开关，并非应用层可自定义超时的配置项：

• 开启该选项后，TCP KeepAlive的探测触发时长、探测间隔、重试次数均由操作系统内核参数控制，Ktor与Netty无权单独修改
• Linux系统下对应控制参数为net.ipv4.tcp_keepalive_time（首次探测前的空闲等待时长）、net.ipv4.tcp_keepalive_intvl（探测包发送间隔）、net.ipv4.tcp_keepalive_probes（最大探测重试次数），Windows、macOS也存在各自的系统级TCP配置项。修改这类参数会影响主机上所有开启TCP KeepAlive的应用，因此配置说明中会提示需要用户调整主机参数
• 系统级TCP KeepAlive的默认超时时间普遍过长（Linux默认值为2小时），无法满足业务服务快速清理空闲连接的需求，因此才会出现自定义空闲连接检测的相关方案。

应用层Keep-Alive超时配置方案 #

不需要修改系统参数，直接通过Ktor的Netty引擎配置即可实现应用粒度的长连接超时控制，代码示例如下：

import io.netty.channel.ChannelInboundHandlerAdapter
import io.netty.handler.timeout.IdleStateEvent
import io.netty.handler.timeout.IdleStateHandler
import io.ktor.server.engine.embeddedServer
import io.ktor.server.netty.Netty
import java.util.concurrent.TimeUnit

fun main() {
    embeddedServer(Netty, port = 8080, configure = {
        // 开启系统级TCP KeepAlive作为兜底，清理无感知的死连接
        tcpKeepAlive = true
        // 配置HTTP协议层长连接超时
        httpServerCodec = {
            // 单位为秒，设置HTTP长连接空闲120秒后主动断开，可按需调整
            it.keepAliveTimeout(120)
        }
        // 配置底层连接空闲检测，覆盖无HTTP请求的异常连接场景
        channelPipelineConfig = {
            // 读空闲60秒即触发空闲事件，可按需调整阈值
            addLast("idleStateHandler", IdleStateHandler(60, 0, 0, TimeUnit.SECONDS))
            addLast("idleConnectionHandler", object : ChannelInboundHandlerAdapter() {
                override fun userEventTriggered(ctx: ChannelHandlerContext, evt: Any) {
                    if (evt is IdleStateEvent) {
                        ctx.close()
                    }
                    super.userEventTriggered(ctx, evt)
                }
            })
        }
    }) {
        // 路由、插件等业务配置
    }.start(wait = true)
}

配置说明 #

• HTTP层的keepAliveTimeout仅对当前Ktor服务生效，无需修改任何系统参数，是常规业务场景下的首选配置
• 额外添加的IdleStateHandler属于Netty原生能力，在Ktor引入Netty引擎依赖时可直接使用，无需额外引入第三方包，可覆盖连接建立后不发送任何有效请求的异常连接场景
• 系统级tcpKeepAlive建议保持开启作为兜底策略，用来清理被NAT、防火墙等中间节点静默断开、应用层无法感知的死连接即可，无需特意修改系统内核参数。

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