C# WebSocketSharp 框架的用法

已于 2024-05-09 19:57:43 修改
阅读量3.9k 收藏 8
点赞数 4
分类专栏： C# 文章标签： c#
于 2023-06-19 14:40:41 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_38693757/article/details/131286795
版权

效果：

一、概述

WebSocketSharp 是一个 C# 实现 websocket 协议客户端和服务端，WebSocketSharp 支持RFC 6455；WebSocket客户端和服务器；消息压缩扩展；安全连接；HTTP身份验证；查询字符串，起始标题和Cookie；通过HTTP代理服务器连接；.NET Framework 3.5或更高版本（包括兼容环境，如Mono）。

github 地址

https://github.com/sta/websocket-sharp

websocket-sharp supports:

二、服务器端

服务器端的代码量很少，这里我全部使用 winform 来展示。

新建一个 winform 项目，界面如下

先安装  WebSocketSharp-netstandard 插件，我这里的版本是 1.0.1

新建一个类 ServerManager

using System;
using WebSocketSharp.Server;

internal class ServerManager
{
    private static WebSocketServer WebSocketServers = null;

    public static bool IsListening
    {
        get
        {
            if (WebSocketServers == null)
                return false;
            return WebSocketServers.IsListening;
        }
    }

    private static void Init()
    {
        WebSocketServers = new WebSocketServer(8888);

        //添加具有指定行为和路径的WebSocket服务
        //string 参数 表示要添加的服务的绝对路径
        WebSocketServers.AddWebSocketService<Laputa>("/Laputa");
    }

    public static void Open()
    {
        WebSocketServers.Start();
        Console.WriteLine("开启服务器");
    }

    public static void Close()
    {
        WebSocketServers.Stop();
        Console.WriteLine("关闭服务器");
    }

    static ServerManager()
    {
        Init();
    }

    private ServerManager() { }
}

新建一个类 Laputa，这个类相当于在 websocket 里面负责单独的模块，同样的，在客户端的访问链接也要配套。

using System;
using WebSocketSharp;
using WebSocketSharp.Server;

public class Laputa : WebSocketBehavior
{
    protected override void OnMessage(MessageEventArgs e)
    {
        Console.WriteLine("[OnMessage]" + e.Data);

        var msg = e.Data == "BALUS"
                  ? "Are you kidding?"
                  : "I'm not available now.";
        Send(msg);
    }

    protected override void OnOpen()
    {
        Console.WriteLine("[OnOpen]");
    }

    protected override void OnClose(CloseEventArgs e)
    {
        Console.WriteLine("[OnClose]" + e.Reason);
    }

    protected override void OnError(ErrorEventArgs e)
    {
        Console.WriteLine("[OnError]" + e.Message);
    }
}

OnMessage 是指收到客户端的消息

OnOpen 客户端连接到了当前的接口

OnClose 客户端断开了连接

OnError websocket 出现了错误

接下来就是 winform 界面的代码了

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WebSocketSharpServer
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {

        }

        private void Form1_FormClosing(object sender, FormClosingEventArgs e)
        {
            if (ServerManager.IsListening)
                ServerManager.Close();
        }

        private void Button_Open_Click(object sender, EventArgs e)
        {
            ServerManager.Open();
        }

        private void Button_Close_Click(object sender, EventArgs e)
        {
            ServerManager.Close();
        }
    }
}

服务器端的代码就这么多，其实还有其他的很多功能，SSL/TLS，Cookies，证书 等，有兴趣的可以参考 github 的文档。

三、客户端

客户端可以使用 html 进行连接，也可以使用其他的客户端，我这里就使用 winform 来写。

winform 界面

新建一个类 NetManager

using System;
using System.Threading.Tasks;
using WebSocketSharp;

/// <summary>
/// Websocket
/// </summary>
internal class NetManager
{
    #region 字段

    private static WebSocket WebSockets = null;

    private static int ConsoleCount = 0;

    private static System.Windows.Forms.Timer Timer = null;

    /// <summary>
    /// 当前的网络是否连接
    /// </summary>
    public static bool IsConnect
    {
        get
        {
            if (WebSockets == null)
                return false;
            return WebSockets.IsAlive;
        }
    }

