netty 中的心跳检测机制

63 阅读 0 评论 42 点赞

我是靠谱客的博主纯情曲奇，最近开发中收集的这篇文章主要介绍netty 中的心跳检测机制，觉得挺不错的，现在分享给大家，希望可以做个参考。

概述

为什么要心跳检测机制

当服务端接收到客户端的连接以后，与客户端建立 NioSocketChannel 数据传输的双工通道，但是如果连接建立以后，客户端一直不给服务端发送消息，这种情况下是占用了资源，属于空闲连接，服务端有权将其关闭掉。

不过有时候，客户端的用户可能是临时离开一会，当超过服务端限制的时间后，服务端将其关闭，这样也不够友好，因此需要建立客户端与服务端之间的心跳机制。

服务端-检测客户端是否属于空闲连接

当服务端 60s 没有接收到客户端发送的读事件，就触发 chatServerChannelDuplexHandler 中的 userEventTriggered 方法。

ch.pipeline().addLast(new IdleStateHandler(60, 0, 0, TimeUnit.SECONDS));
ch.pipeline().addLast(chatServerChannelDuplexHandler);

第一个空闲连接状态检测 handler 参数解释

多长时间没有触发读事件
多长时间没有触发写事件
多长时间没有触发读写事件
时间单位

如果填 0，则不触发该事件

第二个 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()) {
            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 {
    	ctx.fireUserEventTriggered(evt);
}

ctx.fireUserEventTriggered：将当前事件转给下一个 handler 的 userEventTriggered 方法。

客户端-给服务端发送心跳包

方法跟服务端检测客户端是否读事件发生差不多。
30s 没有发生写事件时，触发事件方法，像客户端传输一个心跳数据，当服务端感知到读事件发生，60s以后就不会断开与客户端之间的连接。
为啥设置 30s，是因为一般客户端发送心跳包的时间是服务端检测时间的 1/2。

ch.pipeline().addLast(new IdleStateHandler(0, 30, 0));
ch.pipeline().addLast(new ChatClientChannelDuplexHandler());

客户端给服务端发送心跳数据

这里的 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);
        }
    }
}