开源的C#实现WebSocket协议客户端和服务器websocket-sharp
组件解析
很久没有写博客了（⾄少⾃⼰感觉很长时间没有写了），没办法啊，楼主也是需要⽣活的⼈啊，这段⼀直都在⼯作什么的。（整天催我代码的⼈，还望多多谅解啊，我会坚持写我们的项⽬的，还是需要相信我的，毕竟这是⼀个耗时耗⼒的事情，需要所有参与者都坚持的事情。）
上⾯扯淡完毕后，下⾯进⼊我们今天的整体。看到这篇博客的题⽬，估计很多⼈都会问，这个组件是不是有些显的⽆聊了，说到web通信，很多⼈都会想到ASP.NET SignalR，或者Nodejs等等，实现web的⽹络实时通讯。有关于web实时通信的相关概念问题，在这⾥就不再做具体的介绍了，有兴趣的可以⾃⾏百度。
下⾯我们介绍⼀款WebSocket组件websocket-sharp的相关内容。
⼀.websocket-sharp组件概述
nodejs工作流引擎开源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 "
:
"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");
ws.SetProxy ("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))检查参数关闭。
ateHandshakeRequest()：
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，这⾥也只是简单的介绍，需要使⽤的同学，可以⾃取，因为该组件是开源的，所以⼀些实际情况中可以⾃⾏修改源码，达到最⼤限度的扩展性。在项⽬的技术选择中，个⼈⽐较主张开源免费的框架和组件，不仅是项⽬预算的问题，更有⽅便扩展的作⽤。
版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。
发表评论