web-dev-qa-db-ja.com

ASP.NET Web APIでWebSocketを使用する

ASP.NET Web APIアプリケーションで生のWebソケットを使用するための好ましい方法は何ですか？

ASP.NET Web APIアプリケーションのいくつかのインターフェイスでbinaryWebSocketを使用したいと思います。 .NETのオンラインでは、競合する、または時代遅れの実装がいくつかあるように思われるため、これをどのように行うべきかを判断するのは困難です。

このようなASP.NETのように見える例があります one 、しかし、私はthinkWeb APIフレームワーク内でwebsocketを使用する手段がなければなりません。私が知っているように、WebAPI内でSignalrを使用できます。

私thoughtMicrosoft.AspNet.SignalR.WebSockets.WebSocketHandlerを使用すると動作しますが、WebSocketHandlerをControllerにリンクする方法がわかりません...

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アプリケーションで最新の未加工のWebソケットを実装するリンクまたはクイックサンプルはありますか？

c#asp.net-mvc-4asp.net-web-apiwebsocketsignalr
20
Tony

PDATE：私と同僚によるもう少しの調査の後、WebSocketHandlerクラスはSignalRの内部プロセスの外部で使用されることを意図していないように見えるという結論に達しました。 SignalRから分離されたWebSocketHandlerを活用する明確な手段がないため。これは、System.Web/System.Netインターフェースよりも少し高いレベルのインターフェースであることがわかったため、残念です。さらに、以下で説明するメソッドは、Ibelieveを避ける必要があるHttpContextを使用します。

そのため、Mrchiefが示したアプローチに似たアプローチを採用する予定ですが、Web APIの風味が少しあります。このように...（注：ソケットは書き込み専用ですが、私はあなたを発見しました[〜＃〜] must [〜＃〜] 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の適切な使用法が残っています。

14
Tony

これは古い質問ですが、これに別の答えを追加したいと思います。
判明したことですが、あなたはそれを使用することができ、彼らがなぜそれを「隠し」にしたのかはわかりません。誰かがこのクラスの何が悪いのかを説明してくれたり、ここでやっていることが何らかの形で「禁じられている」か「悪いデザイン」だったりするといいでしょう。

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にエコーバックされます...

12
René Sackers

私はこれを見つけました 例 ：

サンプルコード（投稿から再現）：

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;
            }
        }
    }
}
4
Mrchief

よりクリーンなタスク処理でトニーの答えに基づいてコードを共有します。このコードは、ほぼ毎秒現在の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
        }
    }
}
2
Ivan Krivyakov

SignalR 2の使用はどうですか？

0
Anytoe