Netty入門系列(2) --使用Netty解決粘包和拆包問題

正號先生發表於2019-05-17
Netty

前言

上一篇我們介紹瞭如果使用Netty來開發一個簡單的服務端和客戶端，接下來我們來討論如何使用解碼器來解決TCP的粘包和拆包問題

TCP為什麼會粘包/拆包

我們知道，TCP是以一種流的方式來進行網路轉播的，當tcp三次握手簡歷通訊後，客戶端服務端之間就建立了一種通訊管道，我們可以想象成自來水管道，流出來的水是連城一片的，是沒有分界線的。

TCP底層並不瞭解上層的業務資料的具體含義，它會根據TCP緩衝區的實際情況進行包的劃分。

所以對於我們應用層而言。我們直觀是傳送一個個連續完整TCP資料包的，而在底層就可能會出現將一個完整的TCP拆分成多個包傳送或者將多個包封裝成一個大的資料包傳送。

這就是所謂的TCP粘包和拆包。

當發生TCP粘包/拆包會發生什麼情況

我們舉一個簡單例子說明：

客戶端向服務端傳送兩個資料包：第一個內容為 123；第二個內容為456。服務端接受一個資料並做相應的業務處理（這裡就是列印接受資料加一個逗號）。

那麼服務端輸出結果將會出現下面四種情況

服務端響應結果 結論
123，456， 正常接收，沒有發生粘包和拆包
123456， 異常接收，發生tcp粘包
123，4，56， 異常接收，發生tcp拆包
12，3456， 異常接收，發生tcp拆包和粘包

如何解決

主流的協議解決方案可以歸納如下：

  1. 訊息定長，例如每個報文的大小固定為20個位元組，如果不夠，空位補空格；
  2. 在包尾增加回車換行符進行切割；
  3. 將訊息分為訊息頭和訊息體，訊息頭中包含表示訊息總長度的欄位；
  4. 更復雜的應用層協議。

對於之前描述的案例，在這裡我們就可以採取方案1和方案3。

以方案1為例：我們每次傳送的TCP包只有三個數字，那麼我將報文設定為3個位元組大小的，此時，伺服器就會以三個位元組為基準來接受包，以此來解決站包拆包問題。

Netty的解決之道

LineBasedFrameDecoder

廢話不多說直接上程式碼

服務端

public class PrintServer {

    public void bind(int port) throws Exception {
    // 配置服務端的NIO執行緒組
    EventLoopGroup bossGroup = new NioEventLoopGroup();
    EventLoopGroup workerGroup = new NioEventLoopGroup();
    try {
        ServerBootstrap b = new ServerBootstrap();
        b.group(bossGroup, workerGroup)
            .channel(NioServerSocketChannel.class)
            .option(ChannelOption.SO_BACKLOG, 1024)
            .childHandler(new ChildChannelHandler());
        // 繫結埠，同步等待成功
        ChannelFuture f = b.bind(port).sync();

        // 等待服務端監聽埠關閉
        f.channel().closeFuture().sync();
    } finally {
        // 優雅退出，釋放執行緒池資源
        bossGroup.shutdownGracefully();
        workerGroup.shutdownGracefully();
    }
    }

    private class ChildChannelHandler extends ChannelInitializer<SocketChannel> {
    @Override
    protected void initChannel(SocketChannel arg0) throws Exception {
        arg0.pipeline().addLast(new LineBasedFrameDecoder(1024));   //1
        arg0.pipeline().addLast(new StringDecoder());               //2
        arg0.pipeline().addLast(new PrintServerHandler());
    }
    }


    public static void main(String[] args) throws Exception {
    int port = 8080;
    new TimeServer().bind(port);
    }
}

服務端Handler

public class PrintServerHandler extends ChannelHandlerAdapter {

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg)
        throws Exception {
    ByteBuf buf = (ByteBuf) msg;                                        
    byte[] req = new byte[buf.readableBytes()]; 
    buf.readBytes(req); //將快取區的位元組陣列複製到新建的req陣列中
    String body = new String(req, "UTF-8");
    System.out.println(body);
    String response= "列印成功";
    ByteBuf resp = Unpooled.copiedBuffer(response.getBytes());                      
    ctx.write(resp);                                                
    }   

    @Override
    public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
    ctx.flush();                                                        
    }


    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {
    ctx.close();
    }
}

客戶端

public class PrintClient {

