Mina、Netty、Twisted一起学（四）：定制自己的协议

在前面的博文中，介绍一些消息分割的方案，以及MINA、Netty、Twisted针对这些方案提供的相关API。例如MINA的TextLineCodecFactory、PrefixedStringCodecFactory，Netty的LineBasedFrameDecoder、LengthFieldBasedFrameDecoder，Twisted的LineOnlyReceiver、Int32StringReceiver。

除了这些方案，还有很多其他方案，当然也可以自己定义。在这里，我们定制一个自己的方案，并分别使用MINA、Netty、Twisted实现对这种消息的解析和组装，也就是编码和解码。

上一篇博文中介绍了一种用固定字节数的Header来指定Body字节数的消息分割方案，其中Header部分是常规的大字节序（Big-Endian）的4字节整数。本文中对这个方案稍作修改，将固定字节数的Header改为小字节序（Little-Endian）的4字节整数。

常规的大字节序表示一个数的话，用高字节位的存放数字的低位，比较符合人的习惯。而小字节序和大字节序正好相反，用高字节位存放数字的高位。

Python中struct模块支持大小字节序的pack和unpack，在Java中可以用下面的两个方法实现小字节序字节数组转int和int转小字节序字节数组，下面的Java程序中将会用到这两个方法：

public class LittleEndian {
	
	/**
	 * 将int转成4字节的小字节序字节数组
	 */
	public static byte[] toLittleEndian(int i) {
		byte[] bytes = new byte[4];
		bytes[0] = (byte) i;
		bytes[1] = (byte) (i >>> 8);
		bytes[2] = (byte) (i >>> 16);
		bytes[3] = (byte) (i >>> 24);
		return bytes;
	}
	
	/**
	 * 将小字节序的4字节的字节数组转成int
	 */
	public static int getLittleEndianInt(byte[] bytes) {
		int b0 = bytes[0] & 0xFF;
        int b1 = bytes[1] & 0xFF;
        int b2 = bytes[2] & 0xFF;
        int b3 = bytes[3] & 0xFF;
        return b0 + (b1 << 8) + (b2 << 16) + (b3 << 24);
	}
}

无论是MINA、Netty还是Twisted，消息的编码、解码、切合的代码，都是应该和业务逻辑代码分开，这样有利于代码的开发、重用和维护。在MINA和Netty中类似，编码、解码需要继承实现相应的Encoder、Decoder，而在Twisted中则是继承Protocol实现编码解码。虽然实现方式不同，但是它们的功能都是一样的：

1、对消息根据一定规则进行切合，例如固定长度消息、按行、按分隔符、固定长度Header指定Body长度等；

2、将切合后的消息由字节码转成自己想要的类型，如MINA中将IoBuffer转成字符串，这样messageReceived接收到的message参数就是String类型；

3、write的时候可以传入自定义类型的参数，由编码器完成编码。

下面分别用MINA、Netty、Twisted实现4字节的小字节序int来指定body长度的消息的编码和解码。

MINA：

在MINA中对接收到的消息进行切合和解码，一般会定义一个解码器类，继承自抽象类CumulativeProtocolDecoder，实现doDecode方法：

public class MyMinaDecoder extends CumulativeProtocolDecoder {

	@Override
	protected boolean doDecode(IoSession session, IoBuffer in, ProtocolDecoderOutput out) throws Exception {
		
		// 如果没有接收完Header部分（4字节），直接返回false
		if(in.remaining() < 4) {
			return false;
		} else {
			
			// 标记开始位置，如果一条消息没传输完成则返回到这个位置
			in.mark();
			
			byte[] bytes = new byte[4];
			in.get(bytes); // 读取4字节的Header
			
			int bodyLength = LittleEndian.getLittleEndianInt(bytes); // 按小字节序转int
			
			// 如果body没有接收完整，直接返回false
			if(in.remaining() < bodyLength) {
				in.reset(); // IoBuffer position回到原来标记的地方
				return false;
			} else {
				byte[] bodyBytes = new byte[bodyLength];
				in.get(bodyBytes);
				String body = new String(bodyBytes, "UTF-8");
				out.write(body); // 解析出一条消息
				return true;
			}
		}
	}
}

另外，session.write的时候要对数据编码，需要定义一个编码器，继承自抽象类ProtocolEncoderAdapter，实现encode方法：

public class MyMinaEncoder extends ProtocolEncoderAdapter {

	@Override
	public void encode(IoSession session, Object message,
			ProtocolEncoderOutput out) throws Exception {
		
		String msg = (String) message;
		byte[] bytes = msg.getBytes("UTF-8");
		int length = bytes.length;
		byte[] header = LittleEndian.toLittleEndian(length); // 按小字节序转成字节数组
		
		IoBuffer buffer = IoBuffer.allocate(length + 4);
		buffer.put(header); // header
		buffer.put(bytes); // body
		buffer.flip();
		out.write(buffer);
	}
}

在服务器启动的时候加入相应的编码器和解码器：

public class TcpServer {

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

		// 指定编码解码器
		acceptor.getFilterChain().addLast("codec", 
				new ProtocolCodecFilter(new MyMinaEncoder(), new MyMinaDecoder()));

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

下面是业务逻辑的代码：

public class TcpServerHandle extends IoHandlerAdapter {

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

	// 接收到新的数据
	@Override
	public void messageReceived(