急急如律令！火速搭建一個C#即時通信系統！（附源碼分享——高度可移植！）

     （2016年3月更：由於后來了解到GGTalk開源即時通訊系統，因此直接采用了該資源用於項目開發，在此對作者表示由衷的感謝！）

     ——————————————————————————————————

     人在外包公司，身不由己！各種雜七雜八的項目都要做，又沒有自己的技術沉淀，每次涉足新的項目都倍感吃力，常常現學現賣，卻不免處處碰壁！當然，話說回來，也是自己的水平有限在先，一馬配一鞍，無奈也只能留在外包公司。

      這不，就在上一周，領導下達一個任務：3天內搭建一個C#即時通訊系統，與原有的辦公系統集成。

      我正心里犯嘀咕；“網絡編程自己就只知道一點皮毛啊，還是大學選修課上聽老師講的那一點東西，別說即時通訊了，以前也就只照着書上的例子寫過一個抓包工具當作業交過，徹頭徹尾的小白啊，何況都畢業幾年了，連“套接字”都快忘了！”

      領導補充說：“這個即時通訊系統要盡快完成，之后還有別的的項目。”

      我：“······好的”

      沒辦法，就像領導常說的“有條件要上，沒有條件創造條件也要上！”，臨危受命，唯有逆流而上！

      想都別想，寫即時通訊總不能從socket寫起啊，那樣寫出來的東西只能讀書的時候當作業交給老師看下，然后記一個平時成績，給領導看那就是找抽！

      所以，只能“登高而招，順風而呼”，園子里大神多，資源也多，找找看有沒有可以參考的。（這也是我一直以來的工作方法，呵呵）

      終於，看到了一篇輕量級通信引擎StriveEngine通信demo源碼研究學習了一下，稍加揣摩，很快就完成了領導所交付的重任！在此要鳴謝該文的作者！

      言歸正傳，接下來就把自己的學習所得以及編寫過程詳盡的分享給大家！

 

一·C#即時通信系統界面快照

            

    

    

 

二·網絡消息流與通信協議

     首先，網絡中的數據是源源不斷的二進制流，有如長江之水連綿不絕，那么，即時通訊系統如何從連綿不絕的數據流中准確的識別出一個消息呢？換言之，在悠遠綿長的網絡數據流中，一個個具體的消息應該如何被界定出來呢？

     這就需要用到通信協議。通信協議，一個大家耳熟能詳的術語，什么TCP啊、UDP啊、IP啊、ICMP啊，以前學《計算機網絡》時，各種協議充斥寰宇。但是，從教科書上抽象的概念中，你真的了解什么是通信協議嗎？

     回到開始的問題，我想恐怕可以這樣來理解：通信協議就是要讓消息遵循一定的格式，而這樣的格式是參與通信的各方都知曉且遵守的，依據這樣的格式，消息就能從數據流中被完整的識別出來。

     通信協議的格式通常分為兩類：文本消息、二進制消息。 

     文本協議相對簡單，通常使用一個特殊的標記符作為一個消息的結束。這樣一來，根據這個特殊的標志符，每個消息之間就有了明確的界限。 

     二進制協議，通常是由消息頭（Header）和消息體（Body）構成的，消息頭的長度固定，而且，通過解析消息頭，可以知道消息體的長度。如此，我們便可以從網絡流中解析出一個個完整的二進制消息。
     兩種協議各有優劣，雖然文本協議比較簡單方便，但是二進制協議更具有普適性，諸如圖片啊、文件啊都可以轉化為二進制數組，所以我在寫即時通訊時采用的是二進制協議。

     我定義的二進制協議是：消息頭固定為8個字節：前四個字節為一個int，其值表示消息類型；后四個字節也是一個int，其值表示消息體長度。

     先來看消息頭的定義 

