【问题标题】:Using WebSockets with ASP.NET Web API将 WebSocket 与 ASP.NET Web API 一起使用
【发布时间】:2014-10-29 09:00:38
【问题描述】:

在 ASP.NET Web API 应用程序中使用原始 websocket 的首选方法是什么?

我们想在我们的 ASP.NET Web API 应用程序的几个接口上使用 二进制 WebSockets。我很难确定应该如何完成,因为 .NET 的在线实现似乎有几个相互冲突和/或过时的实现。

有些例子似乎是像 one 这样的 ASP.NET,但我认为必须有一种方法可以在 Web API 框架中使用 websocket。据我所知,您可以在 WebAPI 中使用 Signalr。

我认为使用 Microsoft.AspNet.SignalR.WebSockets.WebSocketHandler 会起作用,但我不确定如何将 WebSocketHandler 链接到控制器...

class MyServiceController : ApiController
{
    [HttpGet]
    public HttpResponseMessage SwitchProtocols (string param)
    {
        HttpContext currentContext = HttpContext.Current;
        if (currentContext.IsWebSocketRequest || 
            currentContext.IsWebSocketRequestUpgrading)
        {
            // several out-dated(?) examples would 
            // use 'new MySocketHandler' for ???
            var unknown = new ????
            currentContext.AcceptWebSocketRequest(unknown); 
            return Request.CreateResponse(HttpStatusCode.SwitchingProtocols);
        }   
    }
}

class MySocketHandler : WebSocketHandler
{
    public MySocketHandler(): base(2048){}

    ...
}

不幸的是,AcceptWebSocketRequest 不再接受 WebSocketHandler,而是它的新签名是......

public void AcceptWebSocketRequest(Func<AspNetWebSocketContext, Task> userFunc)

是否有人提供在最新的 ASP.NET Web API 应用程序中实现原始 websocket 的链接或快速示例?

