记录Netty LengthFieldBasedFrameDecoder解决TCP粘包与拆包的用法详解

前言
LengthFieldBasedFrameDecoder类是Netty提供的用来解析带长度字段数据包的类，继承自ByteToMessageDecoder类。

一、粘包与拆包问题

大意是，TCP发送的数据顺序是符合不会变但是会有拆分和合并，对端接收到的数据包不是发送方的分包格式，所以一般的做法是在包头固定字节出加入长度域字段，指明包长度，有接受方根据包长度拼接或者剪裁收到的数据形成完整的数据包。

二、LengthFieldBasedFrameDecoder的用法

用一个具体的报文来看
|aaaa| |bbcc| |消息内容|
其中aaaa是数据头，用来标记包的开头，bbcc是长度域字段（数据长度），在这里要注意，长度域字段可能有两种情况，一种是长度域字段是整个包的长度；另一种是长度域字段值是从长度域字段位置起（不包含长度域字段本身），到包末尾的长度。Netty默认是第二种情况。

LengthFieldBasedFrameDecoder就是Netty自带的，用来根据长度字段解析数据包的类，LengthFieldBasedFrameDecoder的完整构造参数如下：

public LengthFieldBasedFrameDecoder(
ByteOrder byteOrder,
int lengthFieldOffset,
int lengthFieldLength,
int lengthAdjustment,
int initialBytesToStrip,
boolean failFast)

byteOrder：是指明长度域字段是大端序还是小端序，因为Netty要读取长度域字段的值，所以大端小端要设置好，默认Netty是大端序ByteOrder.BIG_ENDIAN。(即高位在前为大端模式，低位在前为小端模式)

maxFrameLength：是指最大包长度，如果Netty最终生成的数据包超过这个长度，Netty就会报错。

lengthFieldOffset：是指明Length的偏移位，在这里应该是2，因为长度域前2个字节。

lengthFieldLength：是Length字段长度，这里是2，Length字段占2个字节。
注：长度域字段采用16进制且只支持1,2,3,4,8这五种长度，如果不是16进制或这五种长度需自定义编解码，继承ByteToMessageDecoder类，重写getUnadjustedFrameLength方法。

lengthAdjustment ：这个参数很多时候设为负数，这是最让小伙伴们迷惑的。下面我用一整段话来解释这个参数：
当Netty利用lengthFieldOffset（偏移位）和lengthFieldLength（Length字段长度）成功读出Length字段的值后，Netty认为这个值是指从Length字段之后，到包结束一共还有多少字节，如果这个值是13，那么Netty就会再等待13个Byte的数据到达后，拼接成一个完整的包。但是更多时候，Length字段的长度，是指整个包的长度，如果是这种情况，当Netty读出Length字段的时候，它已经读取了包的4个Byte的数据，所以，后续未到达的数据只有9个Byte，即13 - 4 = 9，这个时候，就要用lengthAdjustment来告诉Netty，后续的数据并没有13个Byte，要减掉4个Byte，所以lengthAdjustment要设为 -4！！！

initialBytesToStrip之前的几个参数，已经足够netty识别出整个数据包了，但是很多时候，调用者只关心包的内容，包的头部完全可以丢弃掉，initialBytesToStrip就是用来告诉Netty，识别出整个数据包之后，我只要从initialBytesToStrip起的数据，比如这里initialBytesToStrip设置为4，那么Netty就会跳过包头，解析出包的内容“12345678”。

failFast 参数一般设置为true，当这个参数为true时，netty一旦读到Length字段，并判断Length超过maxFrameLength，就立即抛出异常。

lengthAdjustment计算公式
数据包总长度 = 长度域的值 + lengthFieldOffset + lengthFieldLength + lengthAdjustment

如果是小端模式，且长度域为长度域字段位置起（不包含长度域字段本身），到包末尾

@Component
public class ServerChannelInitializer extends ChannelInitializer<SocketChannel> {

    @Autowired
    ServerChannelHandler serverChannelHandler;

    @Override
    protected void initChannel(SocketChannel socketChannel) {
        ChannelPipeline pipeline = socketChannel.pipeline();
        pipeline.addLast(new LengthFieldBasedFrameDecoder(ByteOrder.LITTLE_ENDIAN,1024, 2, 2, 0, 0,true));
        //自定义Handler
        pipeline.addLast("serverChannelHandler", serverChannelHandler);
    }
}

如果是大端模式，且长度域为整个包的长度

@Component
public class ServerChannelInitializer extends ChannelInitializer<SocketChannel> {

    @Autowired
    ServerChannelHandler serverChannelHandler;

    @Override
    protected void initChannel(SocketChannel socketChannel) {
        ChannelPipeline pipeline = socketChannel.pipeline();
        pipeline.addLast(new LengthFieldBasedFrameDecoder(ByteOrder.BIG_ENDIAN,1024, 2, 2, -4, 0,true));
        //自定义Handler
        pipeline.addLast("serverChannelHandler", serverChannelHandler);
    }
}

参数设置错误时，会出现以下错误

错误原因：Adjusted frame length exceeds 1024: 3852 - discarded

参考链接：https://blog.csdn.net/zougen/article/details/79037675