山东大学Netty 心跳(heartbeat)服务源码剖析

最新推荐文章于 2023-01-08 16:55:24 发布

fangjiayou

最新推荐文章于 2023-01-08 16:55:24 发布

阅读量620

点赞数 3

分类专栏： Netty 2021SC@SDUSC 文章标签： java netty 源码

本文链接：https://blog.csdn.net/fangjiayou/article/details/120769961

版权

2021SC@SDUSC 同时被 2 个专栏收录

17 篇文章 0 订阅

订阅专栏

Netty

10 篇文章 0 订阅

订阅专栏

2021SC@SDUSC

Netty 心跳(heartbeat)服务源码剖析

1 源码剖析目的

Netty 作为一个网络框架，提供了诸多功能，比如编码解码等，Netty 还提供了非常重要的一个服务——心跳机制 heartbeat。通过心跳检查对方是否有效（检查客户端和服务器端是否有效），这是 RPC 框架中是必不可少的功能。下面我们分析一下 Netty内部心跳服务源码实现。

2 源码剖析说明

Netty 提供了 IdleStateHandler ，ReadTimeoutHandler，WriteTimeoutHandler 三个 Handler 检测连接的有效性，重点分析 IdleStateHandler .
如图
在这里插入图片描述

ReadTimeout 事件和 WriteTimeout 事件都会自动关闭连接，而且属于异常处理，所以，这里只是介绍一下，我们重点看 IdleStateHandler。

IdleStateHandler 分析

4 个属性

private final boolean observeOutput; //是否考虑出站时较慢的情况。默认值是 false 
private final long readerIdleTimeNanos;//读事件空闲时间，0 则禁用事件，不去监测
private final long writerIdleTimeNanos;//写事件空闲时间，0 则禁用事件	
private final long allIdleTimeNanos;//纳秒，十亿分之一秒，读或写空闲时间，0 则禁用事件

handlerAdded 方法

当该 handler 被添加到 pipeline 中时，则调用 initialize 方法

private void initialize(ChannelHandlerContext ctx) {
    // Avoid the case where destroy() is called before scheduling timeouts.
    // See: https://github.com/netty/netty/issues/143
    switch (state) {
    case 1:
    case 2:
        return;
    }

    state = 1;
    initOutputChanged(ctx);

    lastReadTime = lastWriteTime = ticksInNanos();
    if (readerIdleTimeNanos > 0) {
    	// 这里的 schedule 方法会调用 eventLoop 的 schedule 方法，将定时任务添加到队列中
        readerIdleTimeout = schedule(ctx, new ReaderIdleTimeoutTask(ctx),
                readerIdleTimeNanos, TimeUnit.NANOSECONDS);
    }
    if (writerIdleTimeNanos > 0) {
        writerIdleTimeout = schedule(ctx, new WriterIdleTimeoutTask(ctx),
                writerIdleTimeNanos, TimeUnit.NANOSECONDS);
    }
    if (allIdleTimeNanos > 0) {
        allIdleTimeout = schedule(ctx, new AllIdleTimeoutTask(ctx),
                allIdleTimeNanos, TimeUnit.NANOSECONDS);
    }
}

只要给定的参数大于 0，就创建一个定时任务，每个事件都创建。同时，将 state 状态设置为 1，防止重复初始化。调用 initOutputChanged 方法，初始化 “监控出站数据属性”。

该类内部的 3 个定时任务类

在这里插入图片描述

这 3 个定时任务分别对应读，写，读或写事件。共有一个父类(AbstractIdleTask)。这个父类AbstractIdleTask提供了一个模板方法，如下

private abstract static class AbstractIdleTask implements Runnable {

   private final ChannelHandlerContext ctx;

    AbstractIdleTask(ChannelHandlerContext ctx) {
        this.ctx = ctx;
    }

    @Override
    public void run() {
        if (!ctx.channel().isOpen()) {
            return;
        }

        run(ctx);
    }