    public void connect(int port, String host) throws Exception {
    EventLoopGroup group = new NioEventLoopGroup();                 
    try {
        Bootstrap b = new Bootstrap();                              
         b.group(group)                                             
            .channel(NioSocketChannel.class)                        
            .option(ChannelOption.TCP_NODELAY, true)                
            .handler(new ChannelInitializer<SocketChannel>() {      
            @Override
            public void initChannel(SocketChannel ch)               
                throws Exception {
                 ch.pipeline().addLast(
                    new LineBasedFrameDecoder(1024));           //3
                ch.pipeline().addLast(new StringDecoder());     //4
                ch.pipeline().addLast(new PrintClientHandler());
            }
            });

        ChannelFuture f = b.connect(host, port).sync();             
        f.channel().closeFuture().sync();                           
    } finally {
        // 優雅退出，釋放NIO執行緒組
        group.shutdownGracefully();
    }
    }

    /**
     * @param args
     * @throws Exception
     */
    public static void main(String[] args) throws Exception {
    int port = 8080;
    new TimeClient().connect(port, "127.0.0.1");
    }
}

客戶端的Handler

public class PrintClientHandler extends ChannelHandlerAdapter {

    private static final Logger logger = Logger
        .getLogger(TimeClientHandler.class.getName());

    private final ByteBuf firstMessage;

    /**
     * Creates a client-side handler.
     */
    public TimeClientHandler() {
    byte[] req = "你好服務端".getBytes();
    firstMessage = Unpooled.buffer(req.length);                               
    firstMessage.writeBytes(req);

    }

    @Override
    public void channelActive(ChannelHandlerContext ctx) {
    ctx.writeAndFlush(firstMessage);                                                
    }

    @Override
    public void channelRead(ChannelHandlerContext ctx, Object msg)            
        throws Exception {
    ByteBuf buf = (ByteBuf) msg;    
    byte[] req = new byte[buf.readableBytes()];
    buf.readBytes(req);
    String body = new String(req, "UTF-8");
    System.out.println("服務端回應訊息 : " + body);
    }

    @Override
    public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) {  
    // 釋放資源
    System.out.println("Unexpected exception from downstream : "
        + cause.getMessage());
    ctx.close();
    }
}

上訴程式碼邏輯與上一章程式碼邏輯相同，客戶端接受服務端資料答應，並回復客戶端資訊，客戶端接受到資料後列印資料。

我們觀察程式碼可以發現，要想Netty解決粘包拆包問題，只需在編寫服務端和客戶端的pipeline上加上相應的解碼器即可，上訴註釋 1，2，3，4處。其餘程式碼無需做任何修改。

LineBasedFrameDecoder+StringDecoder的組合就是按行切換的文字解碼器，它被設計用來支援TCP的粘包和拆包。原理為：如果連續讀取到最大長度後任然沒有發現換行符，就會丟擲異常，同時忽略掉之前督導的異常碼流。

DelimiteBasedFrameDecoder

該解碼器的可以自動完成以分割符作為碼流結束標識的訊息解碼。（其實上一個解碼器類似，如果指定分隔符為換行符，那麼與上一個編碼器的作用基本相同）

使用也很簡單：

只需要修改服務端和客戶端對應程式碼中的initChannel程式碼即可

            public void initChannel(SocketChannel ch)               
                ByteBuf delimiter = Unpooled.copiedBuffer("_".getBytes()); //1
                ch.pipeline().addLast(
                    new DelimiterBasedFrameDecoder(1024,
                        delimiter));                                       //2
                ch.pipeline().addLast(new StringDecoder());                 //3
                ch.pipeline().addLast(new PrintHandler());
            }

註釋1：首先建立分隔符緩衝物件ByteBuf，並指定以"_"作為分隔符。

註釋2：將分隔符緩衝物件ByteBuf傳入DelimiterBasedFrameDecoder，並指定最大長度。

註釋3：指定為字串位元組流

FixedLengthFrameDecoder

該解碼器為固定長度解碼器，它能夠按照指定的長度對詳細進行自動解碼。

使用同樣也很簡單：

同樣只需要修改服務端和客戶端對應程式碼中的initChannel程式碼即可

    public void initChannel(SocketChannel ch)
                throws Exception {
                ch.pipeline().addLast(new FixedLengthFrameDecoder(20));
                ch.pipeline().addLast(new StringDecoder());
                ch.pipeline().addLast(new PrintHandler());
            }
            });

這樣我們就指定了，每接收20個字元大小的字串位元組流就將其看作一個包來經行處理。

總結

Netty已經在底層為我們做了很多事情，我們只需要簡單的使用其提供好的解碼器使用即可，原始碼內容待我研究歸來，再進行展開，哈哈，完活~睡覺！

相關文章