Netty入門（十）解碼分隔符和基於長度的協議

　　我們需要區分不同幀的首尾，通常需要在結尾設定特定分隔符或者在首部添加長度字段，分別稱為分隔符協議和基於長度的協議，本節講解 Netty 如何解碼這些協議。

一、分隔符協議

　　Netty 附帶的解碼器可以很容易的提取一些序列分隔：

　　

　　下面顯示了使用 “\r\n”分隔符的處理：

　　

　　下面為 LineBaseFrameDecoder 的簡單實現：

public class CmdHandlerInitializer extends ChannelInitializer<Channel> {

    @Override
    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        // 添加解碼器，
        pipeline.addLast(new CmdDecoder(65 * 1024));
        pipeline.addLast(new CmdHandler());
    }

    public static final class Cmd {
        private final ByteBuf name;    // 名字
        private final ByteBuf args;    // 參數
        
        public Cmd(ByteBuf name, ByteBuf args) {
            this.name = name;
            this.args = args;
        }
        
        public ByteBuf name() {
            return name;
        }
        
        public ByteBuf args() {
            return args;
        }
    }
    
    /**
     * 根據分隔符將消息解碼成Cmd對象傳給下一個處理器
     */
    public static final class CmdDecoder extends LineBasedFrameDecoder {

        public CmdDecoder(int maxLength) {
            super(maxLength);
        }
        
        @Override
        protected Object decode(ChannelHandlerContext ctx, ByteBuf buffer) throws Exception {
            // 通過結束分隔符從 ByteBuf 提取幀
            ByteBuf frame = (ByteBuf)super.decode(ctx, buffer);
            if(frame == null)
                return null;
            int index = frame.indexOf(frame.readerIndex(), frame.writerIndex(), (byte)' ');
            // 提取 Cmd 對象
            return new Cmd(frame.slice(frame.readerIndex(), index), 
                    frame.slice(index+1, frame.writerIndex()));
        }
    }
    
    public static final class CmdHandler extends SimpleChannelInboundHandler<Cmd> {

        @Override
        protected void channelRead0(ChannelHandlerContext ctx, Cmd msg) throws Exception {
            // 處理 Cmd 信息
        }
        
    }
}

 

 　　上面的例子主要實現了利用換行符‘\n’分隔幀，然后將每行數據解碼成一個 Cmd 實例。

 

二、基於長度的協議 

 　　基於長度的協議在幀頭定義了一個幀編碼的長度，而不是在結束位置用一個特殊的分隔符來標記。Netty 提供了兩種編碼器，用於處理這種類型的協議，如下：

　　

 　　FixedLengthFrameDecoder 的操作是提取固定長度每幀 8 字節，如下圖所示：

　　

　　但大部分時候，我們會把幀的大小編碼在頭部，這種情況可以使用 LengthFieldBaseFrameDecoder，它會提取幀的長度並根據長度讀取幀的數據部分，如下：

　　

　　下面是 LengthFieldBaseFrameDecoder 的一個簡單應用：

/**
 * 基於長度的協議
 * LengthFieldBasedFrameDecoder
 */
public class LineBasedHandlerInitializer extends ChannelInitializer<Channel> {

    @Override
    protected void initChannel(Channel ch) throws Exception {
        ChannelPipeline pipeline = ch.pipeline();
        // 用於提取基於幀編碼長度8個字節的幀
        pipeline.addLast(new LengthFieldBasedFrameDecoder(65*1024, 0, 8));
        pipeline.addLast(new FrameHandler());
    }
    
    public static final class FrameHandler extends SimpleChannelInboundHandler<ByteBuf> {

        @Override
        protected void channelRead0(ChannelHandlerContext ctx, ByteBuf msg) throws Exception {
            // TODO 數據處理
        }
        
    }

}

 

 　　上面的例子主要實現了提取幀首部 8 字節的長度，然后提取數據部分進行處理。