public class MsgHead
    { 
        private int messageType;
        /// <summary>
        /// 消息類型
        /// </summary>
        public int MessageType
        {
            get { return messageType; }
            set { messageType = value; }
        }

        private int bodyLength;
        /// <summary>
        /// 消息體長度
        /// </summary>
        public int BodyLength
        {
            get { return bodyLength; }
            set { bodyLength = value; }
        }

        public const int HeadLength = 8;


        public MsgHead(int msgType,int bodyLen)
        {
            this.bodyLength = bodyLen;
            this.messageType = msgType;
        }

        public byte[] ToStream()
        {
            byte[] buff = new byte[MsgHead.HeadLength];
            byte[] bodyLenBuff = BitConverter.GetBytes(this.bodyLength);
            byte[] msgTypeBuff = BitConverter.GetBytes(this.messageType);
            Buffer.BlockCopy(msgTypeBuff, 0, buff, 0, msgTypeBuff.Length);
            Buffer.BlockCopy(bodyLenBuff, 0, buff, 4, bodyLenBuff.Length);
            return buff;
        }
    }

    然后我們將識別消息的方法封裝到一個協議助手類中，即收到消息的時候，明確如下兩個問題：1.固定前多少位是消息頭。2.如何從消息頭中獲取消息體長度。

 public class StreamContractHelper : IStreamContractHelper
    {
        /// <summary>
        /// 消息頭長度
        /// </summary>
        public int MessageHeaderLength
        {
            get { return MsgHead.HeadLength; }
        }
        /// <summary>
        /// 從消息頭中解析出消息體長度，從而可以間接取出消息體
        /// </summary>
        /// <param name="head"></param>
        /// <returns></returns>
        public int ParseMessageBodyLength(byte[] head)
        {
            return BitConverter.ToInt32(head,4);
        }
    }
   

          

三·通信協議類

然后我們來定義滿足協議的消息基類，其中重點是要定義ToContractStream（）方法，使得消息能夠序列化成滿足協議的二進制流，從而通過網絡進行傳輸。 

 [Serializable]
    public class BaseMsg
    {
        private int msgType;

        public int MsgType
        {
            get { return msgType; }
            set { msgType = value; }
        }       
        /// <summary>
        /// 序列化為本次通信協議所規范的二進制消息流
        /// </summary>
        /// <returns></returns>
        public byte[] ToContractStream()
        {
            return MsgHelper.BuildMsg(this.msgType, SerializeHelper.SerializeObject(this));
        }       
    }

然后我們來看看MsgHelper類的具體實現

public static class MsgHelper
    {
        /// <summary>
        /// 構建消息
        /// </summary>
        /// <param name="msgType">消息類型</param>
        /// <param name="msgBody">消息體</param>
        /// <returns></returns>
        public static byte[] BuildMsg(int msgType, Byte[] msgBody)
        {
            MsgHead msgHead = new MsgHead(msgType, msgBody.Length);
            //將消息頭與消息體拼接起來
            byte[] msg = BufferJointer.Joint(msgHead.ToStream(), msgBody);
            return msg;
        }
      
        public static byte[] BuildMsg(int msgType, string str)
        {
            return MsgHelper.BuildMsg(msgType, Encoding.UTF8.GetBytes(str));
        }
        /// <summary>
        /// 將二進制數組還原成消息對象
        /// </summary>
        /// <typeparam name="T">所要還原成的消息類</typeparam>
        /// <param name="msg">消息數據</param>
        /// <returns></returns>
        public static T DeserializeMsg<T>(byte[] msg)
        {
            return (T)SerializeHelper.DeserializeBytes(msg, 8, msg.Length - 8);   
        }        
    }

然后我們再看一個具體的消息類ChatMsg的定義 