【问题讨论】:

    标签: c# asp.net-mvc-4 asp.net-web-api websocket signalr


    【解决方案1】:

    更新:经过我和同事的更多研究,我们得出的结论是,WebSocketHandler 类似乎不打算在 SignalR 的内部进程之外使用。因为没有明显的方法来利用与 SignalR 隔离的 WebSocketHandler。这很不幸,因为我发现它的接口比 System.Web/System.Net 接口更高级。此外,下面描述的方法使用了我认为应该避免使用的HttpContext。

    因此,我们计划采用类似于 Mrchief 展示的方法,但具有更多 Web API 风格。像这样...(注意:我们的套接字是只写的,但我发现您必须执行您希望 WebSocket.State 正确更新的读取操作。

    class MyServiceController : ApiController
    {
        public HttpResponseMessage Get (string param)
        {
            HttpContext currentContext = HttpContext.Current;
            if (currentContext.IsWebSocketRequest || 
                currentContext.IsWebSocketRequestUpgrading)
            {
                currentContext.AcceptWebSocketRequest(ProcessWebsocketSession); 
                return Request.CreateResponse(HttpStatusCode.SwitchingProtocols);
            }   
        }
    
        private async Task ProcessWebsocketSession(AspNetWebSocketContext context)
        {
            var ws = context.WebSocket;
    
            new Task(() =>
            {
                var inputSegment = new ArraySegment<byte>(new byte[1024]);
    
                while (true)
                {
                    // MUST read if we want the state to get updated...
                    var result = await ws.ReceiveAsync(inputSegment, CancellationToken.None);
    
                    if (ws.State != WebSocketState.Open)
                    {
                        break;
                    }
                }
            }).Start();
    
            while (true)
            {
                if (ws.State != WebSocketState.Open)
                {
                    break;
                }
                else
                {
                    byte[] binaryData = { 0xde, 0xad, 0xbe, 0xef, 0xca, 0xfe };
                    var segment = new ArraySegment<byte>(binaryData);
                    await ws.SendAsync(segment, WebSocketMessageType.Binary, 
                        true, CancellationToken.None);
                }
            }
        }
    }
    

    注意:显然错误检查和 CancellationToken 的正确使用留给读者作为练习。

    【讨论】:

    • 这行得通,但我从测试中学到了一些东西,我将在我的答案中更新。也就是说,如果要更新 ws.State,则必须调用 ReadAsync!
    • 感谢此代码。但是有一些编译错误——Get 方法需要在 if 块之后返回,而 lambda 内的 await 需要 lambda 上的 async 修饰符。
    • 感谢代码,这给了我很大的鼓舞。但是,将 Task.Run 与 async lambda 一起使用可能不是最好的主意(例如,您会收到编译器警告)。我最终创建了ReadTest(WebSocket) 和WriteTask(WebSocket) 并使用await Task.WhenAll(ReadTask(ws), WriteTask(ws)) 并行运行它们
    【解决方案2】:

    这是一个较老的问题,但我想对此添加另一个答案。
    事实证明,您可以使用它,但我不知道他们为什么将其如此“隐藏”。如果有人可以向我解释这门课有什么问题,或者我在这里所做的事情是某种“禁止”或“糟糕的设计”,那就太好了。

    如果我们查看Microsoft.Web.WebSockets.WebSocketHandler,我们会发现这个公共方法:

    [EditorBrowsable(EditorBrowsableState.Never)]
    public Task ProcessWebSocketRequestAsync(AspNetWebSocketContext webSocketContext);
    

    这个方法对智能感知是隐藏的,但它就在那里,并且可以在没有编译错误的情况下调用。
    我们可以使用这个方法在AcceptWebSocketRequest方法中获取我们需要返回的任务。看看这个:

    public class MyWebSocketHandler : WebSocketHandler
    {
        private static WebSocketCollection clients = new WebSocketCollection();
    
        public override void OnOpen()
        {
            clients.Add(this);
        }
    
        public override void OnMessage(string message)
        {
            Send("Echo: " + message);
        }
    }
    

    然后在我的 API 控制器中:

    public class MessagingController : ApiController
    {
        public HttpResponseMessage Get()
        {
            var currentContext = HttpContext.Current;
            if (currentContext.IsWebSocketRequest ||
                currentContext.IsWebSocketRequestUpgrading)
            {
                currentContext.AcceptWebSocketRequest(ProcessWebsocketSession);
            }
    
            return Request.CreateResponse(HttpStatusCode.SwitchingProtocols);
        }
    
        private Task ProcessWebsocketSession(AspNetWebSocketContext context)
        {
            var handler = new MyWebSocketHandler();
            var processTask = handler.ProcessWebSocketRequestAsync(context);
            return processTask;
        }
    }
    

    这完全没问题。 OnMessage 被触发,并回显到我的 JavaScript 实例化 WebSocket...

    【讨论】:

    • 我觉得这个设计没什么不好。而隐藏公共界面的EditorBrowsable 属性简直是疯了。它为什么存在,人们只能想知道。
    • +1 - René,你会碰巧在某个地方有这种技术的 POC 吗?我想使用它,但我不确定如何初始化。我想你为你的 ApiController 指定了一个 RoutePrefix,对吗?
    • @lbotinelly,我建议你尝试一些谷歌搜索“ASP.NET 4.5/5 WebSockets”,你会发现一些像这样的有趣文章,其中有一个非常详细的视频,包括 WebSocketHandler 的使用:weblogs.asp.net/dwahlin/… :)
    • @ÞorvaldurRúnarsson 是的。不要忘记,如果您使用的是 HTTPS,它必须是 WSS://,而不是 WS://。试试吧,网上有很多例子;)
    • 此示例使用 Microsoft.Web.WebSockets,如果您查看 nuget 包 Microsoft.WebSockets(我知道它令人困惑),它不再被开发,他们建议使用 SignalR。这又回到了上面示例中如何使用 SignalR.WebSocketHandler 的原始问题。根据我的研究,这不容易做到。
    【解决方案3】:

    我找到了这个example:

    示例代码(转载自帖子):

    public class WSHandler : IHttpHandler
    {
        public void ProcessRequest(HttpContext context)
        {
            if (context.IsWebSocketRequest)
            {
                context.AcceptWebSocketRequest(ProcessWSChat);
            }
        }
    
        public bool IsReusable { get { return false; } }
    
        private async Task ProcessWSChat(AspNetWebSocketContext context)
        {
            WebSocket socket = context.WebSocket;
            while (true)
            {
                ArraySegment<byte> buffer = new ArraySegment<byte>(new byte[1024]);
                WebSocketReceiveResult result = await socket.ReceiveAsync(
                    buffer, CancellationToken.None);
                if (socket.State == WebSocketState.Open)
                {
                    string userMessage = Encoding.UTF8.GetString(
                        buffer.Array, 0, result.Count);
                    userMessage = "You sent: " + userMessage + " at " + 
                        DateTime.Now.ToLongTimeString();
                    buffer = new ArraySegment<byte>(
                        Encoding.UTF8.GetBytes(userMessage));
                    await socket.SendAsync(
                        buffer, WebSocketMessageType.Text, true, CancellationToken.None);
                }
                else
                {
                    break;
                }
            }
        }
    }
    

    【讨论】:

    • 我看到了,但它没有利用 Web API 接口?这与 WebAPI 兼容吗?
    • 您正在寻找哪些接口? Web API 建立在 ASP.Net 之上,这应该可以工作(尽管您可能需要稍微调整一下)。
    • 第二个例子不起作用,因为 AcceptWebSocketRequest 不再接受我上面提到的 WebSocketHandler。我在最初的问题中添加了一两个注释,以帮助澄清我的困惑。
    • 好吧,我的错。更新了我的答案以删除该部分。
    【解决方案4】:

    根据 Tony 的回答与更清晰的任务处理共享我的代码。此代码大约每秒发送一次当前 UTC 时间:

    public class WsTimeController : ApiController
    {
        [HttpGet]
        public HttpResponseMessage GetMessage()
        {
            var status = HttpStatusCode.BadRequest;
            var context = HttpContext.Current;
            if (context.IsWebSocketRequest)
            {
                context.AcceptWebSocketRequest(ProcessRequest);
                status = HttpStatusCode.SwitchingProtocols;
    
            }
    
            return new HttpResponseMessage(status);
        }
    
        private async Task ProcessRequest(AspNetWebSocketContext context)
        {
            var ws = context.WebSocket;
            await Task.WhenAll(WriteTask(ws), ReadTask(ws));
        }
    
        // MUST read if we want the socket state to be updated
        private async Task ReadTask(WebSocket ws)
        {
            var buffer = new ArraySegment<byte>(new byte[1024]);
            while (true)
            {
                await ws.ReceiveAsync(buffer, CancellationToken.None).ConfigureAwait(false);
                if (ws.State != WebSocketState.Open) break;
            }
        }
    
        private async Task WriteTask(WebSocket ws)
        {
            while (true)
            {
                var timeStr = DateTime.UtcNow.ToString("MMM dd yyyy HH:mm:ss.fff UTC", CultureInfo.InvariantCulture);
                var buffer = Encoding.UTF8.GetBytes(timeStr);
                if (ws.State != WebSocketState.Open) break;
                var sendTask = ws.SendAsync(new ArraySegment<byte>(buffer), WebSocketMessageType.Text, true, CancellationToken.None);
                await sendTask.ConfigureAwait(false);
                if (ws.State != WebSocketState.Open) break;
                await Task.Delay(1000).ConfigureAwait(false); // this is NOT ideal
            }
        }
    }
    

    【讨论】:

    • 我们如何修改WriteTask方法,让DB每次有新事务时都将更新的数据发送出去。
    • @Osama:有几种方法可以做到这一点。您可以生成一个可枚举的任务,每个任务都基于一个 TaskCompletionSource。当感兴趣的事件发生时,将 TaskCompletionSoruce 标记为完成。我在nuget.org/packages/TaskTimer 中使用了这种方法。或者,您可以使用 SemaphoreSlim.WaitAsync 方法来表示发生了什么事。另一种方法是使用 AsyncEx 包中的 github.com/StephenCleary/AsyncEx/wiki/AsyncAutoResetEvent。
    【解决方案5】:

    使用 SignalR 2 怎么样?

    • 可以通过 NuGet 安装
    • 适用于 .NET 4.5+
    • 不需要永久循环
    • 可以广播 -Tutorial here

    【讨论】:

    • 如果 SignalR2 支持可能工作的二进制 websocket。此外,v1 并不想将数据包序列化/反序列化为本地对象,这往往需要额外的带宽。我需要使我的传输尽可能紧凑(我正在流式传输实时音频数据),所以原始二进制 websockets 是最好的方法。
    • 还有对 jquery 的依赖,这是我不使用它的唯一原因。
    猜你喜欢
    • 2016-01-09
    • 2015-10-10
    • 2018-07-20
    • 1970-01-01
    • 1970-01-01
    • 2012-03-14
    • 2012-12-10
    • 1970-01-01
    • 1970-01-01
    相关资源
    最近更新 更多