C#实现WebSocket协议客户端和服务器websocket sharp组件实例解析

看到这篇文章的题目，估计很多人都会问，这个组件是不是有些显的无聊了，说到web通信，很多人都会想到ASP.NET SignalR，或者Nodejs等等，实现web的网络实时通讯。有关于web实时通信的相关概念问题，在这里就不再做具体的介绍了，有兴趣的可以自行百度。

  下面我们介绍一款WebSocket组件websocket-sharp的相关内容。

一.websocket-sharp组件概述

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

    websocket-sharp是一个单一的组件，websocket-sharp.dll。websocket-sharp是用MonoDevelop开发的。所以建立一个简单的方式是打开websocket-sharp.sln并使用MonoDevelop中的任何构建配置（例如Debug）运行websocket-sharp项目的构建。

    上面介绍了.NET项目中添加websocket-sharp组件，如果想向Unity项目中使用该DLL ，则应将其添加到Unity Editor中的项目的任何文件夹。在Unity的项目中，Unity Free有一些约束：Webplayer的安全沙箱（Web Player中不提供该服务器）；WebGL网络（ WebGL中不可用）；不适用于此类UWP；对System.IO.Compression的有限支持（压缩扩展在Windows上不可用）；iOS / Android的.NET Socket支持（如果您的Unity早于Unity 5，则需要iOS / Android Pro）；适用于iOS / Android的.NET API 2.0兼容级别。适用于iOS / Android的.NET API 2.0兼容性级别可能需要在.NET 2.0之后修复缺少某些功能，例如System.Func<...>代理（因此我已将其添加到该资产包中）。

二.websocket-sharp组件使用方法

    1.WebSocket客户端

using System;
using WebSocketSharp;
namespace Example
{
 public class Program
 {
  public static void Main (string[] args)
  {
   using (var ws = new WebSocket ("ws://dragonsnest.far/Laputa")) {
    ws.OnMessage += (sender, e) =>
      Console.WriteLine ("Laputa says: " + e.Data);
    ws.Connect ();
    ws.Send ("BALUS");
    Console.ReadKey (true);
   }
  }
 }
}

     由上面的代码示例中，使用WebSocketWebSocket URL 创建类的新实例来连接。一个WebSocket.OnOpen当WebSocket连接已经建立发生的事件。WebSocket.OnMessage当发生事件WebSocket接收消息。一个WebSocket.OnClose当WebSocket的连接已关闭发生的事件。如果要异步连接到服务器，应该使用该WebSocket.ConnectAsync ()方法。可以使用WebSocket.Send (string)，WebSocket.Send (byte[])或WebSocket.Send (System.IO.FileInfo)方法来发送数据。如果您想要异步发送数据，则应该使用该WebSocket.SendAsync方法。如果要明确地关闭连接，应该使用该WebSocket.Close方法。

    2.WebSocket服务器

using System;
using WebSocketSharp;
using WebSocketSharp.Server;
namespace Example
{
 public class Laputa : WebSocketBehavior
 {
  protected override void OnMessage (MessageEventArgs e)
  {
   var msg = e.Data == "BALUS"
        ? "I've been balused already..."
        : "I'm not available now.";
   Send (msg);
  }
 }
 public class Program
 {
  public static void Main (string[] args)
  {
   var wssv = new WebSocketServer ("ws://dragonsnest.far");
   wssv.AddWebSocketService<Laputa> ("/Laputa");
   wssv.Start ();
   Console.ReadKey (true);
   wssv.Stop ();
  }
 }
}

    以通过创建继承WebSocketBehavior该类的类定义任何WebSocket服务的行为。可以WebSocketServer通过使用WebSocketServer.AddWebSocketService<TBehaviorWithNew> (string)或WebSocketServer.AddWebSocketService<TBehavior> (string, Func<TBehavior>)方法将任何WebSocket服务添加到服务的指定行为和路径。wssv.Start ();启动WebSocket服务器。wssv.Stop (code, reason);停止WebSocket服务器。

    3.消息压缩

ws.Compression = CompressionMethod.Deflate;

    4.HTTP身份验证

ws.SetCredentials ("nobita", "password", preAuth);

    5.通过HTTP代理服务器连接

