接上一篇《基于.NET技术的监控系统应用分析》中所描述的数据通信协议设计，我们来看一下在C#中是怎么对自定义协议进行封包的？我们知道基于流的数据协议的特点：发送和接收到的数据都是连续的流。每次网络I/O操作的流长度不确定，也就是无法知道每次接收到的数据是一个完整的数据包。同样，主机发送一个数据包也会根据网络的实际情况执行若干次。所以我们对这类消息的编解码过程需要进行一个统一的封装。

重新回顾一下每个消息的结构：消息头 + 消息体。每次先发送出去的是消息头，然后是消息体。消息头里描述了这个数据包的类型，长度，序列号等信息。消息头的长度是固定的，消息体的长度是根据每个消息类型会有所的区别。

消息头的定义：

字段	长度（字节）	类型	说明
Length	4	Int	消息的总长度(字节)
Command ID	4	Int	命令ID
NodeID	4	Int	结点ID
TimeID	4	Int	时间戳
SequenceID	4	Int	递增序列号

对应的封装代码：

Head

上面只是一个消息头，要成为一个完整的消息，一般还必须包含消息体（当然你也可以根据需要仅发送一个消息头的数据，作为特殊用途，例如自定义的心跳包）。举个例子：客户机与服务器连接上后，它通常会发送一个绑定(Bind) 消息给服务器端。例如：验证确认客户端的合法性。那么此时的Bind消息的格式是：

字段	长度（字节）	类型	说明
HEAD			上面的消息头部
loginName	16	string	用户名（固定16位，不足用空格填充）
LoginPassword	16	string	密码（固定16位，不足用空格填充）

对应的封装代码：

using System;
using MonitorLib.Utility;

namespace MonitorLib.Protocol
{
    /// 
    /// AbstractBase 的摘要说明。
    /// 
    
    [Serializable]
    public abstract class AbstractBase
    { 
        protected byte[] initValue;
        public Head header;

        public AbstractBase()
        {
             
        }

        public virtual byte[] ToBytes()
        {
            return null;
        }
    }
}

using System;
using System.Text;
using MonitorLib.Utility;

namespace MonitorLib.Protocol
{
    /// 
    /// Bind消息
    /// 
    [Serializable]
    public class Bind : AbstractBase
    {
        private string loginName;
        private string loginPassword;

        /// 
        /// 初始Bind命令的消息头
        /// 
        /// 序列号
        public Bind(Sequence seq)
        {
            header = new Head(Command.MOT_BIND);
            header.NodeID = seq.Node;
            header.TimeID = seq.Time ;
            header.SequenceID = seq.Value ;
            header.Length = Head.HeaderLength + 16 + 16;
        }
         
        public Bind(byte[] receive)
        {
            initValue = new byte[receive.Length];
            receive.CopyTo(initValue,0); 
        }

        /// 
        /// 登录名
        /// 
        public string LoginName 
        {
            get
            {
                return Encoding.ASCII.GetString(initValue,20,16);
            }
            set
            {
                loginName = value;
            }
        }

        /// 
        /// 密码
        /// 
        public string LoginPassword
        {
            get
            {
                return Encoding.ASCII.GetString(initValue,36,16);
            }
            set
            {
                loginPassword = value;
            }
        }

        /// 
        /// 把消息结构转换成字节数组
        /// 
        /// 结果字节数组
        public override byte[] ToBytes()
        {
            byte[] retValue = new byte[this.header.Length];
            uint index = 0;

            //填充消息头
            header.ToBytes().CopyTo(retValue,index);

            index += Head.HeaderLength;
            Encoding.ASCII.GetBytes(loginName).CopyTo(retValue,index);

            //移位16位, 填充密码
            index += 16;
            Encoding.ASCII.GetBytes(loginPassword).CopyTo(retValue,index);
            return retValue;
        }
    }


    /// 
    /// Bind应答结构
    /// 
    [Serializable]
    public class Bind_Resp : AbstractBase
    {
        private uint result;

