ASP.NET CoreのSignalRでバイナリーデータをやり取りする

ASP.NET CoreのSignalRのお話です (2018/7/5時点)

古いSignalRは知らない

SignalRがWebSocketを使えるなら使ってくれるのはご存知だとおもいます

んで、WebSocketのペイロードデータにはTextとBinaryのどちらかを入れることができます

データサイズに敏感な環境では極力小さいデータでやり取りしたいので、バイナリーでやり取りしてくれると助かるわけです

準備

とりあえず普通にSignalRでやり取りするサンプル作ります

Server

Visual StudioでASP.NET Core Webアプリケーション (2.1)を新規に作ってStartup.csに追記

public void ConfigureServices(IServiceCollection services)
{
    ...
    services.AddSignalR();
    ...
}

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    ...
    app.UseSignalR(options => options.MapHub<DataHub>("/hub/data"));
    ...
}

DataHubはこんな感じ

public class DataHub : Hub
{
    public void Upload(byte[] data)
    {
        System.Diagnostics.Debug.WriteLine($"Receive {data.Length}bytes.");
    }
}

Client

.NET Framework 4.7のコンソールアプリで作ります

class Program
{
    static async Task Main(string[] args)
    {
        var connection = new HubConnectionBuilder()
            .WithUrl("http://localhost:58456/hub/data")
            .Build();
        await connection.StartAsync();

        var testData = Enumerable.Range(0, 1024).Select(i => (byte)i).ToArray();
        await connection.InvokeAsync("Upload", testData);

        await connection.DisposeAsync();
    }
}

クライアントは1024byteのbyte[]を送るようにしてあります

試す

両方実行して送信データを見てみます

WebSocketのデータフレーム(?)が1になってテキストとして送っていることがわかります

この時のパケットサイズは1481byte

Binaryで送る

Server

Install-Package Microsoft.AspNetCore.SignalR.Protocols.MessagePack

services.AddSignalR()
    .AddMessagePackProtocol();  // 追加

Client

Install-Package Microsoft.AspNetCore.SignalR.Protocols.MessagePack

var connection = new HubConnectionBuilder()
    .WithUrl("http://localhost:58456/hub/data")
    .AddMessagePackProtocol()  // 追加
    .Build();

準備完了

MessagePack使うだけです、楽スギ！

試す

実行して送信データを見てみます

WebSocketのデータフレーム(?)が2になってバイナリで送ってるっぽいです

データサイズも1090byteまで減りました

まとめ

サーバーもクライアントも1行(?)追加するだけでできちゃったし、フレームワーク作る人ってすごいんだなーと改めて実感しました

今回のソースはこちら

github.com