Netty中通信协议如何设计？

后端

2023-09-07 13:36:58

背景

我曾在两家从事长连接开发的公司工作过，在第二家公司，我终于深刻理解了长连接开发的精髓，学会了设计通信协议并基于通信协议编码解码。

2. 含义

2.1 通信协议

通信协议是网络通信中双方进行数据交换和解释的约定，它规定了数据格式、传输方式、错误处理等。通信协议可以是标准协议，如TCP/IP协议，也可以是自定义协议。

2.2 编码解码

编码解码是将数据从一种格式转换为另一种格式的过程。在网络通信中，编码是将数据从应用程序的数据结构转换为网络传输的数据格式，解码是将网络传输的数据格式转换为应用程序的数据结构。

2.3 我设计的协议

我设计的通信协议是一个基于TCP的长连接协议，主要由消息头和消息体两部分组成。消息头包含消息长度、消息类型等信息，消息体包含实际的数据。

3. 代码

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;

public class MyMessageEncoder extends MessageToByteEncoder<MyMessage> {

    @Override
    protected void encode(ChannelHandlerContext ctx, MyMessage msg, ByteBuf out) throws Exception {
        // 写入消息长度
        out.writeInt(msg.getLength());
        // 写入消息类型
        out.writeByte(msg.getType());
        // 写入消息体
        out.writeBytes(msg.getBody());
    }
}

import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ByteToMessageDecoder;

import java.util.List;

public class MyMessageDecoder extends ByteToMessageDecoder {

    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
        // 读取消息长度
        int length = in.readInt();
        // 读取消息类型
        byte type = in.readByte();
        // 读取消息体
        byte[] body = new byte[length - 1];
        in.readBytes(body);

        // 将消息体封装成MyMessage对象
        MyMessage msg = new MyMessage();
        msg.setLength(length);
        msg.setType(type);
        msg.setBody(body);

        // 将MyMessage对象添加到出站消息列表中
        out.add(msg);
    }
}