.Net開發筆記（十四） 基於“泵”的UDP通訊（接上篇）

周見智發表於2013-07-03
筆記UDP

上一篇中說到了“泵”在程式設計中的作用以及一些具體用處，但沒有實際demo，可能不好理解，這篇文章我分享一個UDP通訊的demo，大概實現了類似“飛鴿傳書”在區域網中文字訊息和檔案傳輸的功能。功能不全也不是很完善，但足以說明“泵”在程式碼中的具體應用。

先來回憶一下上篇中“泵”的含義，首先它是可持續運作的，其次它可以將“資料”從一個地方傳遞到另外一個地方，供其他人使用。搬一張上篇的圖：

圖1 程式中“泵”結構圖

如上圖所示，每個泵有一個“待處理”的資料容器（緩衝區），泵迴圈裡面還可以有一個“預處理”的地方，可以在資料被傳遞之前，先做處理，最後，泵會輸出資料，供別人使用。完成“資料來源”->“泵”->“使用者”這樣一個過程，明顯“泵”起到動力的作用。我們可以看見，“使用者”使用資料的過程包含在“泵迴圈”之內，也就是說，如果使用資料時，耗時太長，一次“泵迴圈”不能及時返回，那麼，緩衝區中的資料就會累積，得不到及時處理，影響“泵”的工作效率。能解決該問題有兩種途徑：

  • 1）在使用資料時，不做長時間耗時操作；
  • 2）先不直接使用資料，先將“泵”傳遞出來的資料存入另外一個容器（緩衝區），再另外開闢執行緒去處理緩衝區中的資料。

其中1）明顯治標不治本，不能解決實際問題，2）倒是可以一試，因為它將“使用資料”和“泵迴圈”分離開來，使“使用資料”不會直接影響到“泵”的工作。其實上一篇中說到“UDP通訊結構”時就已經按照2）所說的實現的，我那時候說不能將資料處理、資料分析都放在“資料接收泵”中，因為有一個主要原因就是，那樣做會影響資料接收的效率。後來我畫了一張UDP通訊結構圖，裡面用到了三個“泵”（資料接收泵、資料分析泵、資料處理泵），如下圖：

圖2 UDP通訊中“泵”的使用

如上圖，“資料分析泵”使用到了“資料接收泵”傳遞出來的資料，“資料處理泵”使用到了“資料分析泵”傳遞出來的資料，它們都沒有直接使用，都是先將資料存入對應緩衝區，然後開闢新的“泵”（也是另開闢執行緒吧）去處理。這樣一來，每個環節互不影響其他環節的工作效率。

在實現這個UDP通訊demo時，我定義了三個“泵”類，一個資料傳送類，和一個幫助類，分別如下：

  • UDPSocket：主要實現了資料接受泵，以及socket繫結等；
  • DataAnalyse：資料分析泵；
  • DataDeal：資料處理泵；
  • UDPSender：資料傳送；
  • Help.cs中一些型別：輔助功能。

其中，DataAnalyse是UDPSocket中“泵”傳遞出來資料的使用者，DataDeal是DataAnalyse中“泵”傳遞出來資料的使用者，然後我們（開發者）是DataDeal中“泵”傳遞出來資料的使用者。