var ws = new WebSocket ("ws://example.com");
ws.SetProxy ("http://localhost:3128", "nobita", "password");

三.websocket-sharp组件核心对象解析

    1.WebSocket.Send()：

 private bool send (Opcode opcode, Stream stream)
  {
   lock (_forSend) {
    var src = stream;
    var compressed = false;
    var sent = false;
    try {
     if (_compression != CompressionMethod.None) {
      stream = stream.Compress (_compression);
      compressed = true;
     }
     sent = send (opcode, stream, compressed);
     if (!sent)
      error ("A send has been interrupted.", null);
    }
    catch (Exception ex) {
     _logger.Error (ex.ToString ());
     error ("An error has occurred during a send.", ex);
    }
    finally {
     if (compressed)
      stream.Dispose ();
     src.Dispose ();
    }
    return sent;
   }
  }

    使用WebSocket连接发送指定的数据，该方法存在多个重载版本，并且该方法也有异步实现。该方法返回一个布尔类型的参数，表示本次信息是否发送成功。该方法接受两个参数，Opcode是一个枚举类型，表示WebSocket框架类型。该枚举类型值有Cont(等于数值0.表示连续帧)，Text(相当于数值1.表示文本框)，Binary(相当于数值2.表示二进制帧)，Close(相当于数值8.表示连接关闭框架)，Ping(相当于数值9.表示ping帧)，Pong(相当于数值10.指示pong框)。stream表示一个流对象。该方法设置了锁操作，防止并发时出现死锁问题。不过看到代码中对异常的捕获还是有些问题，该方法是直接捕获exception异常，这样会导致程序捕获代码块中的所有异常，这样会影响代码的稳定性和代码的可修复性，异常捕获的最好处理方式是将程序进行恢复。

    2.WebSocket.CloseAsync()：

public void CloseAsync (CloseStatusCode code, string reason)
  {
   string msg;
   if (!CheckParametersForClose (code, reason, _client, out msg)) {
    _logger.Error (msg);
    error ("An error has occurred in closing the connection.", null);
    return;
   }
   closeAsync ((ushort) code, reason);
  }

    该方法以指定的方式异步关闭WebSocket连接，该方法接受两个参数，CloseStatusCode表示关闭原因的状态码，该参数是一个枚举类型。reason表示关闭的原因。大小必须是123字节或更少。if (!CheckParametersForClose (code, reason, _client, out msg))检查参数关闭。

    3.WebSocket.createHandshakeRequest()：

private HttpRequest createHandshakeRequest()
    {
      var ret = HttpRequest.CreateWebSocketRequest(_uri);
      var headers = ret.Headers;
      if (!_origin.IsNullOrEmpty())
        headers["Origin"] = _origin;
      headers["Sec-WebSocket-Key"] = _base64Key;
      _protocolsRequested = _protocols != null;
      if (_protocolsRequested)
        headers["Sec-WebSocket-Protocol"] = _protocols.ToString(", ");
      _extensionsRequested = _compression != CompressionMethod.None;
      if (_extensionsRequested)
        headers["Sec-WebSocket-Extensions"] = createExtensions();
      headers["Sec-WebSocket-Version"] = _version;
      AuthenticationResponse authRes = null;
      if (_authChallenge != null && _credentials != null)
      {
        authRes = new AuthenticationResponse(_authChallenge, _credentials, _nonceCount);
        _nonceCount = authRes.NonceCount;
      }
      else if (_preAuth)
      {
        authRes = new AuthenticationResponse(_credentials);
      }
      if (authRes != null)
        headers["Authorization"] = authRes.ToString();
      if (_cookies.Count > 0)
        ret.SetCookies(_cookies);
      return ret;
    }

     该方法用于客户端创建一个websocket请求，创建握手请求。var ret = HttpRequest.CreateWebSocketRequest(_uri);根据传入的uri调用HttpRequest的方法创建请求。该方法主要操作http头部信息，创建请求。

四.总结

   对于这个组件，个人感觉还是有一些用，这个组件很好的实现了websocket，这里也只是简单的介绍，需要使用的同学，可以自取，因为该组件是开源的，所以一些实际情况中可以自行修改源码，达到最大限度的扩展性。在项目的技术选择中，个人比较主张开源免费的框架和组件，不仅是项目预算的问题，更有方便扩展的作用。

