WebSocket-Sharp：一個強大的WebSockets C#庫

WebSockets是一種在Web瀏覽器和Web服務器之間創建持久性連接的協議。這種協議可以允許瀏覽器和服務器之間進行全雙工通信，從而可以實現實時性、低延遲的數據傳輸。WebSocket-Sharp是一個廣泛使用的C#庫，它提供了一個簡單易用的API，從而可以幫助開發人員在.NET應用程序中集成WebSocket協議。

一、安裝和引用

要開始使用WebSocket-Sharp，首先需要下載它的NuGet程序包，然後將其安裝在您的.NET應用程序中：

Install-Package WebSocketSharp

在您的代碼中，您需要在命名空間中導入WebSocketSharp名稱空間：

using WebSocketSharp;

二、創建WebSocket服務器

下面是一個示例代碼，說明如何在C#中創建一個WebSocket服務器。在這個示例中，服務器監聽所有的IP地址和端口9100。當客戶端與服務器建立連接時，服務器將發送一條歡迎消息，接着接收客戶端的消息並輸出它們：

// Create a new WebSocket server
var server = new WebSocketServer(IPAddress.Any, 9100);

// When a new client connects
server.OnConnection += (sender, e) =>
{
    Console.WriteLine("A new client connected.");
    e.WebSocket.Send("Welcome to the server!");
};

// When a client sends a message
server.OnMessage += (sender, e) =>
{
    Console.WriteLine("Client sent a message: " + e.Data);
};

// Start the server
server.Start();

三、創建WebSocket客戶端

下面是一個示例代碼，說明如何在C#中創建一個WebSocket客戶端。在這個示例中，客戶端連接到本地主機的端口9100，並發送一條消息給服務器：

// Create a new WebSocket client
var client = new WebSocket("ws://localhost:9100");

// When the client connects
client.OnOpen += (sender, e) =>
{
    Console.WriteLine("Connected to the server.");
    client.Send("Hello, server!");
};

// When the client receives a message
client.OnMessage += (sender, e) =>
{
    Console.WriteLine("Server sent a message: " + e.Data);
};

// Connect the client
client.Connect();

四、發送和接收二進制數據

WebSocket-Sharp還支持發送和接收二進制數據。以下是一個示例代碼，說明如何在C#中發送和接收二進制數據：

// Send binary data
var data = new byte[] { 1, 2, 3, 4, 5 };
webSocket.Send(data);

// Receive binary data
webSocket.OnMessage += (sender, e) =>
{
    if (e.IsBinary)
    {
        var receivedData = e.RawData;
        // Process received data...
    }
};

五、與WebSocket通信時的異常處理

當與WebSocket通信時出現問題時，WebSocket-Sharp會拋出異常。以下是一些示例異常以及如何在C#中處理它們：

WebSocketException

當在套接字上發生錯誤時，WebSocketException異常被拋出。例如，如果WebSocket客戶端無法連接到WebSocket服務器，則WebSocketException異常將被拋出。您可以使用try-catch語句來處理此異常：

try
{
    webSocket.Connect();
}
catch (WebSocketException ex)
{
    Console.WriteLine("Failed to connect: " + ex.Message);
}

MessageTooBigException

當接收到的消息過大時，MessageTooBigException異常被拋出。您可以使用try-catch語句來處理此異常：

webSocket.OnMessage += (sender, e) =>
{
    try
    {
        var message = e.Data;
        // Process message...
    }
    catch (MessageTooBigException ex)
    {
        Console.WriteLine("Received message too big: " + ex.Message);
    }
};

NotImplementedException

當調用尚未實現的功能時，NotImplementedException異常被拋出。例如，如果您嘗試使用WebSocket-Sharp內置的壓縮支持，則NotImplementedException異常將被拋出。您可以使用try-catch語句來處理此異常：

try
{
    webSocket.Compression = CompressionMethod.Deflate;
}
catch (NotImplementedException ex)
{
    Console.WriteLine("Compression not implemented: " + ex.Message);
}

六、WebSocketSharp的其他功能

除了上面介紹的功能外，WebSocket-Sharp還提供了許多其他功能，例如：

• ping和pong消息
• 文本數據壓縮
• 支持SSL加密的WebSocket連接
• 檢查服務器是否支持WebSocket協議

有關如何使用這些功能的更多信息，請參閱WebSocket-Sharp的文檔。