    //这里ip地址可以从别的地方取值，因为用的 static 静态构造函数，
    //构造函数会调用 Init 方法，这会导致 IPAddress 为 null 就初始化完成了。
    /// <summary>
    /// websocket 的地址，一般以 ws://  或者 wss:// 开头
    /// </summary>
    public static string IPAddress { get; private set; } = "ws://127.0.0.1:8888/Laputa";
    /// <summary>
    /// 是否显示ping
    /// </summary>
    public static bool IsShowPingLog { get; set; } = false;
    /// <summary>
    /// 收到服务器消息的回调
    /// </summary>
    public static Action<string> OnMessage = null;
    /// <summary>
    /// 连接成功和断开连接的回调
    /// </summary>
    public static Action<bool> OnNetStateChange = null;



    #endregion

    #region 初始化

    private static void Init()
    {
        if (string.IsNullOrEmpty(IPAddress))
            return;

        WebSockets = new WebSocket(IPAddress);

        WebSockets.OnOpen += WebSockets_OnOpen;
        WebSockets.OnMessage += WebSockets_OnMessage;
        WebSockets.OnClose += WebSockets_OnClose;
        WebSockets.OnError += WebSockets_OnError;

        Console.WriteLine("[NetManager]初始化成功！");

        Timer = new System.Windows.Forms.Timer();//实例化Timer类，设置间隔时间(毫秒)；
        Timer.Interval = 3000;
        Timer.Tick += Timer_Tick;//到达时间的时候执行事件
    }

    private static void Timer_Tick(object sender, EventArgs e)
    {
        if (!WebSockets.IsAlive) return;

        WebSockets.Send("ping");

        if (IsShowPingLog)
        {
            Console.WriteLine("ping");

            ConsoleCount++;
            if (ConsoleCount > 100)
            {
                ConsoleCount = 0;
                Console.Clear();
            }
        }
    }

    #endregion

    #region WebSocket 相关

    private static void WebSockets_OnOpen(object sender, EventArgs e)
    {
        Console.WriteLine("[NetManager][OnOpen] 时间：{0}", DateTime.Now);
        if (OnNetStateChange != null)
            OnNetStateChange(true);
    }

    private static void WebSockets_OnError(object sender, ErrorEventArgs e)
    {
        string message = string.Format("[NetManager][OnError]{0}", e.Message);
        Console.WriteLine(message);
    }

    private static void WebSockets_OnClose(object sender, CloseEventArgs e)
    {
        Console.WriteLine("[NetManager][OnClose]" + e.Reason);

        if (OnNetStateChange != null)
            OnNetStateChange(false);

        if (!string.IsNullOrEmpty(e.Reason) && !IsClose)
        {
            DisconnectionReconnects();//断线重连
        }
    }

    private static void WebSockets_OnMessage(object sender, MessageEventArgs e)
    {
        Console.WriteLine("[NetManager][OnMessage]" + e.Data);

        //心跳类型消息
        //if (e.IsPing)
        //{
        //    Console.WriteLine("ping");
        //    return;
        //}

        //字符串类型的消息
        if (e.IsText)
        {
            if (OnMessage != null) 
                OnMessage(e.Data);
            return;
        }

        //二进制消息
        if(e.IsBinary)
        {
            //二进制使用RawData
            Console.WriteLine(e.RawData);
            return;
        }
    }

    #endregion

    #region 服务器开关

    private static bool IsClose = false;

    /// <summary>
    /// 连接服务器
    /// </summary>
    /// <returns></returns>
    public static bool Connect()
    {
        if (WebSockets == null)
            return false;
        if (WebSockets.IsAlive)
            return false;

        WebSockets.Connect();
        //异步连接服务器
        //WebSockets.ConnectAsync();
        //是否接收ping
        //WebSockets.EmitOnPing = true;

        //连接状态可以参考枚举：ReadyState
        if (WebSockets.IsAlive)
        {
            IsClose = false;
            Timer.Enabled = true;
            return true;
        }
        return false;
    }

    /// <summary>
    /// 关闭服务器连接 
    /// </summary>
    /// <returns></returns>
    public static bool Disconnect()
    {
        if (WebSockets == null)
            return false;

        WebSockets.Close();
        //异步关闭
        //WebSockets.CloseAsync();

        Timer.Enabled = false;
        IsClose = true;

        return WebSockets.IsAlive == false;
    }

    #endregion

    #region 发送消息