    protected abstract void run(ChannelHandlerContext ctx);
}
说明： 当通道关闭了，就不执行任务了。反之，执行子类的 run  方法

读事件的 run 方法（即 ReaderIdleTimeoutTask 的 run 方法）分析

代码及其说明

@Override
protected void run(ChannelHandlerContext ctx) {
    long nextDelay = readerIdleTimeNanos;
    if (!reading) {
        nextDelay -= ticksInNanos() - lastReadTime;
    }

    if (nextDelay <= 0) {
        // Reader is idle - set a new timeout and notify the callback.
        readerIdleTimeout = schedule(ctx, this, readerIdleTimeNanos, TimeUnit.NANOSECONDS);

        boolean first = firstReaderIdleEvent;
        firstReaderIdleEvent = false;

        try {
            IdleStateEvent event = newIdleStateEvent(IdleState.READER_IDLE, first);
            channelIdle(ctx, event);
        } catch (Throwable t) {
            ctx.fireExceptionCaught(t);
        }
    } else {
        // Read occurred before the timeout - set a new timeout with shorter delay.
        readerIdleTimeout = schedule(ctx, this, nextDelay, TimeUnit.NANOSECONDS);
    }
}

说明：

得到用户设置的超时时间。long nextDelay = readerIdleTimeNanos;
如果读取操作结束了（执行了 channelReadComplete 方法设置），就用当前时间减去给定时间和最后一次读（执操作的时间行了 channelReadComplete 方法设置）， nextDelay -= ticksInNanos() - lastReadTime;
如果小于 0，就触发事件。反之，继续放入队列。间隔时间是新的计算时间。
触发的逻辑是：首先将任务再次放到队列，时间是刚开始设置的时间，返回一个 promise 对象，用于做取消操作。然后，设置 first 属性为 false ，表示，下一次读取不再是第一次了，这个属性在 channelRead 方法会被改成 true。
创建一个 IdleStateEvent 类型的写事件对象，将此对象传递给用户的 UserEventTriggered 方法。完成触发事件的操作。
总的来说，每次读取操作都会记录一个时间，定时任务时间到了，会计算当前时间和最后一次读的时间的间隔，如果间隔超过了设置的时间，就触发 UserEventTriggered 方法。

写事件的 run 方法(即 WriterIdleTimeoutTask 的 run 方法)分析

@Override
protected void run(ChannelHandlerContext ctx) {

    long lastWriteTime = IdleStateHandler.this.lastWriteTime;
    long nextDelay = writerIdleTimeNanos - (ticksInNanos() - lastWriteTime);
    if (nextDelay <= 0) {
        // Writer is idle - set a new timeout and notify the callback.
        writerIdleTimeout = schedule(ctx, this, writerIdleTimeNanos, TimeUnit.NANOSECONDS);

        boolean first = firstWriterIdleEvent;
        firstWriterIdleEvent = false;

        try {
            if (hasOutputChanged(ctx, first)) {
                return;
            }

            IdleStateEvent event = newIdleStateEvent(IdleState.WRITER_IDLE, first);
            channelIdle(ctx, event);
        } catch (Throwable t) {
            ctx.fireExceptionCaught(t);
        }
    } else {
        // Write occurred before the timeout - set a new timeout with shorter delay.
        writerIdleTimeout = schedule(ctx, this, nextDelay, TimeUnit.NANOSECONDS);
    }
}

说明：
写任务的 run 代码逻辑基本和读任务的逻辑一样， 唯一不同的就是有一个针对 出站较慢数据的判断
hasOutputChanged

所有事件的 run 方法(即 AllIdleTimeoutTask 的 run 方法)分析代码分析

