Netty进阶 协议设计与解析 HttpServerCodec、自定义协议Codec，源码分析

我们的客户端和服务器进行通信的时候肯定需要遵守一定的协议，这些协议有可能是已经提前设计好的如Http协议，也可以是我们自定义的。

上一篇我们讲解了一些Netty给我们提供的一些编解码器，这是本篇文章的基础，否则可能看不懂。

这一篇主要是讲解Netty中的Http协议和我们自定义的协议。

服务器的编解码器，遵从HTTP协议，先看如下类

首先看看HttpServerCodec的类结构，其中继承的CombinedChannelDuplexHandler其实就是合并了它的两个泛型的任务，就不多说了

关键的两个解码和编码类继承如下： 

 一般以Codec结尾的既可以做解码也可以编码，Decoder意为解码，Encoder意为编码。其中解码是ChannelInboundHandlerAdapter的子类(即入站handler)，专门用于监听客户端发来的数据给他先进行一遍解码工作，Encoder为ChannelOutboundHandlerAdapter的子类(即出站handler)，即需要发送的数据先进行一遍编码操作，再发去对应的客户端。

我们只需在服务器加上如下代码即可使用(完整代码略过)。

 //HTTP协议的编解码器
ch.pipeline().addLast(new HttpServerCodec());

演示解码：

大家可能会好奇，Codec到底会把客户端发来的信息解码为什么类型呢？是以前的ByteBuf、String？具体的细节下面分析

服务器加上如下代码，启动服务器，打开浏览器输入localhost:xxxx(绑定的端口)，查看输出

结果如下（还有一些浏览器发的请求头请求行什么的太多了就不展示了）

 可以看到我在浏览器只发送了一次请求，却打印了两次。其实是HttpServerCodec把我们的请求解析成了两部分，第一部分为HttpRequest它包含请求头和请求行，第二部分为HttpContent代表请求体(即使是get请求，也会有请求体，顶多没有内容而已)。

按照这样的逻辑我们可能以后就需要在解码后的channelRead里区分一下请求头和请求体了：

 public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
       //打印出msg类信息
//    System.out.println(msg.getClass());
        if(msg instanceof HttpRequest){  //DefaultHttpRequest的父接口为HttpRequest
           //执行请求头的代码逻辑
        }else if (msg instanceof HttpContent){//同样比较父类即可，更通用
           //执行请求体的代码逻辑
      }
 }

但是这样似乎过于麻烦，如果我现在只关心其中的一种，不想做很多的if...else判断，那我们可以换另一个方式进行简化，即SimpleChannelInboundHandler：

SimpleChannelInboundHandler的泛型就是他关心的消息类型，如果不是指定的消息类型则会跳过该handler。可以看到重写的channelRead0里的msg类型就是指定的泛型