[Serializable]
    public class ChatMsg:BaseMsg
    {      
        private string sourceUserID;
        /// <summary>
        /// 發送該消息的用戶ID
        /// </summary>
        public string SourceUserID
        {
            get { return sourceUserID; }
            set { sourceUserID = value; }
        }
        private string targetUserID;
        /// <summary>
        /// 該消息所發往的用戶ID
        /// </summary>
        public string TargetUserID
        {
            get { return targetUserID; }
            set { targetUserID = value; }
        }
        private DateTime timeSent;
        /// <summary>
        /// 該消息的發送時間
        /// </summary>
        public DateTime TimeSent
        {
            get { return timeSent; }
            set { timeSent = value; }
        }
        private string msgText;
        /// <summary>
        /// 該消息的文本內容        /// 
        /// </summary>
        public string MsgText
        {
            get { return msgText; }
            set { msgText = value; }
        }
        /// <summary>
        /// 構造一個ChatMsg實例
        /// </summary>
        /// <param name="_sourceUserID">該消息源用戶ID</param>
        /// <param name="_targetUserID">該消息目標用戶ID</param>
        /// <param name="_MsgText">該消息的文本內容   </param>
        public ChatMsg(string _sourceUserID, string _targetUserID, string _MsgText)
        {
            base.MsgType = Core.MsgType.Chatting;
            this.sourceUserID = _sourceUserID;
            this.targetUserID = _targetUserID;
            this.timeSent = DateTime.Now;
            this.msgText = _MsgText;
        }     
    }

 

 

四·登錄的通信過程 

                                    

1.客戶端發送登陸消息 

 private void button_login_Click(object sender, EventArgs e)
        {
            this.selfID = this.textBox_ID.Text.Trim();
            LoginMsg loginMsg = new LoginMsg(this.selfID);
            this.tcpPassiveEngine.PostMessageToServer(loginMsg.ToContractStream());     
        }       

2.服務端回復登陸消息

 if (msgType == MsgType.Logining)
            {
                LoginMsg loginMsg = MsgHelper.DeserializeMsg<LoginMsg>(msg);
                this.ReplyLogining(loginMsg, userAddress);
                //將在線用戶告知其他客戶端                
                this.TellOtherUser(MsgType.NewOnlineFriend, loginMsg.SrcUserID);
            }

        /// <summary>
        /// 回復登陸消息
        /// </summary>
        /// <param name="loginMsg"></param>
        /// <param name="userAddress"></param>
        private void ReplyLogining(LoginMsg loginMsg, IPEndPoint userAddress)
        {
            if (this.onlineManager.Contains(loginMsg.SrcUserID))//重復登錄
            {
                loginMsg.LogonResult = LogonResult.Repetition;
                this.tcpServerEngine.SendMessageToClient(userAddress, loginMsg.ToContractStream());
            }
            else//此demo簡化處理回復成功，其他驗證未處理
            {
                this.AddUser(loginMsg.SrcUserID, userAddress);
                this.ShowOnlineUserCount();
                loginMsg.LogonResult = LogonResult.Succeed;
                this.tcpServerEngine.SendMessageToClient(userAddress, loginMsg.ToContractStream());
            }
        } 

3.客戶端處理登陸結果

 1         private void tcpPassiveEngine_MessageReceived(IPEndPoint userAddress, byte[] msg)
 2         {
 3             //取出消息類型
 4             int msgType = BitConverter.ToInt32(msg, 0);
 5             //驗證消息類型
 6             if (msgType == MsgType.Logining)
 7             {
 8                 LoginMsg loginMsg = MsgHelper.DeserializeMsg<LoginMsg>(msg);
 9                 if (loginMsg.LogonResult == LogonResult.Succeed)
10                 {
11                     this.DialogResult = DialogResult.OK;
12                     this.tcpPassiveEngine.MessageReceived -= new StriveEngine.CbDelegate<IPEndPoint, byte[]>(tcpPassiveEngine_MessageReceived);
13                 }
14                 if (loginMsg.LogonResult == LogonResult.Repetition)
15                 {
16                     MessageBox.Show("登錄失敗，該賬號已經登錄！");
17                 }
18             }
19         } 

                     

五·即時通信客戶端通信過程

                               