需要說明的是，預設請款下，DataDeal中的“泵”是不會傳遞出來任何資料，DataAnalyse中的“泵”也不會傳遞出來任何資料，我們需要根據具體需求，實現自己的DataDeal和DataAnalyse類，重寫Deal和Analyse虛方法。我定義了兩個類，分別為MyDataDeal和MyDataAnalyse，具體程式碼如下：

    /// <summary>
    /// 自定義資料處理類 重寫Deal方法
    /// 負責處理某一些資料，其餘交給基類
    /// 可以繼續從MyDataDeal派生新的類，繼續重寫Deal方法
    /// </summary>
    public class MyDataDeal : DataDeal
    {
        public event LoginEventHandler Login;
        public event LoginBackEventHandler LoginBack;
        public event TxtMessageReceivedEventHandler TxtMessageReceived;
        public event TxtMessageBackEventHandler TxtMessageBack;
        public event LogoutEventHandler Logout;
        public event AskSendFileEventHandler AskSendFile;
        public event AskSendFileBackEventHandler AskSendFileBack;
        public event SendFileDataEventHandler SendFileData;
        public event ReceiveFileOKEventHandler ReceiveFileOK;
        public event SendFileStopEventHandler SendFileStop;
        public event ReceiveFileStopEventHandler ReceiveFileStop;
        public event SendFileDataBackEventHandler SendFileDataBack; 

        public MyDataDeal(DataAnalyse dataAnalyse)
            : base(dataAnalyse)
        {

        }
        protected override void Deal(Data data)
        {
            switch (data.Msg)
            {
                case Msg.ZMsg1:
                    {
                        if (Login != null)
                        {
                            Login(data.RemoteIP, data.RemotePort, data.Content.ToString());
                        }
                        break;
                    }
                case Msg.ZMsg2:
                    {
                        if (LoginBack != null)
                        {
                            LoginBack(data.RemoteIP, data.RemotePort, data.Content.ToString());
                        }
                        break;
                    }
                case Msg.ZMsg3:
                    {
                        if (TxtMessageReceived != null)
                        {
                            TxtMessageReceived(data.RemoteIP, data.RemotePort, data.Content.ToString());
                        }
                        break;
                    }
                case Msg.ZMsg4:
                    {
                        if(TxtMessageBack != null)
                        {
                            TxtMessageBack(data.RemoteIP, data.RemotePort, data.Content.ToString());
                        }
                        break;
                    }
                case Msg.ZMsg5:
                    {
                        if (Logout != null)
                        {
                            Logout(data.RemoteIP, data.RemotePort, data.Content.ToString());
                        }
                        break;
                    }
                case Msg.ZMsg6:
                    {
                        if (AskSendFile != null)
                        {
                            object[] objs = data.Content as object[];
                            int uid = (int)objs[0];
                            long length = (long)objs[1];
                            string filename = objs[2].ToString();

                            AskSendFile(data.RemoteIP, data.RemotePort, filename, length, uid); 
                        }
                        break;
                    }
                case Msg.ZMsg7:
                    {
                        if (AskSendFileBack != null)
                        {
                            object[] objs = data.Content as object[];
                            int uid = (int)objs[0];
                            int result = (int)objs[1];
                            AskSendFileBack(data.RemoteIP, data.RemotePort, result, uid); 
                        }
                        break;
                    }
                case Msg.ZMsg8:
                    {
                        if (SendFileData != null)
                        {
                            object[] objs = data.Content as object[];
                            int uid = (int)objs[0];
                            int part = (int)objs[1];
                            byte[] dat = objs[2] as byte[];
                            SendFileData(data.RemoteIP, data.RemotePort, dat, uid, part);
                        }
                        break;
                    }
                case Msg.ZMsg9:
                    {
                        if (ReceiveFileOK != null)
                        {
                            int uid = (int)data.Content;
                            ReceiveFileOK(data.RemoteIP, data.RemotePort, uid);
                        }
                        break;
                    }
                case Msg.ZMsg10:
                    {
                        if (SendFileStop != null)
                        {
                            int uid = (int)data.Content;
                            SendFileStop(data.RemoteIP, data.RemotePort, uid);
                        }
                        break;
                    }
                case Msg.ZMsg11:
                    {
                        if (ReceiveFileStop != null)
                        {
                            int uid = (int)data.Content;
                            ReceiveFileStop(data.RemoteIP, data.RemotePort, uid);
                        }
                        break;
                    }
                case Msg.ZMsg12:
                    {
                        if (SendFileDataBack != null)
                        {
                            object[] objs = data.Content as object[];
                            int uid = (int)objs[0];
                            int part = (int)objs[1];
                            SendFileDataBack(data.RemoteIP, data.RemotePort, uid, part);
                        }
                        break;
                    }
                default:
                    {
                        base.Deal(data); //其他由基類處理
                        break;
                    }
            }
        }
    }
    public delegate void LoginEventHandler(string remoteIP,int remotePort,string remoteName);
    public delegate void LoginBackEventHandler(string remoteIP,int remotePort,string remoteName);
    public delegate void TxtMessageReceivedEventHandler(string remoteIP,int remotePort,string txtMsg);
    public delegate void TxtMessageBackEventHandler(string remoteIP,int remotePort,string txtMsgBack);
    public delegate void LogoutEventHandler(string remoteIP,int remotePort,string remoteName);
    public delegate void AskSendFileEventHandler(string remoteIP,int remotePort,string filename,long length,int uid);
    public delegate void AskSendFileBackEventHandler(string remoteIP,int remotePort,int result,int uid);
    public delegate void SendFileDataEventHandler(string remoteIP,int remotePort,byte[] data,int uid,int part);
    public delegate void ReceiveFileOKEventHandler(string remoteIP,int remotePort,int uid);
    public delegate void SendFileStopEventHandler(string remoteIP,int remotePort,int uid);
    public delegate void ReceiveFileStopEventHandler(string remoteIP,int remotePort,int uid);
    public delegate void SendFileDataBackEventHandler(string remoteIP,int remotePort,int uid,int part);
