很久没有写博客了(至少自己感觉很长时间没有写了),没办法啊,楼主也是需要生活的人啊,这段一直都在找工作什么的。(整天催我代码的人,还望多多谅解啊,我会坚持写我们的项目的,还是需要相信我的,毕竟这是一个耗时耗力的事情,需要所有参与者都坚持的事情。)
上面扯淡完毕后,下面进入我们今天的整体。看到这篇博客的题目,估计很多人都会问,这个组件是不是有些显的无聊了,说到 web 通信,很多人都会想到 ASP.NET SignalR,或者 Nodejs 等等,实现 web 的网络实时通讯。有关于 web 实时通信的相关概念问题,在这里就不再做具体的介绍了,有兴趣的可以自行百度。
下面我们介绍一款 WebSocket 组件 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 中的任何构建配置(例如
)运行 websocket-sharp 项目的构建。
- Debug
上面介绍了. 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<...>
1.WebSocket 客户端
- using System;
- using WebSocketSharp;
- namespace Example
- {
- public class Program
- {
- public static voidMain (string[] args)
- {
- using(varws =newWebSocket ("ws://dragonsnest.far/Laputa")) {
- ws.OnMessage += (sender, e) =>
- Console.WriteLine ("Laputa says: "+ e.Data);
- ws.Connect ();
- ws.Send ("BALUS");
- Console.ReadKey (true);
- }
- }
- }
- }
由上面的代码示例中,使用
WebSocket URL 创建类的新实例来连接。一个
- WebSocket
当 WebSocket 连接已经建立发生的事件。
- WebSocket.OnOpen
当发生事件
- WebSocket.OnMessage
接收消息。一个
- WebSocket
当 WebSocket 的连接已关闭发生的事件。如果要异步连接到服务器,应该使用该
- WebSocket.OnClose
方法。可以使用
- 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)
- {
- varmsg = e.Data =="BALUS""I've been balused already..."
- : "I'm not available now.";
- Send (msg);
- }
- }
- public class Program
- {
- public static voidMain (string[] args)
- {
- varwssv =newWebSocketServer ("ws://dragonsnest.far");
- wssv.AddWebSocketService ("/Laputa");
- wssv.Start ();
- Console.ReadKey (true);
- wssv.Stop ();
- }
- }
- }
以通过创建继承
该类的类定义任何 WebSocket 服务的行为。可以
- WebSocketBehavior
通过使用
- WebSocketServer
或
- WebSocketServer.AddWebSocketService<TBehaviorWithNew> (string)
方法将任何 WebSocket 服务添加到服务的指定行为和路径。wssv.Start (); 启动 WebSocket 服务器。wssv.Stop (code, reason); 停止 WebSocket 服务器。
- WebSocketServer.AddWebSocketService<TBehavior> (string, Func<TBehavior>)
3. 消息压缩
- ws.Compression = CompressionMethod.Deflate;
4.HTTP 身份验证
- ws.SetCredentials ("nobita","password", preAuth);
5. 通过 HTTP 代理服务器连接
- varws =newWebSocket ("ws://example.com");
- ws.SetProxy ("http://localhost:3128","nobita","password");
1.WebSocket.Send():
- private bool send (Opcode opcode, Stream stream)
- {
- lock (_forSend) {
- varsrc = stream;
- varcompressed =false;
- varsent =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 voidCloseAsync (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()
- {
- varret = HttpRequest.CreateWebSocketRequest(_uri);
- varheaders = 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,这里也只是简单的介绍,需要使用的同学,可以自取,因为该组件是开源的,所以一些实际情况中可以自行修改源码,达到最大限度的扩展性。在项目的技术选择中,个人比较主张开源免费的框架和组件,不仅是项目预算的问题,更有方便扩展的作用。
来源: http://www.cnblogs.com/pengze0902/p/6697192.html