@Override
protected void run(ChannelHandlerContext ctx) {

    long nextDelay = allIdleTimeNanos;
    if (!reading) {
        nextDelay -= ticksInNanos() - Math.max(lastReadTime, lastWriteTime);
    }
    if (nextDelay <= 0) {
        // Both reader and writer are idle - set a new timeout and
        // notify the callback.
        allIdleTimeout = schedule(ctx, this, allIdleTimeNanos, TimeUnit.NANOSECONDS);

        boolean first = firstAllIdleEvent;
        firstAllIdleEvent = false;

        try {
            if (hasOutputChanged(ctx, first)) {
                return;
            }

            IdleStateEvent event = newIdleStateEvent(IdleState.ALL_IDLE, first);
            channelIdle(ctx, event);
        } catch (Throwable t) {
            ctx.fireExceptionCaught(t);
        }
    } else {
        // Either read or write occurred before the timeout - set a new
        // timeout with shorter delay.
        allIdleTimeout = schedule(ctx, this, nextDelay, TimeUnit.NANOSECONDS);
    }
}
说明：
1)表示这个监控着所有的事件。当读写事件发生时，都会记录。代码逻辑和写事件的的基本一致：
2)需要大家注意的地方是
long nextDelay = allIdleTimeNanos; if (!reading) {
// 当前时间减去 最后一次写或读 的时间 ，若大于 0，说明超时了
nextDelay -= ticksInNanos() - Math.max(lastReadTime, lastWriteTime);
}
这里的时间计算是取读写事件中的最大值来的。然后像写事件一样，判断是否发生了写的慢的情况。

小结 Netty 的心跳机制

IdleStateHandler 可以实现心跳功能，当服务器和客户端没有任何读写交互时，并超过了给定的时间，则会触发用户 handler 的 userEventTriggered 方法。用户可以在这个方法中尝试向对方发送信息，如果发送失败，则关闭连接。
IdleStateHandler 的实现基于 EventLoop 的定时任务，每次读写都会记录一个值，在定时任务运行的时候， 通过计算当前时间和设置时间和上次事件发生时间的结果，来判断是否空闲。
内部有 3 个定时任务，分别对应读事件，写事件，读写事件。通常用户监听读写事件就足够了。
同时，IdleStateHandler 内部也考虑了一些极端情况：客户端接收缓慢，一次接收数据的速度超过了设置的空闲时间。Netty 通过构造方法中的 observeOutput 属性来决定是否对出站缓冲区的情况进行判断。
如果出站缓慢，Netty 不认为这是空闲，也就不触发空闲事件。但第一次无论如何也是要触发的。因为第一次无法判断是出站缓慢还是空闲。当然，出站缓慢的话，可能造成 OOM（Out Of Memory） , OOM 比空闲的问题更大。
所以，当你的应用出现了内存溢出，OOM 之类，并且写空闲极少发生（使用了 observeOutput 为 true），那么就需要注意是不是数据出站速度过慢。
还有一个注意的地方：就是 ReadTimeoutHandler ，它继承自 IdleStateHandler，当触发读空闲事件的时候，就触发 ctx.fireExceptionCaught 方法，并传入一个 ReadTimeoutException，然后关闭 Socket。
而 WriteTimeoutHandler 的实现不是基于 IdleStateHandler 的，而是继承自ChannelOutboundHandlerAdapter.它的原理是，当调用 write 方法的时候，会创建一个定时任务，任务内容是根据传入的 promise 的完成情况来判断是否超出了写的时间。当定时任务根据指定时间开始运行，发现 promise （基于Future机制）的 isDone 方法返回 false，表明还没有写完，说明超时了，则抛出异常。当 write 方法完成后，会打断定时任务。

fangjiayou

关注

3
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
山东大学Netty 心跳(heartbeat)服务源码剖析

2021SC@SDUSCNetty 心跳(heartbeat)服务源码剖析1 源码剖析目的Netty 作为一个网络框架，提供了诸多功能，比如编码解码等，Netty 还提供了非常重要的一个服务——心跳机制 heartbeat。通过心跳检查对方是否有效（检查客户端和服务器端是否有效），这是 RPC 框架中是必不可少的功能。下面我们分析一下 Netty内部心跳服务源码实现。2 源码剖析说明Netty 提供了 IdleStateHandler ，ReadTimeoutHandler，WriteTime
复制链接

扫一扫