MyDataDeal
  1     /// <summary>
  2     /// 自定義資料分析類 重寫Analyse方法
  3     /// 負責分析某一些資料，其餘交給基類
  4     /// 可以繼續從MyDataAnalyse派生新的類，繼續重寫Analyse方法
  5     /// </summary>
  6     public class MyDataAnalyse : DataAnalyse
  7     {
  8         public MyDataAnalyse(UDPSocket udpSocket)
  9             : base(udpSocket)
 10         {
 11 
 12         }
 13         protected override void Analyse(RawData rawData)
 14         {
 15             string ip = (rawData.RemoteEP as IPEndPoint).Address.ToString(); //遠端IP
 16             int port = (rawData.RemoteEP as IPEndPoint).Port; //遠端埠
 17             if (rawData.Buffer.Length > 0)
 18             {
 19                 Msg msg = (Msg)(rawData.Buffer[0]); //頭
 20                 switch (msg)
 21                 {
 22                     case Msg.ZMsg1: //登入
 23                         {
 24                             string data = Encoding.Unicode.GetString(rawData.Buffer, 1, rawData.Length - 1);  //從1開始  因為前面有一個 頭  下同，注意是 rawData.Length(實際接收資料)  不是rawData.Buffer.Length
 25                             OnAnalysed(msg, data, ip, port);
 26                             break;
 27                         }
 28                     case Msg.ZMsg2: //登入反饋
 29                         {
 30                             string data = Encoding.Unicode.GetString(rawData.Buffer, 1, rawData.Length - 1);
 31                             OnAnalysed(msg, data, ip, port);
 32                             break;
 33                         }
 34                     case Msg.ZMsg3: //文字資訊
 35                         {
 36                             string data = Encoding.Unicode.GetString(rawData.Buffer, 1, rawData.Length - 1);
 37                             OnAnalysed(msg, data, ip, port);
 38                             break;
 39                         }
 40                     case Msg.ZMsg4: //文字資訊反饋
 41                         {
 42                             string data = Encoding.Unicode.GetString(rawData.Buffer, 1, rawData.Length - 1);
 43                             OnAnalysed(msg, data, ip, port);
 44                             break;
 45                         }
 46                     case Msg.ZMsg5: //退出
 47                         {
 48                             string data = Encoding.Unicode.GetString(rawData.Buffer, 1, rawData.Length - 1);
 49                             OnAnalysed(msg, data, ip, port);
 50                             break;
 51                         }
 52                     case Msg.ZMsg6: //請求傳送檔案
 53                         {
 54                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 55                             long length = BitConverter.ToInt64(rawData.Buffer, 5); //檔案大小
 56                             string filename = Encoding.Unicode.GetString(rawData.Buffer, 13, rawData.Length - 13); //檔名稱
 57                             OnAnalysed(msg, new object[] { uid, length, filename }, ip, port); //
 58                             break;
 59                         }
 60                     case Msg.ZMsg7: //請求傳送檔案反饋
 61                         {
 62                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 63                             int result = BitConverter.ToInt32(rawData.Buffer, 5); //反饋結果
 64                             OnAnalysed(msg, new object[] { uid, result }, ip, port); 
 65                             break;
 66                         }
 67                     case Msg.ZMsg8: //傳送檔案資料
 68                         {
 69                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 70                             int part = BitConverter.ToInt32(rawData.Buffer, 5); //段ID
 71                             byte[] data = new byte[rawData.Length - 9]; //實際檔案資料
 72                             Buffer.BlockCopy(rawData.Buffer, 9, data, 0, data.Length);
 73                             OnAnalysed(msg, new object[] { uid, part, data }, ip, port);
 74                             break;
 75                         }
 76                     case Msg.ZMsg9: //接收檔案完畢
 77                         {
 78                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 79                             OnAnalysed(msg, uid, ip, port);
 80                             break;
 81                         }
 82                     case Msg.ZMsg10: //傳送方中止傳送檔案
 83                         {
 84                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 85                             OnAnalysed(msg, uid, ip, port);
 86                             break;
 87                         }
 88                     case Msg.ZMsg11: //接收方中止接收檔案
 89                         {
 90                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 91                             OnAnalysed(msg, uid, ip, port);
 92                             break;
 93                         }
 94                     case Msg.ZMsg12: //傳送檔案資料反饋
 95                         {
 96                             int uid = BitConverter.ToInt32(rawData.Buffer, 1); //檔案唯一標示
 97                             int part = BitConverter.ToInt32(rawData.Buffer, 5); //段ID
 98                             OnAnalysed(msg, new object[] { uid, part }, ip, port);
 99                             break;
100                         }
101                     default:
102                         {
103                             base.Analyse(rawData);  //其他由基類分析
104                             break;
105                         }
106                 }
107             }
108         }
109     }
MyDataAnalyse