    /// <summary>
    /// 发送消息
    /// </summary>
    /// <param name="message"></param>
    public static void Send(string message)
    {
        if (string.IsNullOrEmpty(message))
        {
            Console.WriteLine("[NetManager]发送的消息不能为空");
            return;
        }
        if (WebSockets == null || !WebSockets.IsAlive)
        {
            Console.WriteLine("[NetManager]请先打开服务器");
            return;
        }

        WebSockets.Send(message);
        //异步发送
        //completed 是一个委托，发送完成会调用
        //WebSockets.SendAsync(data, completed);

        Console.WriteLine("[NetManager]发送：" + message);
    }

    #endregion

    #region 断线重连

    //是否正在重新连接中  
    private static bool IsReconnectioning = false;

    private static async void DisconnectionReconnects()
    {
        if (IsReconnectioning) return;

        IsReconnectioning = true;

        while (true)
        {
            if (WebSockets.IsAlive)
            {
                Console.WriteLine("[NetManager]断线重连成功");
                IsReconnectioning = false;
                break;
            }
            if (IsClose)
            {
                Console.WriteLine("[NetManager]关闭连接不必断线重连");
                break;
            }

            Console.WriteLine("[NetManager]断线重连中......");
            WebSockets.Connect();
            //WebSockets.ConnectAsync();
            await Task.Delay(TimeSpan.FromSeconds(1));
        }
    }

    #endregion

    #region 构造函数

    static NetManager()
    {
        Init();
    }

    private NetManager() { }

    #endregion
}

form1 界面代码

using System;
using System.Collections.Generic;
using System.ComponentModel;
using System.Data;
using System.Drawing;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using System.Windows.Forms;

namespace WebSocketSharpClient
{
    public partial class Form1 : Form
    {
        public Form1()
        {
            InitializeComponent();
        }

        private void Form1_Load(object sender, EventArgs e)
        {
            NetManager.OnMessage = OnMessage;           
        }

        private void Form1_FormClosing(object sender, FormClosingEventArgs e)
        {
            NetManager.Disconnect();
        }

        private void OnMessage(string msg)
        {
            Console.WriteLine("收到消息：" + msg);
        }

        private void Button_Send_Click(object sender, EventArgs e)
        {
            string msg = TextBox_Content.Text;
            NetManager.Send(msg);
        }


        private void Button_Close_Click(object sender, EventArgs e)
        {
            NetManager.Disconnect();
        }

        private void Button_Connect_Click(object sender, EventArgs e)
        {
            NetManager.Connect();
        }
    }
}

运行后，效果如下

经过一段时间的测试，目前在 websocket 的各种框架中，运行还算比较稳定的，bug 也少。

源码：点击下载

结束

如果这个帖子对你有所帮助，欢迎 关注 + 点赞 + 留言

end

