用Java的New IO开发网络协议
作者:
jinhuaxing
最近用Java的New IO开发了一套简单的网络协议，在这里我把开发中的一些心得整理一下，总结出一套简单的可以重用的网络协议开发框架，希望能够给初学者一点帮助。
网络协议基本的通讯单位是一个一个的消息包。在用socket传输这些包的时，首先要解决的一个问题是如何解决包与包之间的边界问题。socket传输的是流，一个send中发出的消息，在对方不一定在一个recv中收到，可能要多次recv，或者一个recv收到多个send中放出的包。所以必须由应用层协议自己来解决包的定界问题。通常有两种方法，一种是每个包以一个特殊的字符或者字符串来结束，如http协议就是以两个'\n'作为一个消息的结束标记；另一种方法就是，所有的消息都有一个固定长度的消息头，在消息头中指出这条消息的长度。我们的协议是采用第二种方法，这也是大部分协议采用的方法。本文提出的框架也是解决这种协议方式的。
Java的New IO是在J2SE1.4引入的，主要引入了Buffer这样的概念，发送接受数据都是在Buffer上进行，而对于初学者，Buffer的操作是比较复杂的，容易出错。所以在这个框架中尽可能的把对于Buffer的操作封装起来。
3. MessageFactory接口
这个接口封装了所有真正的用于表达消息的类的创建，在MessageChannel的receive中调用。这里用了抽象工厂模式。其定义如下：
public interface MessageFactory {
/**
* 返回消息头的字节数
*/
int getMessageHeaderLength();
/**
* 创建一个消息头对象
*/
MessageHeader createMessageHeader();
/**
* 创建一个消息对象
* @param type 消息类型，从消息头中取得
*/
Message createMessage(int type);
}
4. MessageChannel类
主要功能都在这个类中，用于发送和接收消息，并封装了所有对于Buffer的操作。
class MessageChannel {
/**
* 构造方法，要求指明发送缓冲区和接收缓冲区的大小
*/
public MessageChannel(int receiveBufferSize,
int sendBufferSize,
SocketChannel sc,
MessageFactory mf);
/**
* 接收一条消息，当消息不完整、收到的消息长度太大（超过接收缓冲区大小）或者不能通过MessageFactory创建的消息类型时时抛出MessageFormatException。
*/
public Message receive() throws IOException, MessageFormatException;
/**
* 发送一条消息
*/
public void send(Message message) throws IOException;
}
5. BufferUtil类
这是一个Utility类，主要功能是从ByteBuffer中取得或者放入一个字符串String，不同的协议有不同的字符串处理方法。
class BufferUtil {
/**
* 从buffer取得一个字符串，length为长度
*/
static String getString(ByteBuffer buffer, int length);
/**
* 从buffer取得一个以'\0'结束的字符串，length为最大长度
*/
static String getCString(ByteBuffer buffer, int length);
/**
* 从buffer取得一个变长的字符串，长度用两字节的short类型表示
*/
static String getVarStringShortLength(ByteBuffer buffer);
/**
* 从buffer取得一个变长的字符串，长度用四字节的int类型表示
*/
static String getVarStringIntLength(ByteBuffer buffer);
/**
* 从buffer取得一个变长的字符串，长度用一字节的byte表示
*/
static String getVarStringByteLength();
/**
* 在buffer中放入一个字符串，length为长度
*/
static void putString(ByteBuffer buffer, String str, int length);
/**
* 在buffer中放入一个字符串，length为最大长度。如果str没有达到最大长度，那么用0填充。
*/
static void putCString(ByteBuffer buffer, String str, int length);
/**
* 在buffer中放入一个字符串，长度用一个short表示
*/
static void putVarStringShortLength(ByteBuffer buffer);
/**
* 在buffer中放入一个字符串，长度用一个int表示
*/
static void putVarStringIntLength(ByteBuffer buffer);
/**
* 在buffer中放入一个字符串，长度用一个byte表示
*/
static void putVarStringByteLength(ByteBuffer buffer);
}
目前，这个类没有考虑编码方式，可以对这个类进行扩充。
在这个框架中，Message.receive是最复杂的部分，下面对该过程的流程进行说明：
(1) 根据MessageFactory.getMessageHeaderLength()返回的消息头长度，接收消息头。
(2) 用MessageFactory.createMessageHeader() 构造消息头，并调用MessageHeader.buildFromBuffer()取得消息头数据。
(3) 根据消息头中的信息，接收消息体
(4) 构造消息，并调用Message.buildBodyFromBuffer()取得消息体数据。
(5) 调用Message.setHeader()。
(6) 返回构造的消息。
这其中有一个步骤出错，将抛出MessageFormatException。
框架主要有MessageHeader, Message, MessageFactory三个接口，两个类MessageChannel, BufferUtil，以及一个异常类MessageFormatException构成。下面说明这几个接口和类的功能。
1. MessageHeader接口
在这样一套网络协议中，总是有一个固定长度的消息头，不同的协议有不同的消息头，但是几乎所有的消息头都定义了本消息的长度和本消息的类型。类型用于识别不同的消息包。类型相同的包，格式都是一样的，可以用同一个Java的class来表达。类型不同的包，格式可能相同也可能不同，依赖于协议。接口定义如下：
public interface MessageHeader {
/**
* 返回消息类型
*/
int getMessageType();
/**
* 返回消息长度
*/
int getMessageLength();
/**
* 从Buffer中提取消息头
*/
void buildFromBuffer(ByteBuffer buffer);
/**
* 把消息头放到Buffer中
*/
void appendToBuffer(ByteBuffer buffer);
}
2. Message接口
Message代表一个消息包。每个消息包有一个消息头。其定义如下：
public interface Message {
/**
* 设置消息头，在MessageChannel.receive中调用
*/
void setHeader(MessageHeader header);
/**
* 返回消息头
*/
MessageHeader getHeader();
/**
* 从Buffer中取出消息体
*/
void buildBodyFromBuffer(ByteBuffer buffer);
/**
* 把消息体放到Buffer中
*/
void appendBodyToBuffer(ByteBuffer buffer);
}
