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组件实例解析，希望对大家有所帮助