C# WebSocket-Sharp 全解析：7个关键步骤教你轻松搭建WebSocket服务器与客户端！
java专栏
01-01 834
除了基本的消息传递外，消息压缩：可以通过设置属性启用压缩，减少传输的数据量。HTTP身份验证：允许设置用户名密码，增强安全性。通过HTTP代理服务器连接：当需要穿越防火墙或NAT时非常有用。经过上述讲解，相信你现在应该对如何使用C#中的有了较为全面的理解。无论是作为新手入门还是希望进一步深入研究，这篇文章都希望能够为你提供有价值的参考。记住，编程的世界里没有绝对的标准答案，关键是找到最适合当前需求的方法。希望今天的分享能够帮助你在未来的项目中写出更加优雅、高效的代码！
C# WebSocket-Sharp终极指南：从零构建实时通信系统
最新发布
墨夶的博客
04-25 331
/ 启用压缩// 自定义消息协议set;set;set;set;} // 二进制附件支持场景最佳实践代码示例高并发连接管理使用连接池 + 异步IO类实现实时消息推送事件驱动 + JSON协议OnMessage事件处理数据安全SSL加密 + 客户端证书验证配置异常处理全局异常捕获 + 重试机制OnClose重连逻辑。
开源的C#实现WebSocket协议客户端和服务器websocket-sharp组件解析
dfkqtok82472315的博客
04-12 1142
很久没有写博客了（至少自己感觉很长时间没有写了），没办法啊，楼主也是需要生活的人啊，这段一直都在找工作什么的。（整天催我代码的人，还望多多谅解啊，我会坚持写我们的项目的，还是需要相信我的，毕竟这是一个耗时耗力的事情，需要所有参与者都坚持的事情。） 上面扯淡完毕后，下面进入我们今天的整体。看到这篇博客的题目，估计很多人都会问，这个组件是不是有些显的无聊了，说到web通信，很多人都...
C# 中 WebSocket 的详细讲解与实现
net core ，前端 ，python 全栈开发
03-27 1916
WebSocket 是一种网络协议，允许客户端和服务器之间进行双向通信。与传统的 HTTP 协议不同，WebSocket 在连接建立后，不需要每次请求都重新建立连接，而是可以维持持久连接，实现实时数据传输。WebSocket 是一种高效、低延迟的通信协议，适用于实时应用程序。通过 C# 提供的和类，开发者可以轻松实现 WebSocket 客户端和服务器。无论是实时聊天、在线游戏，还是金融数据传输，WebSocket 都能够提供优秀的性能和用户体验。
【C#】WebSoket 演示（使用websocket-sharp库）
cxyhjl的博客
05-10 5794
Example 3服务器+ Example1 客户端示例3此源代码片段包含了如何使用WebSocketSharp库来创建一个HTTP服务器，并提供WebSocket服务。 分析整个代码，我们可以归纳出以下关键信息：导入了一系列重要的命名空间，包括系统配置、加密库、文本、WebSocket等。定义了Example3名称空间和包含Main方法的Program类，作为HTTP服务器和WebSocket服...
C# websocket_sharp使用详细
热门推荐
Qin066的博客
12-12 3万+
#region websocket-sharp public void websocket_sharp() { try { var url = "ws://121.40.165.18:8800"; using (var ws = new WebSocketSharp.Web...
C#实现WebSocket协议客户端和服务器websocket sharp组件实例解析
12-31
看到这篇文章的题目，估计很多人都会问，这个组件是不是有些显的无聊了，说到web通信，很多人都会想到ASP.NET SignalR，或者Nodejs等等，实现web的网络实时通讯。有关于web实时通信的相关概念问题，在这里就不再做具体的介绍了，有兴趣的可以自行百度。   下面我们介绍一款WebSocket组件websocket-sharp的相关内容。 一.websocket-sharp组件概述     websocket-sharp是一个C#实现websocket协议客户端和服务端，websocket-sharp支持RFC 6455；WebSocket客户端和服务器；消息压缩扩展；安全连接；HT
C# WebSocketSharp框架实战教程：客户端与服务器应用示例
总结，WebSocketSharp框架简化了C#中WebSocket的使用，无论是客户端还是服务器端，它提供的API和事件驱动模式使得开发者能够更加聚焦于业务逻辑的实现而不是通讯机制的细节。通过阅读和分析示例代码，开发者可以迅速...
使用Fleck和WebSocketSharp实现WebStock通信
07-16
通过使用高效稳定的Fleck和WebSocket-Sharp库，我们已经成功实现了基本的双向通信功能。但这仅仅是个开始！ 现在，我们的团队正在积极开发一项创新功能——直接支持客户端与客户端之间的实时通信，这将极大地拓展...
websocket-sharp
08-27
websocket
websocket-sharp 范例
09-03
利用开源组件websocket-sharp实现websocket的范例。用于framwork4.5以下版本实现websocket。
websocket-sharp源码
12-21
websocket-sharp是一个C#实现websocket协议客户端和服务端，websocket-sharp支持RFC 6455；WebSocket客户端和服务器；消息压缩扩展；安全连接；HTTP身份验证；查询字符串，起始标题和Cookie；通过HTTP代理服务器连接；.NET Framework 3.5或更高版本（包括兼容环境，如Mono）
C#基于websocket-sharp实现简易httpserver(封装)
weixin_30243533的博客
09-12 930
一、背景 　　其实就是很简单的，公司会桌面开发的人员紧缺啊，项目又赶，而我们公司的前端人员人多还厉害（ps:吐槽下，后端的人真的少啊，会桌面开发的更少啊），所以萌生出了使用html+js来构建本地应用程序，但是我们的客户基本都是制造行业，需要对很多硬件进行交互（IO卡、PLC、串口等等各种），那就势必还是需要传统的应用程序（毕竟方案多），emmm，那这两者之间需要怎么样结合呢？so就有...
C# websocket的使用 websocketsharp(库)
weixin_37744986的博客
07-16 3493
websocketsharp可以在nuget上下载 1.客户端代码 using System; using System.Collections.Generic; using System.Linq; using System.Text; using System.Threading.Tasks; using ToolBox.Socket; using WebSocketSharp;...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

熊思宇

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值