netty实战-自定义解码器处理半包消息

概述

---

在李林锋的Netty系列之Netty编解码框架分析中介绍了各种解码器,也推荐组合

LengthFieldBasedFrameDecoder
ByteToMessageDecoder

这两个解码器来处理业务消息。但是有时候为了灵活性,会直接选择继承

ByteToMessageDecoder

来处理业务消息,但是直接继承ByteToMessageDecoder,则需要自己处理半包问题。在李林锋的【netty权威指南】中,并没有描述如何自定义解码器来处理半包消息。下文会介绍这方面的知识。

在阅读本文内容之前，你至少需要了解以下两个知识点

1、 netty的ByteBuf类的基本api用法
2、什么是TCP半包

虽然JAVA NIO中也有个ByteBuffer类,但是在Netty程序中,基本都是直接用Netty的ByteBuf类,它包装了更多好用的接口,降低了使用缓冲区类的难度。

之前本人写过几篇关于处理半包消息的文章,读者也可以参看一下

• netty权威指南笔记-分隔符解码器处理半包问题
• netty权威指南笔记-以回车换行结尾的消息如何处理半包问题

---

自定义消息协议

---

目前自定义的消息协议用的最多的是在消息中头四个字节保存消息的长度,格式大概如下

这里写图片描述

len : 表示消息的长度,通常用4个字节保存
head : 消息头部
body : 消息内容

无论每次请求的业务数据多大,都是使用上面的消息格式来表示的。

注意

在实际的项目中,消息格式可能会增加一些标志,例如,开始标记,结束标志,消息序列号,消息的协议类型(json或者二进制等),这里为了描述的方便,就不讲附加的这些消息标志了。

---

自定义解码器处理半包数据

---

如上描述,直接继承ByteToMessageDecoder类,同时覆盖其decode方法,完整实现代码如下

服务端代码

package nettyinaction.encode.lengthfield.server;

import io.netty.bootstrap.ServerBootstrap;
import io.netty.channel.ChannelFuture;
import io.netty.channel.EventLoopGroup;
import io.netty.channel.nio.NioEventLoopGroup;
import io.netty.channel.socket.nio.NioServerSocketChannel;
import io.netty.handler.logging.LogLevel;
import io.netty.handler.logging.LoggingHandler;

public class SocketServer {
    public static void main(String[] args) throws InterruptedException {
        EventLoopGroup parentGroup = new NioEventLoopGroup();
        EventLoopGroup childGroup = new NioEventLoopGroup();

        try {
            ServerBootstrap serverBootstrap = new ServerBootstrap();
            serverBootstrap.group(parentGroup, childGroup)
                    .channel(NioServerSocketChannel.class)
                    .handler(new LoggingHandler(LogLevel.INFO))
                    .childHandler(new SocketServerInitializer());

            ChannelFuture channelFuture = serverBootstrap.bind(8899).sync();
            channelFuture.channel().closeFuture().sync();
        }
        finally {
            parentGroup.shutdownGracefully();
            childGroup.shutdownGracefully();
        }
    }
}





package nettyinaction.encode.lengthfield.server;

import io.netty.channel.ChannelInitializer;
import io.netty.channel.ChannelPipeline;
import io.netty.channel.socket.SocketChannel;


public class SocketServerInitializer extends ChannelInitializer {
    @Override
    protected void initChannel(SocketChannel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        pipeline.addLast(new SelfDefineEncodeHandler());
        pipeline.addLast(new BusinessServerHandler());
    }
}







package nettyinaction.encode.lengthfield.server;

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

import java.util.List;

public class SelfDefineEncodeHandler extends ByteToMessageDecoder {
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf bufferIn, List