七、TCP粘包和拆包

本文档整理并出自尚硅谷韩顺平Netty教程

https://www.bilibili.com/video/BV1DJ411m7NR

1、什么是拆包和粘包

• TCP是面向连接的，面向流的，提供高可靠性服务。收发两端（客户端和服务器端）都要有一一成对的socket，因此，发送端为了将多个发给接收端的包，更有效的发给对方，使用了优化方法（Nagle算法），将多次间隔较小且数据量小的数据，合并成一个大的数据块，然后进行封包。这样做虽然提高了效率，但是接收端就难于分辨出完整的数据包了，因为面向流的通信是无消息保护边界的
• 由于TCP无消息保护边界，需要在接收端处理消息边界问题，也就是我们所说的粘包、拆包问题。
• 通常的解决方案是：发送端每发送一次消息，就需要在消息的内容之前携带消息的长度，这样，接收方每次先接受消息的长度，再根据长度去读取该消息剩余的内容。如果socket中还有没有读取的内容，也只能放在下一次读取事件中进行。

2、拆包、粘包的图解

假设客户端同时发送了两个数据包D1和D2给服务端，由于服务端一次读取到字节数是不确定的，固可能存在以下四种情况：

1. 服务端分两次读取到了两个独立的数据包，分别是D1和D2，没有粘包和拆包
2. 服务端一次接受到了两个数据包，D1和D2粘合在一起，称之为TCP粘包
3. 服务端分两次读取到了数据包，第一次读取到了完整的D1包和D2包的部分内容，第二次读取到了D2包的剩余内容，这称之为TCP拆包
4. 服务端分两次读取到了数据包，第一次读取到了D1包的部分内容D1_1，第二次读取到了D1包的剩余部分内容D1_2和完整的D2包。

3、解决方案图解

• 我们可以在数据包的前面加上一个固定字节数的数据长度，如加上一个 int（固定四个字节）类型的数据内容长度
• 就算客户端同时发送两个数据包到服务端，当服务端接受时，也可以先读取四个字节的长度，然后根据长度获取消息的内容，这样就不会出现多读取或者少读取的情况了。

4、TCP粘包代码示例

本实例主要演示出现拆包和粘包的场景。

客户端：

我们将使用循环连续发送10个String类型的字符串。这里相当于发送了10次。

@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
    //使用客户端发送10条数据，hello，server
    for (int i = 0; i < 10; i++) {
        String msg = "server" + i + "  ";
        System.out.println("发送消息 " + msg);
        ByteBuf byteBuf = Unpooled.copiedBuffer(msg, CharsetUtil.UTF_8);
        ctx.writeAndFlush(byteBuf);
    }
}

服务端：

我们接受客户端发过来的字符串。

private int count = 0;
@Override
protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
    byte[] bytes = new byte[msg.readableBytes()];
    msg.readBytes(bytes);

    //将buffer转成字符串
    String message = new String(bytes, CharsetUtil.UTF_8);

    System.out.println("服务器接收到数据 " + message);
    System.out.println("服务器接收到消息量 = " + (++this.count));

    //服务器回送数据到客户端，回送一个随机Id
    ByteBuf response = Unpooled.copiedBuffer(UUID.randomUUID().toString() + "--", CharsetUtil.UTF_8);
    ctx.writeAndFlush(response);
}

服务端输出结果如下：

• 我们可以看到，服务端直接一次就把我们客户端10次发送的内容读取完成了。
• 这里也印证了我们开篇所说的，当数据量小且发送间隔短，如果我们客户端每次发送的都是不同的结果，这种情况下我们就不知道客户端返回了多少次结果以及每次结果究竟是什么。这就是我们本篇需要解决的问题。

5、解决方案代码示例

• 使用自定义协议 + 编解码器 来解决
• 关键就是要解决 服务器端每次读取数据长度的问题, 这个问题解决，就不会出现服务器多读或少读数据的问题，从而避免的TCP 粘包、拆包 。

自定义Message对象：

public class MessageProtocol {
    private int len; //关键
    private byte[] content;
}

添加将ByteBuf转换成Message的解码器：

public class MessageDecoder extends ReplayingDecoder<Void> {
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        System.out.println("MessageDecoder 被调用");
        //需要将获取到的二进制字节码转换成 MessageProtocol
        int length = in.readInt();
        byte[] content = new byte[length];
        in.readBytes(content);

        //封装成 MessageProtocol 对象，放入 out，传递到下一个Handler
        MessageProtocol messageProtocol = new MessageProtocol();
        messageProtocol.setLen(length);
        messageProtocol.setContent(content);
        out.add(messageProtocol);
    }
}

添加将Message转换为ByteBuf的编码器：

public class MessageEncoder extends MessageToByteEncoder<MessageProtocol> {
    @Override
    protected void encode(ChannelHandlerContext ctx, MessageProtocol msg, ByteBuf out) throws Exception {
        System.out.println("MessageEncoder 方法被调用");
        out.writeInt(msg.getLen());
        out.writeBytes(msg.getContent());
    }
}

客户端连续发送3个Message对象：

@Override
public void channelActive(ChannelHandlerContext ctx) throws Exception {
    //使用客户端发送10条数据，"今天天气冷，吃火锅" 编号
    for (int i = 0; i < 3; i++) {
        String message = "Server" + i;
        byte[] content = message.getBytes(CharsetUtil.UTF_8);
        int length = content.length;

        //创建协议包对象
        MessageProtocol messageProtocol = new MessageProtocol();
        messageProtocol.setLen(length);
        messageProtocol.setContent(content);
        ctx.writeAndFlush(messageProtocol);
    }
}

服务端接收：

//接收的Handler继承了SimpleChannelInboundHandler，以MessageProtocol的类型接受消息
@Override
protected void channelRead0(ChannelHandlerContext ctx, MessageProtocol msg) throws Exception {
    //接收到数据，并处理
    int len = msg.getLen();
    byte[] content = msg.getContent();

    System.out.println("服务器第 " + (++count) +" 次接收到信息如下：");
    System.out.println("长度：" + len);
    System.out.println("内容：" + new String(content, CharsetUtil.UTF_8));

    //回复消息
    String response = UUID.randomUUID().toString();
    int length = response.getBytes(CharsetUtil.UTF_8).length;
    MessageProtocol messageProtocol = new MessageProtocol();
    messageProtocol.setLen(length);
    messageProtocol.setContent(response.getBytes());
    ctx.writeAndFlush(messageProtocol);
}

结果展示：

• 首先，当客户端的通道激活后，就直接调用方法发送10个Message对象。

• 服务端接收对象时，首先调用MessageDecoder进行解码，将ByteBuf类型的数据转换成MessageProtocol，然后再进入进行读取的Handler中读取消息。
  图片转存中…(img-amPFcFuc-1622360503339)]

• 首先，当客户端的通道激活后，就直接调用方法发送10个Message对象。

• 服务端接收对象时，首先调用MessageDecoder进行解码，将ByteBuf类型的数据转换成MessageProtocol，然后再进入进行读取的Handler中读取消息。

• 最后返回给客户端消息，调用MessageEncoder将MessageProtocol转换成Byte然后发送出去。