C# Socket編程實現簡單的區域網聊天器

  • 2020 年 3 月 16 日
  • 筆記

前言

最近在學習C# Socket相關的知識,學習之餘,動手做了一個簡單的區域網聊天器。有萌生做這個的想法,主要是由於之前家裡兩台電腦之間想要傳輸文件十分麻煩,需要藉助QQ,微信或者其他第三方應用,基本都要登錄,而且可能傳輸的文件還有大小限制,壓縮問題。所以本聊天器的首要目標就是解決這兩個問題,做到使用方便(雙擊啟動即用),傳文件無限制。
廢話不多說,先上圖。S-Chat是服務端,C-Chat是客戶端,兩者除了客戶端首次啟動後需要設置一下連接的IP地址外,無其他區別。操作與介面都完全相同,對於用戶來說,基本不用在意誰是服務端誰是客戶端。

編碼

服務端監聽介面

服務端主要負責開啟監聽執行緒,等待客戶端接入

public void StartListen()  {      // 創建Socket對象 new Socket(AddressFamily.InterNetwork, SocketType.Stream, ProtocolType.Tcp)      Socket socket = GetSocket();      // 將套接字與IPEndPoint綁定      socket.Bind(this.GetIPEndPoint());      // 開啟監聽 僅支援一個連接      socket.Listen(1);      // 開啟執行緒等待客戶端接入,避免堵塞      Thread acceptThread = new Thread(new ThreadStart(TryAccept));      acceptThread.IsBackground = true;      acceptThread.Start();  }    public void TryAccept()  {      Socket socket = GetSocket();      while (true)      {          try          {              Socket connectedSocket = socket.Accept()              this.ConnectedSocket = connectedSocket;              OnConnect();  // 連接成功回調              this.StartReceive();  // 開始接收執行緒              break;          }          catch (Exception e)          {          }      }  }

客戶端連接介面

客戶端主要負責開啟連接執行緒,每隔2秒,自動嘗試連接服務端

public void StartConnect()  {      Thread connectThread = new Thread(new ThreadStart(TryConnect));      connectThread.IsBackground = true;      connectThread.Start();  }    public void TryConnect()  {      Socket socket = GetSocket();      while (true)      {          try          {              socket.Connect(this.GetIPEndPoint());              this.ConnectedSocket = socket;              OnConnect();  // 連接成功回調              this.StartReceive();              break;          }          catch (Exception e)          {              Thread.Sleep(TryConnectInterval);  // 指定間隔後重新嘗試連接          }      }  }

文字發送,文件發送,接收文字,接收文件等通用介面主要實現在ChatBase類中,是服務端與客戶端的共同父類。

文字發送介面

發送數據的第一位表示發送資訊的類型,0表示字元串文字,1表示文件
然後獲取待發送字元串的長度,使用long類型表示,佔用8個位元組
共發送的位元組數據可以表示為頭部(類型 + 字元串位元組長度,共9個位元組)+ 實際字元串位元組數據

public bool Send(string msg)  {      if (ConnectedSocket != null && ConnectedSocket.Connected)      {          byte[] buffer = UTF8.GetBytes(msg);          byte[] len = BitConverter.GetBytes((long)buffer.Length);          byte[] content = new byte[1 + len.Length + buffer.Length];          content[0] = (byte)ChatType.Str;  // 發送資訊類型,字元串          Array.Copy(len, 0, content, 1, len.Length);  // 字元串位元組長度          Array.Copy(buffer, 0, content, 1 + len.Length, buffer.Length);  // 實際字元串位元組數據          try          {              ConnectedSocket.Send(content);              return true;          }          catch (Exception e)          {          }      }      return false;  }

文件發送介面

與字元串發送相同的頭部可以表示為(類型 + 文件長度,共9個位元組)
還需要再加上待發送的文件名的長度,與文件名位元組數據
共發送的位元組數據可以表示為頭部(類型 + 文件長度,共9個位元組)+ 文件名頭部(文件名長度 + 文件名位元組數據)+ 實際文件數據

public bool SendFile(string path)  {      if (ConnectedSocket != null && ConnectedSocket.Connected)      {          try          {              FileInfo fi = new FileInfo(path);              byte[] len = BitConverter.GetBytes(fi.Length);              byte[] name = UTF8.GetBytes(fi.Name);              byte[] nameLen = BitConverter.GetBytes(name.Length);              byte[] head = new byte[1 + len.Length + nameLen.Length + name.Length];              head[0] = (byte)ChatType.File;  // 加上資訊發送類型              Array.Copy(len, 0, head, 1, len.Length);  // 加上文件長度              Array.Copy(nameLen, 0, head, 1 + len.Length, nameLen.Length);  // 加上文件名長度              Array.Copy(name, 0, head, 1 + len.Length + nameLen.Length, name.Length);  // 加上文件名位元組數據              ConnectedSocket.SendFile(                  path,                  head,                  null,                  TransmitFileOptions.UseDefaultWorkerThread              );              return true;          }          catch(Exception e)          {          }      }      return false;  }

資訊接收介面(文字與文件)

主要是解析接收到的位元組數據,根據字元串或文件的類型進行處理

public void Receive()  {      if (ConnectedSocket != null)      {          while (true)          {              try              {                  // 讀取公共頭部                  byte[] head = new byte[9];                  ConnectedSocket.Receive(head, head.Length, SocketFlags.None);                  int len = BitConverter.ToInt32(head, 1);                  if (head[0] == (byte) ChatType.Str)                  {                      // 接收字元串                      byte[] buffer = new byte[len];                      ConnectedSocket.Receive(buffer, len, SocketFlags.None);                      OnReceive(ChatType.Str, UTF8.GetString(buffer));                  }                  else if(head[0] == (byte)ChatType.File)                  {                      // 接收文件                      if (!Directory.Exists(dirName))                      {                          Directory.CreateDirectory(dirName);                      }                      // 讀取文件名資訊                      byte[] nameLen = new byte[4];                      ConnectedSocket.Receive(nameLen, nameLen.Length, SocketFlags.None);                      byte[] name = new byte[BitConverter.ToInt32(nameLen, 0)];                      ConnectedSocket.Receive(name, name.Length, SocketFlags.None);                      string fileName = UTF8.GetString(name);                      // 讀取文件內容並寫入                      int readByte = 0;                      int count = 0;                      byte[] buffer = new byte[1024 * 8];                      string filePath = Path.Combine(dirName, fileName);                      if (File.Exists(filePath))                      {                          File.Delete(filePath);                      }                      using (FileStream fs = new FileStream(filePath, FileMode.Append, FileAccess.Write))                      {                          while (count != len)                          {                              int readLength = buffer.Length;                              if(len - count < readLength)                              {                                  readLength = len - count;                              }                              readByte = ConnectedSocket.Receive(buffer, readLength, SocketFlags.None);                              fs.Write(buffer, 0, readByte);                              count += readByte;                          }                      }                      OnReceive(ChatType.File, fileName);                  }                  else                  {                      // 未知類型                  }              }              catch (Exception e)              {              }          }      }  }

使用

  • 第一次使用,客戶端需要設置待連接的IP地址。之後再啟動會自動連接
    1. 雙擊服務端exe啟動,點擊設置,查看IP地址項

    2. 雙擊客戶端exe啟動,點擊設置,在IP地址項,輸入服務端查看到的IP地址

  • 設置成功後,等待大約一兩秒,應用cion變成綠色,即表示連接成功,可以正常發送文字和文件了
  • 可以點擊選擇文件(支援選擇多個文件),發送文件
  • 支援直接拖拽文件到輸入框,發送文件
  • 支援Ctrl+Enter快捷鍵發送
  • 接收到的文件自動存放在exe所在目錄的ChatFiles文件夾下

注意事項

  • 客戶端服務端需要在同一個區域網下才能實現連接
  • 服務端IP地址是不支援修改的,自動讀取本機的IP地址

源碼

  • 完整程式碼放在GitHub上,點擊查看
  • 預編譯好的可運行exe程式,在倉庫的Release目錄,也可以直接通過百度雲下載,提取碼v4pe