        /// 
        /// 构造函数，把接收的字节数组复制到initValue
        /// 
        /// 从网络上接收到的字节数组
        public Bind_Resp(byte[] receive)
        {
            initValue = new byte[receive.Length];
            receive.CopyTo(initValue,0); 
        }

        public Bind_Resp(Sequence seq)
        {
            header = new Head(Command.MOT_BIND_RESP);
            header.NodeID = seq.Node;
            header.TimeID = seq.Time ;
            header.SequenceID = seq.Value ;
            header.Length = Head.HeaderLength + 4;
        }

        /// 
        /// bind 执行命令是否成功,0－成功。其它：错误码。
        /// 
        public uint Result
        {
            get
            {
                return Convert.ToUInt32(initValue[20].ToString());
            }
            set
            {
                result = value;
            }
        }

        public override byte[] ToBytes()
        {
            byte[] retValue =  new byte[header.Length];
            header.ToBytes().CopyTo(retValue,0);
            BitConverter.GetBytes(result).CopyTo(retValue,20);
            return retValue;
        }
    }

}

除了这种协议封装方法外，还有一种直接利用 .NET 的字节流操作类来编解码，例如 ICMP 协议的封包代码：

 1    public class ICMPHDR 
 2    {  
 3        private byte mType; 
 4        public byte Type 
 5        {  
 6            get{ return mType; } 
 7            set{ mType = value; } 
 8        }
 9
10        private byte mCode = 0; 
11        public byte Code 
12        {  
13            get{ return mCode; } 
14            set{ mCode = value; } 
15        }
16
17        private ushort mChecksum = 0; 
18        public ushort Checksum 
19        {  
20            get{ return mChecksum; } 
21            set{ mChecksum = value; } 
22        }
23
24        private ushort mID; 
25        public ushort ID 
26        {  
27            get{ return mID; } 
28            set{ mID = value; } 
29        }
30        
31        private ushort mSeq;
32        public ushort Seq 
33        {  
34            get{ return mSeq; } 
35            set{ mSeq = value; } 
36        }
37 
38        private ulong mtmSend;
39        public ulong tmSend 
40        {  
41            get{ return mtmSend; } 
42            set{ mtmSend = value; } 
43        } 
44
45        private int mnTaskId; 
46        public int nTaskId 
47        {  
48            get{ return mnTaskId; } 
49            set{ mnTaskId = value; } 
50        }
51
52        public void Encode(BinaryWriter writer) 
53        {  
54            writer.Write(Type); 
55            writer.Write(Code); 
56            writer.Write((UInt16)Checksum); 
57            writer.Write((UInt16)ID); 
58            writer.Write((UInt16)Seq); 
59            writer.Write((UInt32)tmSend); 
60            writer.Write(nTaskId); 
61         } 
62
63        public void Decode(BinaryReader reader) 
64        {  
65            Type = reader.ReadByte(); 
66            Code = reader.ReadByte(); 
67            Checksum = reader.ReadUInt16(); 
68            ID = reader.ReadUInt16(); 
69            Seq = reader.ReadUInt16(); 
70            tmSend = reader.ReadUInt32(); 
71            nTaskId = reader.ReadInt32(); 
72        } 
73
74        public uint Sum() 
75        {  
76            uint sum = 0; 
77            sum += (ushort)(Type + (Code << 8)); 
78            sum += (ushort)ID; 
79            sum += (ushort)Seq; 
80            sum += (ushort)tmSend; 
81            sum += (ushort)(tmSend >> 16); 
82            sum += (ushort)nTaskId; 
83            sum += (ushort)(nTaskId >> 16); 
84            return sum; 
85        } 
86    } 

以上介绍了用C#是如何对自定义的通信协议封装的过程。如有不同的处理方法的朋友，欢迎评论，一起探讨一下。

ITPub博客

基于C#的通信协议封包(附代码)

最新文章