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客户端

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 using System; using WebSocketSharp; namespaceExample { publicclass Program { publicstatic voidMain (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服务器

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 using System; using WebSocketSharp; using WebSocketSharp.Server; namespaceExample { publicclass Laputa : WebSocketBehavior { protectedoverridevoid OnMessage (MessageEventArgs e) { var msg = e.Data == "BALUS" ? "I"ve been balused already..." : "I"m not available now."; Send (msg); } } publicclassProgram { publicstaticvoid Main (string[] args) { var wssv = newWebSocketServer ("ws://dragonsnest.far"); wssv.AddWebSocketService<Laputa> ("/Laputa"); wssv.Start (); Console.ReadKey (true); wssv.Stop (); } } }

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

3.消息压缩

1 ws.Compression = CompressionMethod.Deflate;

4.HTTP身份验证

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

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

1 2 var ws = newWebSocket ("ws://example.com"); ws.SetProxy ("http://localhost:3128", "nobita", "password");

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

1.WebSocket.Send()：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 privatebool 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 (); } returnsent; } }

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

2.WebSocket.CloseAsync()：

1 2 3 4 5 6 7 8 9 10 public voidCloseAsync (CloseStatusCode code, stringreason) { stringmsg; if(!CheckParametersForClose (code, reason, _client, outmsg)) { _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()：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 privateHttpRequest 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 = newAuthenticationResponse(_authChallenge, _credentials, _nonceCount); _nonceCount = authRes.NonceCount; } else if(_preAuth) { authRes = newAuthenticationResponse(_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，这里也只是简单的介绍，需要使用的同学，可以自取，因为该组件是开源的，所以一些实际情况中可以自行修改源码，达到最大限度的扩展性。在项目的技术选择中，个人比较主张开源免费的框架和组件，不仅是项目预算的问题，更有方便扩展的作用。

所属专题:

如果您觉得本文或图片不错，请把它分享给您的朋友吧！