netty学习系列八:拆包器

一、粘包与拆包

1、发送时的粘包与拆包

TCP连接维护了一个发送缓存区。将要发送给对端的数据会由socket API写入该发送缓存区。
TCP每次发送的报文段大小有限制,MSS就是单个TCP数据包能够承载的最大数据分段大小。
TCP为了考虑数据传输效率,会采用如下发送策略:

  • 发送缓存区中存放的数据达到MSS字节时,就组装一个TCP报文段发送出去;
  • 由发送方的应用进程指明要求立即发送报文段;
  • 发送计时器到期,这时把缓存区中已有的数据装入报文段(但长度不能超过MSS)发送出去;

正是由于MSS和发送策略,会有以下情况:

  • 用户数据包超过了mss,那么这个用户数据包在发送的时候必须拆分成多个TCP数据包,即发生拆包
  • 用户数据包有效载荷非常低,TCP的发送策略会将多个用户数据包合并为一个TCP数据包进行发送,即发生粘包

2、接收时的粘包与拆包

由于TCP在发送数据时会发生粘包/拆包。所以接收过程也需要进行对应的粘包/拆包,以便将接收到的TCP数据包重新组装为发送端发来的原始用户数据包,并进行后续业务处理。

3、接收端进行粘包/拆包的原理

基本原理就是不断从TCP缓冲区中读取数据,并将新读取到的数据向后追加到 本地消息缓存 中,然后进行解码处理:

  • 如果当前本地消息缓存中不足以拼接成一个业务数据包,那就保留数据,继续从tcp缓冲区中读取数据;
  • 如果当前本地消息缓存中能够拼接成一个业务数据包,那就将对应数据解码成一个完整的业务数据包并传递给业务逻辑处理,本地消息缓存中剩余的多余数据仍然保留,以便和下次读到的数据尝试拼接。

二、netty中的拆包器

0、总述

netty 中的拆包过程原理同上,拆包器基类为ByteToMessageDecoder,其内部有一个 累加器 ,将每次新读取到的数据不断累加到本地字节容器,然后尝试对累加后的本地字节容器中的数据进行拆包,拆成一个完整的业务数据包。

netty拆包过程

1、累加器

netty通过累加器实现将每次新读取到的数据不断累积到本地字节容器的操作。
ByteToMessageDecoder 中定义了两个累加器:

public static final Cumulator MERGE_CUMULATOR = ...;
public static final Cumulator COMPOSITE_CUMULATOR = ...;

默认情况下使用简单的MERGE_CUMULATOR累加器,原理是每次都将读取到的数据通过内存拷贝的方式,拼接到一个大的字节容器中,这个大的字节容器即为ByteToMessageDecoder中的cumulation。

private Cumulator cumulator = MERGE_CUMULATOR;

累加器的累加操作实现

        @Override
        public ByteBuf cumulate(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf in) {
            ByteBuf buffer;
            if (cumulation.writerIndex() > cumulation.maxCapacity() - in.readableBytes()
                    || cumulation.refCnt() > 1) {
                buffer = expandCumulation(alloc, cumulation, in.readableBytes());
            } else {
                buffer = cumulation;
            }
            buffer.writeBytes(in);
            in.release();
            return buffer;
        }
  • 若当前cumulation空间不足容纳新读取到的数据,则进行扩容;

ByteBuf expandCumulation(ByteBufAllocator alloc, ByteBuf cumulation, int readable);

  • 使用ByteBuf.writeBytes(in);将新数据累加到字节容器cumulation中;

2、数据读取与粘包/拆包

1、 代码入口
2、 累加新读取的数据到本地自己容器中
3、 将本地字节容器中的数据传递给业务拆包器拆包
4、 清理字节容器
5、 传递业务数据包给业务解码器处理

1)代码入口
a、NioEventLoop线程在处理IO事件的代码processSelectedKey(SelectionKey k, AbstractNioChannel ch)中,对于OP_READ事件会调用相应Channel的NioByteUnsafe.read()进行处理。
b、NioByteUnsafe.read()会分配一个ByteBuf byteBuf并将TCP接收缓存中的数据读取到byteBuf中,最后触发channelRead事件将byteBuf传递给pipeline中的ByteToMessageDecoder回调处理。

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
        if (msg instanceof ByteBuf) {
            CodecOutputList out = CodecOutputList.newInstance();
            try {
                ByteBuf data = (ByteBuf) msg;
                first = cumulation == null;
                if (first) {
                    cumulation = data;
                } else {
                    cumulation = cumulator.cumulate(ctx.alloc(), cumulation, data);
                }
                callDecode(ctx, cumulation, out);
            } catch (DecoderException e) {
                throw e;
            } catch (Throwable t) {
                throw new DecoderException(t);
            } finally {
                if (cumulation != null && !cumulation.isReadable()) {
                    numReads = 0;
                    cumulation.release();
                    cumulation = null;
                } else if (++ numReads >= discardAfterReads) {
                    // We did enough reads already try to discard some bytes so we not risk to see a OOME.
                    // See https://github.com/netty/netty/issues/4275
                    numReads = 0;
                    discardSomeReadBytes();
                }

                int size = out.size();
                decodeWasNull = !out.insertSinceRecycled();
                fireChannelRead(ctx, out, size);
                out.recycle();
            }
        } else {
            ctx.fireChannelRead(msg);
        }
    }

