Netty、MINA、Twisted一起學系列03：TCP訊息固定大小的字首(Header)

文章已獲得作者授權，原文地址：
xxgblog.com/2014/08/22/mina-netty-twisted-3

在上一篇文章（Netty、MINA、Twisted一起學系列02：TCP訊息邊界問題及按行分割訊息）中，有介紹到用換行符分割訊息的方法。但是這種方法有個小問題，如果訊息中本身就包含換行符，那將會將這條訊息分割成兩條，結果就不對了。

本文介紹另外一種訊息分割方式，即上一篇文章中講的第2條：use a fixed length header that indicates the length of the body，用一個固定位元組數的Header字首來指定Body的位元組數，以此來分割訊息。

Netty、MINA、Twisted一起學系列03：TCP訊息固定大小的字首(Header) 固定位元組數的Header字首來指定Body的位元組數

上面圖中 Header 固定為 4 位元組，Header 中儲存的是一個 4 位元組（32位）的整數，例如 12 即為 0x0000000C，這個整數用來指定 Body 的長度（位元組數）。當讀完這麼多位元組的 Body 之後，又是下一條訊息的 Header。

下面分別用MINA、Netty、Twisted來實現對這種訊息的切合和解碼。

MINA

MINA 提供了 PrefixedStringCodecFactory 來對這種型別的訊息進行編碼解碼，PrefixedStringCodecFactory 預設 Header 的大小是4位元組，當然也可以指定成1或2。

public class TcpServer {

  public static void main(String[] args) throws IOException {
    IoAcceptor acceptor = new NioSocketAcceptor();

    // 4位元組的Header指定Body的位元組數，對這種訊息的處理
    acceptor.getFilterChain().addLast("codec",
        new ProtocolCodecFilter(new PrefixedStringCodecFactory(Charset.forName("UTF-8"))));

    acceptor.setHandler(new TcpServerHandle());
    acceptor.bind(new InetSocketAddress(8080));
  }

}

class TcpServerHandle extends IoHandlerAdapter {

  @Override
  public void exceptionCaught(IoSession session, Throwable cause)
      throws Exception {
    cause.printStackTrace();
  }

  // 接收到新的資料
  @Override
  public void messageReceived(IoSession session, Object message)
      throws Exception {

    String msg = (String) message;
    System.out.println("messageReceived:" + msg);

  }

  @Override
  public void sessionCreated(IoSession session) throws Exception {
    System.out.println("sessionCreated");
  }

  @Override
  public void sessionClosed(IoSession session) throws Exception {
    System.out.println("sessionClosed");
  }
}

Netty

Netty 使用 LengthFieldBasedFrameDecoder 來處理這種訊息。下面程式碼中的new LengthFieldBasedFrameDecoder(80, 0, 4, 0, 4)中包含5個引數，分別是int maxFrameLength, int lengthFieldOffset, int lengthFieldLength, int lengthAdjustment, int initialBytesToStrip。maxFrameLength為訊息的最大長度，lengthFieldOffset為Header的位置，lengthFieldLength為Header的長度，lengthAdjustment為長度調整（預設Header中的值表示Body的長度，並不包含Header自己），initialBytesToStrip為去掉位元組數（預設解碼後返回Header+Body的全部內容，這裡設為4表示去掉4位元組的Header，只留下Body）。

public class TcpServer {

  public static void main(String[] args) throws InterruptedException {
    EventLoopGroup bossGroup = new NioEventLoopGroup();
    EventLoopGroup workerGroup = new NioEventLoopGroup();
    try {
      ServerBootstrap b = new ServerBootstrap();
      b.group(bossGroup, workerGroup)
          .channel(NioServerSocketChannel.class)
          .childHandler(new ChannelInitializer<SocketChannel>() {
            @Override
            public void initChannel(SocketChannel ch)
                throws Exception {
              ChannelPipeline pipeline = ch.pipeline();

              // LengthFieldBasedFrameDecoder按行分割訊息，取出body
              pipeline.addLast(new LengthFieldBasedFrameDecoder(80, 0, 4, 0, 4));
              // 再按UTF-8編碼轉成字串
              pipeline.addLast(new StringDecoder(CharsetUtil.UTF_8));

              pipeline.addLast(new TcpServerHandler());
            }
          });
      ChannelFuture f = b.bind(8080).sync();
      f.channel().closeFuture().sync();
    } finally {
      workerGroup.shutdownGracefully();
      bossGroup.shutdownGracefully();
    }
  }

}

class TcpServerHandler extends ChannelInboundHandlerAdapter {

  // 接收到新的資料
  @Override
  public void channelRead(ChannelHandlerContext ctx, Object msg) {

    String message = (String) msg;
    System.out.println("channelRead:" + message);
  }

  @Override
  public void channelActive(ChannelHandlerContext ctx) {
    System.out.println("channelActive");
  }

  @Override
  public void channelInactive(ChannelHandlerContext ctx) {
    System.out.println("channelInactive");
  }

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

Twisted

在Twisted中需要繼承Int32StringReceiver，不再繼承Protocol。Int32StringReceiver表示固定32位（4位元組）的Header，另外還有Int16StringReceiver、Int8StringReceiver等。而需要實現的接受資料事件的方法不再是dataReceived，也不是lineReceived，而是stringReceived。

# -*- coding:utf-8 –*-

from twisted.protocols.basic import Int32StringReceiver
from twisted.internet.protocol import Factory
from twisted.internet import reactor

class TcpServerHandle(Int32StringReceiver):

    # 新的連線建立
    def connectionMade(self):
        print 'connectionMade'

    # 連線斷開
    def connectionLost(self, reason):
        print 'connectionLost'

    # 接收到新的資料
    def stringReceived(self, data):
        print 'stringReceived:' + data

factory = Factory()
factory.protocol = TcpServerHandle
reactor.listenTCP(8080, factory)
reactor.run()

下面是Java編寫的一個客戶端測試程式：

public class TcpClient {

  public static void main(String[] args) throws IOException {

    Socket socket = null;
    DataOutputStream out = null;

    try {

      socket = new Socket("localhost", 8080);
      out = new DataOutputStream(socket.getOutputStream());

      // 請求伺服器
      String data1 = "牛頓";
      byte[] outputBytes1 = data1.getBytes("UTF-8");
      out.writeInt(outputBytes1.length); // write header
      out.write(outputBytes1); // write body

      String data2 = "愛因斯坦";
      byte[] outputBytes2 = data2.getBytes("UTF-8");
      out.writeInt(outputBytes2.length); // write header
      out.write(outputBytes2); // write body

      out.flush();

    } finally {
      // 關閉連線
      out.close();
      socket.close();
    }

  }

}

MINA伺服器輸出結果：

sessionCreated
messageReceived:牛頓
messageReceived:愛因斯坦
sessionClosed

Netty伺服器輸出結果：

channelActive
channelRead:牛頓
channelRead:愛因斯坦
channelInactive

Twisted伺服器輸出結果：

connectionMade
stringReceived:牛頓
stringReceived:愛因斯坦
connectionLost

Netty、MINA、Twisted一起學系列03：TCP訊息固定大小的字首(Header)

相關文章