如程式碼所示，各位下載原始碼後，可以將UDPSocket、UDPSender、DataDeal、DataAnalyse以及Help.cs檔案中的一些型別封裝起來，生成一個通用程式集，實際使用中，只需要引用該程式集，並且實現自己的DataDeal和DataAnalyse就行。

另外，demo中我還定義了一套自己的“通訊協議”，如下：

 1 ZMsg1：使用者新上線                  頭+使用者資訊
 2 ZMsg2：使用者新上線反饋              頭+反饋使用者資訊
 3 ZMsg3：文字訊息                    頭+密碼+訊息正文
 4 ZMsg4：文字訊息反饋                頭+原始訊息
 5 ZMsg5：離線                        頭+任意文字
 6 ZMsg6：請求傳送檔案                頭+傳送檔案的唯一標示+大小+檔名
 7 ZMsg7：請求傳送檔案反饋            頭+檔案的唯一標示+1或0           1代表接收 0代表拒絕
 8 ZMsg8：傳送檔案資料                頭+檔案唯一標示+段ID+檔案資料（byte[]）
 9 ZMsg9：接收檔案完畢                頭+檔案唯一標示
10 ZMsg10：傳送方中止傳送檔案         頭+檔案唯一標示
11 ZMsg11：接收方中止接收檔案         頭+檔案唯一標示
12 ZMsg12：傳送檔案資料反饋           頭+檔案唯一標示+段ID
訊息協議

通訊協議根據具體需求而不同。

總結一下，在其他專案中具體使用步驟如下：

  1. 根據具體需求，定義一套“訊息協議”；
  2. 從DataAnalyse派生出一個新的類，根據“訊息協議”重寫Analyse方法，進行資料分析；
  3. 從DataDeal派生出一個新的類，根據具體業務邏輯重寫Deal方法，進行資料處理；
  4. 資料傳送方必須嚴格按照“訊息協議”傳送資料；
  5. 最後，你要做的就是註冊DataDeal派生類的一些事件，使用“泵”傳遞出來的程式可識別資料。

原始碼下載地址：https://files.cnblogs.com/xiaozhi_5638/UDPMessager.rar

希望對各位有幫助。附幾張效果圖

相關文章