netty5自定义私有协议实例

　　一般业务需求都会自行定义私有协议来满足自己的业务场景，私有协议也可以解决粘包和拆包问题，比如客户端发送数据时携带数据包长度，服务端接收数据后解析消息体，获取数据包长度值，据此继续获取数据包内容。我们来看具体例子，自定义的协议如下：

　　+--------------------------------------------------+----------+
 　　|                消息头               　　　　　     |     消息体 |
 　　| Delimiter | Length | Type | Reserved      |       data   |
 　　+-------------------------------------------------+----------+

　　

　　1)      Delimiter：4bytes，消息头，用于分割消息。

　　2)      Length：数据长度。

　　3)      Type：1bytes，消息类型。 

　　4)      Reserved：1bytes，保留。

　　5)      Data包数据

　　接下来看如何实现编解码：

　　1、先定义好javabean：

　　总体的：

package com.wlf.netty.nettyapi.javabean;

import lombok.Getter;
import lombok.Setter;

@Setter
@Getter
public class NettyMessage {

    private Header header;

    private byte[] data;

    @Override
    public String toString() {
        return "NettyMessage{" +
                "header=" + header +
                ", data=" + data +
                '}';
    }
}

　　头的：

package com.wlf.netty.nettyapi.javabean;

import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
public class Header {

    /**
     * 4bytes，消息头，用于分割消息。如0xABEF0101
     */
    private int delimiter;

    /**
     * 1byte，类型
     */
    private byte type;

    /**
     * 1byte，保留
     */
    private byte reserved;

    /**
     * 数据长度
     */
    private int length;

    @Override
    public String toString() {
        return "Header{" +
                "delimiter=" + delimiter +
                ", length=" + length +
                ", type=" + type +
                ", reserved=" + reserved +
                '}';
    }
}

　　2、编码：

package com.wlf.netty.nettyapi.msgpack;

import com.wlf.netty.nettyapi.javabean.NettyMessage;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.MessageToByteEncoder;

public class NettyMessageEncoder extends MessageToByteEncoder {

    @Override
    protected void encode(ChannelHandlerContext channelHandlerContext, NettyMessage nettyMessage, ByteBuf byteBuf) throws Exception {

        if (nettyMessage == null || nettyMessage.getHeader() == null) {
            throw new Exception("The nettyMessage is null.");
        }

        // 1、写入分割标志
        byteBuf.writeInt(nettyMessage.getHeader().getDelimiter());

        // 2、写入数据包长度
        byteBuf.writeInt(nettyMessage.getData() != null ? nettyMessage.getData().length : 0);

        // 3、写入请求类型
        byteBuf.writeByte(nettyMessage.getHeader().getType());

        // 4、写入预留字段
        byteBuf.writeByte(nettyMessage.getHeader().getReserved());

        // 5、写入数据
        byteBuf.writeBytes(nettyMessage.getData() != null ? nettyMessage.getData() : null);

    }
}

　　3、解码：

package com.wlf.netty.nettyapi.msgpack;

import com.wlf.netty.nettyapi.constant.Delimiter;
import com.wlf.netty.nettyapi.javabean.Header;
import com.wlf.netty.nettyapi.javabean.NettyMessage;
import io.netty.buffer.ByteBuf;
import io.netty.channel.ChannelHandlerContext;
import io.netty.handler.codec.ByteToMessageDecoder;

import java.util.List;

public class NettyMessageDecoder extends ByteToMessageDecoder {

    /**
     * 消息体字节大小：分割符字段4字节+长度字段4字节+请求类型字段1字节+预留字段1字节=10字节
     */
    private static final int HEAD_LENGTH = 10;

    @Override
    protected void decode(ChannelHandlerContext channelHandlerContext, ByteBuf byteBuf, List