为什么要心跳检测机制
当服务端接收到客户端的连接以后,会与客户端建立 NioSocketChannel 数据传输的双工通道,但是如果连接建立以后,客户端一直不给服务端发送消息,这种情况下是占用了资源,属于空闲连接,服务端有权将其关闭掉。但服务端直接将其关闭,这样不够友好,因此需要建立客户端与服务端之间的心跳机制。
服务端检测客户端是否为空闲连接
当服务端指定时间内(如60s)没有接收到客户端发送的读事件,就触发 chatServerChannelDuplexHandler (自定义的handler) 中的 userEventTriggered 方法。
ch.pipeline().addLast(new IdleStateHandler(60, 0, 0, TimeUnit.SECONDS));
ch.pipeline().addLast(chatServerChannelDuplexHandler);
空闲连接状态检测 handler (IdleStateHandler)参数解释
- 1:多长时间没有触发读事件
- 2:多长时间没有触发写事件(填0 ,则表示不触发此时间,其他同理)
- 3:多长时间没有触发读写事件
- 4:时间单位
appCheckTcpServerChannelHandler(自定义的handler)
是自定义的处理入站出站的 handler,继承了 ChannelDuplexHandler,能处理入站出站操作,实现 userEventTriggered 方法,在读写事件触发时,会调用这个方法。这里需要判断一下被触发的事件,因为这里是一个出入站都能接收的事件方法,存在读或写事件。如果是读事件超过 60s 没有被触发,则关闭与客户端的连接。
@Override
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
if (evt instanceof IdleStateEvent) {
IdleStateEvent event = (IdleStateEvent) evt;
if (IdleState.READER_IDLE == event.state()) {
log.info("[日志] appCheck server READER_IDLE 读超时");
ctx.channel().close();
}
} else {
super.userEventTriggered(ctx, evt);
}
}
**注意:**自定义事件触发方法的 handler 必须在 IdleStateHandler 之后添加到 pipeline 中,否则该 handler 中的 userEventTriggered 不会执行,因为在翻看源码的时候,会将事件的处理转给 pipline 中的下一个 handler,如果该 handler 在 IdleStateHandler 添加之前添加,就无法找到,就不会执行。
protected void channelIdle(ChannelHandlerContext ctx, IdleStateEvent evt) throws Exception {
// 将当前事件转给下一个 handler 的 userEventTriggered 方法
ctx.fireUserEventTriggered(evt);
}
客户端给服务端发送心跳数据
这里的 handler 也是出入站都会触发,因此事件方法中需要判断是否属于写事件,才会给服务端发送心跳数据。
@Slf4j
@ChannelHandler.Sharable
public class ChatClientChannelDuplexHandler extends ChannelDuplexHandler {
@Override
public void userEventTriggered(ChannelHandlerContext ctx, Object evt) throws Exception {
if (evt instanceof IdleStateEvent) {
IdleStateEvent idleStateEvent = (IdleStateEvent) evt;
if (IdleState.WRITER_IDLE.equals(idleStateEvent.state())) {
//给服务端发送心跳请求
ctx.writeAndFlush(new PingRequestMessage());
}
} else {
super.userEventTriggered(ctx, evt);
}
}
}