Socket.io .NET（開發者使用指南）

Socket.IO是一個 JavaScript 函式庫，可讓網路用戶端和伺服器進行即時通訊。 它由兩部分組成：

Socket IO 的部分內容

• 用戶端程式庫：在瀏覽器中執行。
• 伺服器端程式庫：在 Node.js 上執行。

安裝必要的套件

若要在 Visual Studio 中為 .NET 應用程式使用 Socket.IO，您需要相容的伺服器實作。 其中一個實作是適用於 .NET 的 SocketIoClientDotNet，它允許 Socket.IO 客戶端從 C# 應用程式連接至 Socket.IO。

首先，安裝所需的 NuGet 套件。 您可以透過套件管理員控制台，或是將參考資料加入專案檔案中：

Install-Package SocketIoClientDotNet

SocketIoClientDotNet 套件的螢幕截圖

!Socket io .NET (How It Works For Developers)：圖 3 - 使用管理 NuGet Package for Solution 安裝 Socket.IO for NET，方法是在 NuGet Package Manager 的搜尋列中搜尋"SocketIoClientDotNet"套件名稱，然後選擇專案並點選安裝按鈕。

執行此指令會將 Socket.IO 客戶端函式庫納入您的 .NET 專案中，使您的 C# 應用程式能夠與 Socket.IO 伺服器連線，促進使用者與系統之間的溝通。

在深入研究 C# 用戶端之前，讓我們先在 Visual Studio 中使用 .NET Core Console App 設定一個 Socket IO 的基本範例。 這將有助於我們測試客戶端的實作。

建立伺服器實作

以下程式碼以 C# 設定了一個基本的 Socket.IO 伺服器，該伺服器會在連接埠 3000 監聽用戶端連線。當用戶端傳送訊息時，伺服器會記錄該訊息，並回應給用戶端，確認收到訊息。

using System;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Quobject.SocketIoClientDotNet.Client;

namespace DemoApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            // Connect to the Socket.IO server
            var socket = IO.Socket("http://localhost:3000");

            // Listen for the "connect" event
            socket.On(Socket.EVENT_CONNECT, () =>
            {
                Console.WriteLine("Connected to the server!");

                // Emit a message to the server
                socket.Emit("message", "Hello from C# client!");

                // Listen for messages from the server
                socket.On("message", (data) =>
                {
                    Console.WriteLine("Message from server: " + data);
                });
            });

            // Listen for the "disconnect" event
            socket.On(Socket.EVENT_DISCONNECT, () =>
            {
                Console.WriteLine("Disconnected from the server!");
            });

            // Keep the console window open
            Console.ReadLine();
        }
    }
}

using System;
using System.Net.WebSockets;
using System.Text;
using System.Threading;
using System.Threading.Tasks;
using Quobject.SocketIoClientDotNet.Client;

namespace DemoApp
{
    internal class Program
    {
        static void Main(string[] args)
        {
            // Connect to the Socket.IO server
            var socket = IO.Socket("http://localhost:3000");

            // Listen for the "connect" event
            socket.On(Socket.EVENT_CONNECT, () =>
            {
                Console.WriteLine("Connected to the server!");

                // Emit a message to the server
                socket.Emit("message", "Hello from C# client!");

                // Listen for messages from the server
                socket.On("message", (data) =>
                {
                    Console.WriteLine("Message from server: " + data);
                });
            });

            // Listen for the "disconnect" event
            socket.On(Socket.EVENT_DISCONNECT, () =>
            {
                Console.WriteLine("Disconnected from the server!");
            });

            // Keep the console window open
            Console.ReadLine();
        }
    }
}

程式碼解釋

在該片段中，我們首先透過呼叫 IO.Socket("http://localhost:3000") 建立一個 Socket.IO 用戶端實例，該實例會連線至在用戶端機器上執行於 3000 連接埠的本機伺服器。

成功連線後 (Socket.EVENT_CONNECT)，我們會列印一則訊息，表示我們已連線到伺服器。

然後，我們使用 socket.Emit("message", "Hello from C# client!") 從用戶端向伺服器傳送訊息。 這會向伺服器傳送內容為"Hello from C# client!"的訊息。

接下來，我們使用 socket.On("message", (data) => { ... 註冊"訊息"事件的回呼，以聆聽伺服器的訊息。 }). 當伺服器傳送"訊息"事件時，回呼函式會被呼叫，我們會將收到的訊息列印到控制台。

如果客戶端斷開與伺服器的連線 (Socket.EVENT_DISCONNECT)，我們會列印一則表示斷開連線的訊息。

最後，Console.ReadLine() 方法會保持控制台視窗開啟，以便程式不會在執行後立即退出。 這可讓我們看到輸出，並確保程式不會過早終止。