上述代码分为如下四个步骤:
1、 累加新读取的数据到本地自己容器中
2、 将本地字节容器中的数据传递给业务拆包器拆包
3、 清理字节容器
4、 传递业务数据包给业务解码器处理

2)累加新读取的数据到本地自己容器中

                ByteBuf data = (ByteBuf) msg;
                first = cumulation == null;
                if (first) {
                    cumulation = data;
                } else {
                    cumulation = cumulator.cumulate(ctx.alloc(), cumulation, data);
                }
  • 若当前累加器中没有数据(cumulation==null),则直接跳过内存拷贝,将字节容器cumulation的指针指向新读取的数据;
  • 若当前累加器中有数据,调用累加器cumulation的```cumulate(ByteBufAllocator alloc, ByteBuf cumulation, ByteBuf in)``方法累加新读取到的数据到本地字节容器。

3)将本地字节容器中的数据传递给业务拆包器拆包

CodecOutputList out = CodecOutputList.newInstance();
callDecode(ctx, cumulation, out);

1、 到这一步,本地字节容器中的数据是目前未经拆包的所有数据;
2、 callDecode 将尝试将本地字节容器的数据拆分成业务数据包,并放入业务数据包容器CodecOutputList out中;
3、 对于业务数据包容器out,遍历其中的业务数据包,通过ctx.fireChannelRead(msg);将每个业务数据包传递给后续处理器进行业务处理

具体的拆包工作由ByteToMessageDecode的抽象方法定义:

protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception;

netty中对各种用户协议的支持就体现在这个抽象方法中,所有的拆包器最终都实现了该抽象方法。

decode后,如果发现并没有拆到一个完整的数据包

                if (outSize == out.size()) {
                    if (oldInputLength == in.readableBytes()) {
                        break;
                    } else {
                        continue;
                    }
                }
  • 若拆包器什么数据也没读取oldInputLength == in.readableBytes(),可能数据还不够业务拆包器处理,直接break等待新的数据;
  • 若拆包器已读取部分数据,说明解码器仍然在工作,继续循环解码。

4)清理字节容器
NioByteUnsafe.read()每次处理OP_READ事件读取完数据,都会触发一次channelReadComplete事件。
ByteToMessageDecoder.channelReadComplete(ChannelHandlerContext ctx)方法中实现了对本地字节容器的清理逻辑:

discardSomeReadBytes();

另外,为防止发送端发送数据过快ByteToMessageDecoder.channelRead中在每次拆包过后都会做一次判断,如果读取到的数据量过多也会主动执行本地字节容器的清理逻辑:

if (++ numReads >= discardAfterReads) {
                    numReads = 0;
                    discardSomeReadBytes();
                }

discardSomeReadBytes()之前,本地字节容器中的数据分布:

+--------------+----------+----------+
|   readed     | unreaded | writable | 
+--------------+----------+----------+

discardSomeReadBytes()之后,本地字节容器中的数据分布:

+----------+-------------------------+
| unreaded |      writable           | 
+----------+-------------------------+

**5)传递业务数据包给业务解码器处理**
经过上面几个步骤完成之后,就可以将拆成的业务数据包交给后续业务处理器处理了:

fireChannelRead(ctx, out, size);

static void fireChannelRead(ChannelHandlerContext ctx, CodecOutputList msgs, int numElements) {
    for (int i = 0; i < numElements; i ++) {
        ctx.fireChannelRead(msgs.getUnsafe(i));
    }
}

#三、拆包器的具体实现类
LineBasedFrameDecoder  ->  根据换行符\n或\r\n进行拆包 
DelimiterBasedFrameDecoder  ->  根据用户定义的标识符进行拆包 
LengthFieldBasedFrameDecoder  ->  根据包头长度进行拆包,适用于私有协议解码
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,710评论 4 376
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,839评论 2 308
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 112,295评论 0 255
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,776评论 0 223
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,198评论 3 297
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,074评论 1 226
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,200评论 2 322
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,986评论 0 214
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,733评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,877评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,348评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,675评论 3 265
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,393评论 3 246
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,209评论 0 9
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,996评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,212评论 2 287
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 36,003评论 2 280

推荐阅读更多精彩内容

  • 为什么要粘包拆包 为什么要粘包 首先你得了解一下TCP/IP协议,在用户数据量非常小的情况下,极端情况下,一个字节...
    简书闪电侠阅读 20,427评论 23 77
  • 从三月份找实习到现在,面了一些公司,挂了不少,但最终还是拿到小米、百度、阿里、京东、新浪、CVTE、乐视家的研发岗...
    时芥蓝阅读 42,021评论 11 349
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,112评论 18 139
  • 前奏 https://tech.meituan.com/2016/11/04/nio.html 综述 netty通...
    jiangmo阅读 5,784评论 0 13
  • 今年新片里,我唯一在短期内反复观看的,是《将来的事》。是那种很念念不忘的回想与凝望。 生活在每一个阶段,都有无解的...
    03da5d02c6d2阅读 261评论 0 0