以上所述是小编给大家介绍的C#实现WebSocket协议客户端和服务器websocket-sharp组件实例解析，希望对大家有所帮助，如果大家有任何疑问请给我留言，小编会及时回复大家的。在此也非常感谢大家对网站的支持！

# c#  # websocket  # sharp  # websocket服务端与客户端  # C#基于WebSocket实现聊天室功能  # C#用websocket实现简易聊天功能(客户端)  # C#用websocket实现简易聊天功能(服务端)  # C#使用WebSocket实现聊天室功能  # C# 实现WebSocket服务端教程  # C# websocket及时通信协议的实现方法示例  # C# Websocket连接实现wss协议  # 是一个  # 客户端  # 很多人  # 适用于  # 将其  # 死锁  # 代理服务器  # 小编  # 中不  # 开源  # 则应  # 可以自行  # 身份验证  # 您的  # 在这里  # 如果您  # 也有  # 很好  # 相关内容  # 多个 

相关文章： 学生网站制作软件,一个12岁的学生写小说，应该去什么样的网站？  香港服务器网站生成指南：免费资源整合与高速稳定配置方案  如何在腾讯云服务器上快速搭建个人网站？  建站之星后台密码如何安全设置与找回？  建站之星免费模板：自助建站系统与智能响应式一键生成  c++如何打印函数堆栈信息_c++ backtrace函数与符号名解析【方法】  如何在阿里云ECS服务器部署织梦CMS网站？  广州建站公司哪家好？十大优质服务商推荐  如何零成本快速生成个人自助网站？  如何通过PHP快速构建高效问答网站功能？  如何在Golang中实现微服务服务拆分_Golang微服务拆分与接口管理方法  制作宣传网站的软件,小红书可以宣传网站吗？  如何用西部建站助手快速创建专业网站？  武汉网站如何制作,黄黄高铁武穴北站途经哪些村庄？  如何在服务器上三步完成建站并提升流量？  西安专业网站制作公司有哪些,陕西省建行官方网站？  如何快速搭建高效简练网站？  清除minerd进程的简单方法  如何破解联通资金短缺导致的基站建设难题？  建站ABC备案流程中有哪些关键注意事项？  如何通过西部建站助手安装IIS服务器？  建站主机数据库如何配置才能提升网站性能？  ppt制作免费网站有哪些,ppt模板免费下载网站？  如何登录建站主机？访问步骤全解析  建站之星安装路径如何正确选择及配置？  网站制作壁纸教程视频,电脑壁纸网站？  如何制作一个表白网站视频,关于勇敢表白的小标题？  猪八戒网站制作视频,开发一个猪八戒网站，大约需要多少？或者自己请程序员，需要什么程序员，多少程序员能完成？  如何快速生成橙子建站落地页链接？  高配服务器限时抢购：企业级配置与回收服务一站式优惠方案  专业商城网站制作公司有哪些,pi商城官网是哪个？  淘宝制作网站有哪些,淘宝网官网主页？  韩国服务器如何优化跨境访问实现高效连接？  免费制作统计图的网站有哪些,如何看待现如今年轻人买房难的情况？  行程制作网站有哪些,第三方机票电子行程单怎么开？  如何在景安服务器上快速搭建个人网站？  小说建站VPS选用指南：性能对比、配置优化与建站方案解析  如何用低价快速搭建高质量网站？  代购小票制作网站有哪些,购物小票的简要说明？  宿州网站制作公司兴策,安徽省低保查询网站？  巅云智能建站系统：可视化拖拽+多端适配+免费模板一键生成  如何在IIS中新建站点并解决端口绑定冲突？  如何挑选优质建站一级代理提升网站排名？  如何在云服务器上快速搭建个人网站？  javascript中的try catch异常捕获机制用法分析  网站制作专业公司有哪些,如何制作一个企业网站，建设网站的基本步骤有哪些？  微信h5制作网站有哪些,免费微信H5页面制作工具？  常州自助建站工具推荐：低成本搭建与模板选择技巧  建站之星在线版空间：自助建站+智能模板一键生成方案  Python文件管理规范_工程实践说明【指导】