程式碼的螢幕截圖

在 Visual Studio 中安裝 IronPDF，或使用 NuGet Package Manager 從命令列安裝。 在 Visual Studio 中，進入控制台：

• 工具 -> NuGet 套件管理員 -> 套件管理員控制台

Install-Package IronPdf

IronPDF 程式碼範例

以下是使用 IronPDF 將二進位資料轉換成 PDF 檔案的簡單範例。在 Main 方法中呼叫 GeneratePDF 方法，並傳入我們在上面範例中的資料作為參數：

using System;
using System.Net.WebSockets;
using System.Threading;
using System.Threading.Tasks;

namespace SocketIO.Demo
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // The WebSocket URI
            string uri = "wss://echo.websocket.org";

            // Creating a new WebSocket connection
            using (ClientWebSocket webSocket = new ClientWebSocket())
            {
                await webSocket.ConnectAsync(new Uri(uri), CancellationToken.None);
                Console.WriteLine("Connected to the server");

                // Sending data over the WebSocket
                byte[] sendBuffer = new byte[] { 1, 2, 3, 4 };
                await webSocket.SendAsync(new ArraySegment<byte>(sendBuffer), WebSocketMessageType.Binary, true, CancellationToken.None);
                Console.WriteLine("Data sent to the server");

                // Receiving data from the WebSocket
                byte[] receiveBuffer = new byte[1024];
                WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment<byte>(receiveBuffer), CancellationToken.None);
                byte[] data = new byte[result.Count];
                Array.Copy(receiveBuffer, data, result.Count);
                Console.WriteLine("Received data: " + BitConverter.ToString(data));

                // Data to generate in PDF file
                string pdfData = BitConverter.ToString(data);
                PDFGenerator.GeneratePDF(pdfData);
            }
        }
    }
}

using System;
using System.Net.WebSockets;
using System.Threading;
using System.Threading.Tasks;

namespace SocketIO.Demo
{
    class Program
    {
        static async Task Main(string[] args)
        {
            // The WebSocket URI
            string uri = "wss://echo.websocket.org";

            // Creating a new WebSocket connection
            using (ClientWebSocket webSocket = new ClientWebSocket())
            {
                await webSocket.ConnectAsync(new Uri(uri), CancellationToken.None);
                Console.WriteLine("Connected to the server");

                // Sending data over the WebSocket
                byte[] sendBuffer = new byte[] { 1, 2, 3, 4 };
                await webSocket.SendAsync(new ArraySegment<byte>(sendBuffer), WebSocketMessageType.Binary, true, CancellationToken.None);
                Console.WriteLine("Data sent to the server");

                // Receiving data from the WebSocket
                byte[] receiveBuffer = new byte[1024];
                WebSocketReceiveResult result = await webSocket.ReceiveAsync(new ArraySegment<byte>(receiveBuffer), CancellationToken.None);
                byte[] data = new byte[result.Count];
                Array.Copy(receiveBuffer, data, result.Count);
                Console.WriteLine("Received data: " + BitConverter.ToString(data));

                // Data to generate in PDF file
                string pdfData = BitConverter.ToString(data);
                PDFGenerator.GeneratePDF(pdfData);
            }
        }
    }
}

PDF 生成类代码

using IronPdf;

namespace SocketIO.Demo
{
    public class PDFGenerator
    {
        public static void GeneratePDF(string data)
        {
            IronPdf.License.LicenseKey = "Your-Licence-Key-Here";
            Console.WriteLine("PDF Generating Started...");

            // Instantiate Renderer
            var renderer = new ChromePdfRenderer();
            Console.WriteLine("PDF Processing ....");

            var pdf = renderer.RenderHtmlAsPdf($"<h1>Received Data</h1><p>{data}</p>");
            string filePath = "Data.pdf";
            pdf.SaveAs(filePath);
            Console.WriteLine($"PDF Generation Completed. File Saved as {filePath}");
        }
    }
}

using IronPdf;

namespace SocketIO.Demo
{
    public class PDFGenerator
    {
        public static void GeneratePDF(string data)
        {
            IronPdf.License.LicenseKey = "Your-Licence-Key-Here";
            Console.WriteLine("PDF Generating Started...");

            // Instantiate Renderer
            var renderer = new ChromePdfRenderer();
            Console.WriteLine("PDF Processing ....");

            var pdf = renderer.RenderHtmlAsPdf($"<h1>Received Data</h1><p>{data}</p>");
            string filePath = "Data.pdf";
            pdf.SaveAs(filePath);
            Console.WriteLine($"PDF Generation Completed. File Saved as {filePath}");
        }
    }
}