在C#桌面应用中实现WebSocket长连接

WebSocket 是一种在单个 TCP 连接上进行全双工通信的协议，它允许客户端和服务端之间建立持久连接，从而实现实时数据交换。在桌面应用中使用 WebSocket 可以实现许多实时交互功能，比如即时消息、在线协作编辑等。本文将介绍如何在 C# 桌面应用中实现WebSocket长连接，并提供一个简单的示例。

为什么使用WebSocket？

传统的HTTP请求是无状态的，每次请求都需要建立新的连接。而WebSocket则不同，一旦连接建立，就可以双向发送数据，直到连接关闭为止。这种特性非常适合需要实时更新数据的应用场景。

准备工作

为了在 C# 桌面应用中使用 WebSocket，你需要安装一个支持 WebSocket 的库。常用的库包括 WebSocketSharp 和 SuperSocket。在这里，我们将使用 WebSocketSharp 作为示例，因为它简单易用并且支持多种平台。

首先，你需要通过 NuGet 包管理器安装 WebSocketSharp 库。打开 Visual Studio，然后在你的项目中添加引用：

右键点击解决方案资源管理器中的项目 -> 选择 “Manage NuGet Packages…”。

在 “Browse” 标签页搜索 WebSocketSharp 并安装。

示例代码

下面是一个简单的 C# 桌面应用程序，演示如何使用 WebSocketSharp 创建一个 WebSocket 客户端，并保持长连接：

using System;
using WebSocketSharp;

namespace WebSocketClientApp
{
    class Program
    {
        private static WebSocket ws;

        static void Main(string[] args)
        {
            // WebSocket 服务器地址
            string url = "ws://example.com/ws";

            // 创建 WebSocket 实例
            ws = new WebSocket(url);

            // 设置事件处理程序
            ws.OnOpen += OnOpen;
            ws.OnMessage += OnMessage;
            ws.OnError += OnError;
            ws.OnClose += OnClose;

            // 连接到 WebSocket 服务器
            ws.Connect();

            // 保持程序运行
            Console.WriteLine("Press any key to close the WebSocket connection...");
            Console.ReadKey();

            // 关闭 WebSocket 连接
            ws.Close();
        }

        private static void OnOpen(object sender, EventArgs e)
        {
            Console.WriteLine("WebSocket opened.");
            // 发送一条消息
            ws.Send("Hello, WebSocket!");
        }

        private static void OnMessage(object sender, MessageEventArgs e)
        {
            Console.WriteLine("Received: " + e.Data);
        }

        private static void OnError(object sender, ErrorEventArgs e)
        {
            Console.WriteLine("Error: " + e.Message);
        }

        private static void OnClose(object sender, CloseEventArgs e)
        {
            Console.WriteLine("WebSocket closed.");
        }
    }
}

解释

创建 WebSocket 实例：使用 WebSocketSharp.WebSocket 类创建一个新的 WebSocket 客户端实例。

设置事件处理程序：为 WebSocket 设置四个基本事件处理器——OnOpen、OnMessage、OnError 和 OnClose。

OnOpen：当连接成功打开时触发。

OnMessage：当从服务器接收消息时触发。

OnError：当发生错误时触发。

OnClose：当连接关闭时触发。

连接和关闭：使用 ws.Connect() 方法连接到 WebSocket 服务器，并在用户输入后调用 ws.Close() 方法关闭连接。