ch.pipeline().addLast(new SimpleChannelInboundHandler() {//我们这里只关心请求头
   @Override
   protected void channelRead0(ChannelHandlerContext channelHandlerContext, HttpRequest msg) throws Exception {
        //业务逻辑
    }
}

响应客户端：

我们服务器收到客户端的请求后当然需要回复客户端啦，根据上面的说明我们知道我们需要响应一个同样符合Http协议的响应对象给客户端，同样的写回数据时会被HttpServerCodec进行编码动作，先参考下面几个类

DefaultFullHttpResponse：Netty提供的给客户端响应的类如下

 HTTP协议版本类参考如下：

 状态码类参考(非常多)：

 演示：

bootstrap.childHandler(new ChannelInitializer() {
    @Override
    protected void initChannel(NioSocketChannel ch) throws Exception {
        ch.pipeline().addLast(new LoggingHandler());
        //HTTP协议的编解码器，
        ch.pipeline().addLast(new HttpServerCodec());
        //SimpleChannelInboundHandler的泛型就是他关心的消息格式，如果不是指定的格式则会跳过该handler
        ch.pipeline().addLast(new SimpleChannelInboundHandler() {//我们这里只关心请求头
            @Override
            protected void channelRead0(ChannelHandlerContext channelHandlerContext, HttpRequest msg) throws Exception {
                log.debug("请求方法为{}",msg.method());//请求方法为GET
                log.debug("请求路径为{}",msg.uri());//请求资源路径为/
                log.debug("请求头为{}",msg.headers());//请求头为DefaultHttpHeaders[Host: localhost:8081, Connection: keep-alive……]

                //向客户端返回响应
                //netty提供的响应对象，这里指定响应版本和请求时候的版本相同，响应码为200
                DefaultFullHttpResponse response=new DefaultFullHttpResponse(msg.protocolVersion(),HttpResponseStatus.OK);
                //content方法是给上面的response写返回内容，返回值为ByteBuf,具体可以看源码
                //也可以构造该对象时就把消息体的ByteBuf放在构造方法里
                response.content().writeBytes("I am Netty".getBytes());
                //写回响应
                channelHandlerContext.writeAndFlush(response);
            }
        });
    }
});

结果可以看到，netty已经把该响应进行了编码并写回了对应的channel中，客户端也收到了该响应

但是还有个问题，就是浏览器这边一直在转圈加载，这是因为服务器并没有告诉它我这边已经响应完了，浏览器就以为还有数据，所以会一直加载，等待接收。

解决：在响应头里加一个字段content-length 为我们要发送的响应的长度，改动代码为

 各种响应头里的字段名字信息：

 浏览器正确的接收到响应信息。

另外，浏览器可能会自动给服务器发送图标请求

今后我们需要根据不同的请求uri，返回该客户端不同的资源。

HttpClientCodec是客户端的Http协议编解码器

前面我们讲解了常用的HTTP协议，如果想设计一套适合自己业务的协议来增强效率和减小浪费。

自定义协议，就需要考虑如下的几个地方：

• 魔数：用来在第—时间判定是否是无效数据包，了解jvm的小伙伴可能知道，class文件的魔数为CAFE BABY，如果你使用java命令执行文件，如果class文件前4个字节（魔数）不是约定的CAFE BABY，jvm就不会执行该calss文件。
• 版本号：可以支持协议的升级，比如你的协议升级后，增加了几个字段，如果你想用旧的协议就必须按照协议的版本号进行区分识别。
• 序列化算法：消息的正文采用哪种序列化和反序列化方式，如json，jdk等
• 指令类型：是登录、注册、单聊、群聊...？跟业务相关
• 请求序号：为了双工通信，提供异步能力，标志每一个不同的请求消息
• 正文长度
• 消息正文：消息正文就像是后台传给前端的各种复杂的数据，我们需要用序列化算法来解析该数据，否则的话数据接收的时候会乱，所以一般前后端交互采用json格式进行编解码

有兴趣的小伙伴可以查看HttpMessage类，看看Netty对Http协议是如何设计的（有点复杂）。

我们自定义协议应该对比HttpServerCodec学习，这样就算是哪天忘记代码了，也可以在官方的解决方案里找到答案，也可以学习HttpServerCodec更深入。

1.首先建立一个Message抽象类和它的各种实现类，它是我们自定义协议的承载体，我们以Message为单位发送消息，这里写的比较简单，很多东西到后续扩充。

public abstract class Message implements Serializable {//实现序列化接口
    private int sequenceId;
    private int messageType;

    //可能的指令类型，用数字表示
    public static final int LoginRequestMessage=0;//登录请求的消息
    public static final int LoginResponseMessage=1;//登录回复的消息
    public static final int ChatRequestMessage=2;//聊天请求的消息
    public static final int ChatResponseMessage=3;//聊天答复的消息
    //由具体的子类Message实现，每一条子类对应上面的一个码子
    public abstract int getMessageType();
    //省略get set等方法
}

实现类只列举其中一种，以后会慢慢扩充：

public class LoginRequestMessage extends Message{
    private String username;
    private String password;
    private String nickname;
    @Override
    public int getMessageType() {
        return LoginRequestMessage;
    }
    public LoginRequestMessage(String username, String password, String nickname) {
        this.username = username;
        this.password = password;
        this.nickname = nickname;
    }
    //toString...
}

2.自定义编解码功能的实现 ，继承ByteToMessageCodec，该类和HttpServerCodec的CombinedChannelDuplexHandler一样融合HttpRequestDecoder、HttpResponseEncoder做编解码功能

public class MessageCodec extends ByteToMessageCodec {
    //重写编码和解码功能

    @Override
    //编码，看方法的参数，out就是需要传出去的ByteBuf，
    //我们需要把msg按我们的规定的协议格式放到out里传出去
    protected void encode(ChannelHandlerContext ctx, Message msg, ByteBuf out) throws Exception {
        //1）.魔数，我们这里写个 BBQ! 为魔数吧，共占用4字节
        out.writeBytes(new byte[]{'B', 'B', 'Q', '!'});
        //2）.版本号，一字节就够了，这里就写死写成1吧
        out.writeByte(1);
        //3）.序列化算法，使用一字节表示序列化的方式，如jdk->0；json->1
        out.writeByte(0);
        //4）.一字节的指令类型，Message各子类都封装了本消息是什么类型，直接取即可
        out.writeByte(msg.getMessageType());
        //5）.请求序号，4字节
        out.writeInt(msg.getSequenceId());
        //6）.正文，将对象转为二进制的字节数组，这里采用JDK的序列化
        ByteArrayOutputStream baos = new ByteArrayOutputStream();
        ObjectOutputStream oos = new ObjectOutputStream(baos);
        oos.writeObject(msg);
        byte[] bytes = baos.toByteArray();
        //7）.长度写进去，占4字节
        out.writeInt(bytes.length);
        //填充1个字节，使得头信息为16字节，即2的整数次幂
        out.writeByte(0xff);
        //8）.写入内容
        out.writeBytes(bytes);
    }

    @Override
    //解码，怎么编的码就怎么解码  ，out就是解析出来的数据集合，可能解析出多条数据
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List