1.客戶端A發送聊天消息給服務器

 1         /// <summary>
 2         /// 發送聊天消息
 3         /// </summary>
 4         /// <param name="sender"></param>
 5         /// <param name="e"></param>
 6         private void button_send_Click(object sender, EventArgs e)
 7         {
 8             string chatText = this.richTextBox_Write.Text;
 9             if (string.IsNullOrEmpty(chatText))
10             {
11                 MessageBox.Show("消息不能為空");
12                 return;
13             }
14             ChatMsg chatMsg = new ChatMsg(this.selfUserID, this.friendID, chatText);
15             this.tcpPassiveEngine.SendMessageToServer(chatMsg.ToContractStream());
16             this.ShowChatMsg(chatMsg);
17         }       

2.服務端轉發聊天消息

1          if (msgType == MsgType.Chatting)
2          {
3              ChatMsg chatMsg = MsgHelper.DeserializeMsg<ChatMsg>(msg);
4              if (this.onlineManager.GetKeyList().Contains(chatMsg.TargetUserID))
5              {
6                  IPEndPoint targetUserAddress = this.onlineManager.Get(chatMsg.TargetUserID).Address;
7                  this.tcpServerEngine.SendMessageToClient(targetUserAddress, msg);
8              }
9          }

3.客戶端B接收並顯示聊天消息 

 void tcpPassiveEngine_MessageReceived(IPEndPoint userAddress, byte[] msg)
        {
            //取出消息類型
            int msgType = BitConverter.ToInt32(msg, 0);
            //驗證消息類型           
            if (msgType == MsgType.Chatting)
            {
                ChatMsg chatMsg = MsgHelper.DeserializeMsg<ChatMsg>(msg);
                this.ShowChatForm(chatMsg.SourceUserID);
                this.ChatMsgReceived(chatMsg);
            }
        } 

        /// <summary>
        /// 顯示聊天窗
        /// </summary>
        /// <param name="friendUserID">聊天對方用戶ID</param>
        private void ShowChatForm(string friendUserID)
        {
            if (this.InvokeRequired)
            {
                this.Invoke(new CbGeneric<string>(this.ShowChatForm), friendUserID);
            }
            else
            {
                ChatForm form = this.chatFormManager.GetForm(friendUserID);
                if (form == null)
                {
                    form = new ChatForm(this.selfID, friendUserID, this, this.tcpPassiveEngine);
                    form.Text = string.Format("與{0}對話中···", friendUserID);
                    this.chatFormManager.Add(form);
                    form.Show();
                }
                form.Focus();
            }
        }


        /// <summary>
        /// 顯示聊天消息
        /// </summary>
        /// <param name="chatMsg"></param>
        private void ShowChatMsg(ChatMsg chatMsg)
        {
            if (this.InvokeRequired)
            {
                this.Invoke(new CbGeneric<ChatMsg>(this.formMain_chatMsgReceived), chatMsg);
            }
            else
            {
                this.richTextBox_display.AppendText(chatMsg.SourceUserID + "   " + chatMsg.TimeSent.ToString() + "\r\n");
                this.richTextBox_display.AppendText(chatMsg.MsgText + "\r\n");
                this.richTextBox_Write.Clear();
            }
        }

 

五·C#即時通信源碼下載      

    源碼說明：1.客戶端與服務端均含有配置文件，可配置進程的IP與端口號。
                     2.代碼均含有詳細注釋。
                     3.調試時確保客戶端的配置文件相關信息無誤，先啟動服務端再啟動客戶端。
                     4.登錄賬號與密碼均為任意。
                     5.點擊好友頭像即可聊天。
    下載：Chat.Demo 

 

  附相關系列源碼： 

 文本協議通信demo源碼

二進制通信demo源碼及說明文檔

打通B/S與C/S通信demo源碼與說明文檔

版權聲明：本文為博主原創文章，未經博主允許不得轉載。