こんにちは、Habr！ 9月14日に、ASP.Net CoreのSignalRの最初のバージョンが発表されました。これに関連して、このイベントに関するメモを翻訳し、もう少し追加することにしました。元のメモは、 MSDNブログで入手できます。

新機能

SignalR for ASP.Net Coreは、元のSignalRをゼロから書き直したバージョンです。新しいSignalRは、よりシンプルで、信頼性が高く、使いやすいです。これらの内部的な変更にもかかわらず、ライブラリAPIを以前のバージョンに最も近づけようとしました。

JavaScript / TypeScriptクライアント

SignalR for ASP.Net Coreには、まったく新しいJavaScriptクライアントがあります。 TypeScriptを使用して記述されており、jQueryに依存しなくなりました。クライアントは、いくつかの追加の依存関係を持つNode.jsからも使用できます。

クライアントは、クライアントのNode.jsバージョン（requireを介して接続）、および<script>

を使用して埋め込むことができるブラウザーのバージョンを含むnpmモジュールとして配布されます。モジュールに組み込まれたTypeScriptヘッダーファイルにより、TypeScriptアプリケーションからクライアントを簡単に使用できます。

クライアントは、バージョン9以降のChrome、FireFox、Edge、Safari、Opera、およびInternet Explorerの最新バージョンをサポートしています（ただし、すべてのトランスポートプロトコルが各ブラウザーと互換性があるわけではありません）。

バイナリプロトコルのサポート

SignalR for ASP.Net Coreは、JSONベースのテキストとMessagePackベースのバイナリという2つの組み込みプロトコルを提供します。通常、MessagePackプロトコルを使用するメッセージは、JSONの同じメッセージよりも小さくなります。たとえば、1の整数値を含むハブメッセージは、JSONを使用すると43バイトを消費し、MessagePackでは16バイトのみを消費します。（サイズの違いは、メッセージの種類、そのコンテンツ、および使用されるトランスポートプロトコルによって異なる場合があります。SSEはテキストトランスポートであるため、Server-Sent Events（SSE）を介して送信されるバイナリメッセージはbase64でエンコードされます）。

ユーザープロトコルのサポート

SignalRハブプロトコルはGitHubに記載されており、カスタム実装を接続できる拡張ポイントが含まれています。

ストリーミング

サーバーからクライアントにデータストリームを転送できるようになりました。通常のハブメソッド呼び出しとは異なり、ストリーミングとは、呼び出しが終了する前にサーバーがクライアントに結果を送信できることを意味します。

クリーンなWebソケットでSignalRを使用する

SignalRへの接続プロセスは、Webソケットを使用する場合、クライアントを使用せずに単一の要求でサーバーに接続できるようになるまで簡略化されました。

簡略化された水平スケーリング

残念ながら、アプリケーションの水平スケーリングには「特効薬」はありません。各アプリケーションには、スケーリング時に考慮しなければならない独自の要件があります。このアルファ版では、水平スケーリングを簡素化し、水平スケーリング用のRedisベースのコンポーネントを提供するためにいくつかの作業を行っています。サービスバスなどの他のプロバイダーのサポートは、最終リリースでテストされています。

何が変わった？

ASP.Net CoreのSignalRに多くの新機能を追加しましたが、同時に既存の機能のサポートを削除するか、その動作を変更することを決定しました。その結果、SignalRの新しいバージョンは以前の機能と互換性がありません。つまり、古いクライアントを新しいクライアントで使用したり、古いクライアントを新しいサーバーで使用したりすることはできません。以下は、新しいバージョンで除外された機能または動作が変更された機能です。

簡略化された接続モデル

SignalRの既存のバージョンでは、接続に失敗した場合、クライアントは別のトランスポートを使用して接続を試みます。クライアントは、利用可能なトランスポートのいずれかを使用してサーバーに接続できない場合、接続を確立しません。 SignalRの新しいバージョンでは、この機能はサポートされなくなりました。

また、自動再接続は使用できなくなりました。以前のバージョンでは、SignalRはサーバーとの接続を失ったときに再接続しようとしました。クライアントが切断された場合、ユーザーは明示的に新しい接続を確立する必要があります。これは以前に必要であったことに注意してください-特定のタイムアウト内に復元できない場合、クライアントは自動的に再接続しようとしなくなりました。この機能を削除するもう1つの理由は、クライアントに送信されたメッセージを保存するコストが高いことです。デフォルトでは、サーバーは最後の1000件のメッセージを保存したため、接続が失われたクライアントにメッセージを再送信できました。各接続には独自のバッファがあるため、これらのメッセージを保存するとメモリが大量に消費されます。

スティッキーセッションのバインド

SignalRの以前のバージョンの水平スケーリングアプローチを使用して、クライアントはファーム内の任意のサーバーに再接続またはメッセージを送信できました。このアプローチの変更と自動再接続の拒否により、クライアントは接続が確立されたサーバーとのみメッセージを交換する必要があります。

接続用の1つのハブ

SignalRの新しいバージョンは、単一の接続内での複数のハブの使用をサポートしていません。これにより、クライアントAPIが簡素化され、追加の認証ポリシーやその他のミドルウェアのハブ接続への適用が簡素化されました。また、接続を開始する前に、ハブのメソッドへのサブスクリプションは不要になりました。

その他の変更

クライアントとハブ間で任意のステータスを転送する機能（HubState）、およびステータスメッセージ（進捗メッセージ）のサポートが削除されました。また、ハブプロキシの代替はこのバージョンでは追加されませんでした。

はじめに

SignalRのインストールは比較的簡単です。新しいASP.Net Coreアプリケーションを作成したら、例に示すように、Microsoft.AspNetCore.SignalR nugetパッケージへの依存関係を追加する必要があります

 <Project Sdk="Microsoft.NET.Sdk.Web"> <PropertyGroup> <TargetFramework>netcoreapp2.0</TargetFramework> </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.AspNetCore.All" Version="2.0.0" /> <PackageReference Include="Microsoft.AspNetCore.SignalR" Version="1.0.0-alpha1-final" /> </ItemGroup> <ItemGroup> <Folder Include="wwwroot\scripts\" /> </ItemGroup> </Project>

そしてあなたのハブクラス

 using System; using System.Threading.Tasks; using Microsoft.AspNetCore.SignalR; namespace Sample { public class Chat : Hub { public Task Send(string message) { return Clients.All.InvokeAsync("Send", message); } } }

このハブには、呼び出されたときに、各クライアントでSendメソッドを呼び出すメソッドが含まれています。

ハブクラスを追加したら、送信された要求を次のように処理するようにサーバーを構成する必要があります。

 using Microsoft.AspNetCore.Builder; using Microsoft.Extensions.DependencyInjection; namespace Sample { public class Startup { public void ConfigureServices(IServiceCollection services) { services.AddSignalR(); } public void Configure(IApplicationBuilder app) { app.UseSignalR(routes => { routes.MapHub<Chat>("chat"); }); } } }

必要な設定を設定した後、クライアントからハブメソッドを呼び出したり、クライアントからハブメソッドを呼び出したりできます。ブラウザでJavaScriptクライアントを使用するには、SignalRクライアントを含むnpmパッケージを次のコマンドでインストールする必要があります

npm install @aspnet/signalr-client

これで、signalr-client.jsをプロジェクトのスクリプトフォルダーにコピーし、ページで接続できます。

 <script src="scripts/signalr-client.min.js"></script>

スクリプトを接続すると、サーバーへの接続を開始し、サーバーとコマンドを交換できます

 let connection = new signalR.HubConnection('/chat'); connection.on('send', data => { console.log(data); }); connection.start() .then(() => connection.invoke('send', 'Hello'));

管理対象クライアントを使用するには、パッケージMicrosoft.AspNetCore.SignalR.Clientへのリンクを追加する必要があります

 <Project Sdk="Microsoft.NET.Sdk"> <PropertyGroup> <OutputType>Exe</OutputType> <TargetFramework>netcoreapp2.0</TargetFramework> </PropertyGroup> <ItemGroup> <PackageReference Include="Microsoft.AspNetCore.SignalR.Client" Version="1.0.0-alpha1-final" /> </ItemGroup> </Project>

その後、ハブのメソッドにアクセスし、クライアントメソッドへの呼び出しを処理できるようになります。

ストリーミングを利用する場合は、 ReadableChannel<T>

またはIObservable<T>

を返すハブメソッドを作成する必要があります。以下は、株価をストリームで転送するStockTimerの例のハブメソッドです。

 public IObservable<Stock> StreamStocks() { return _stockTicker.StreamStocks(); }

このメソッドによって呼び出されるJavaScriptコードは次のようになります

 function startStreaming() { connection.stream("StreamStocks").subscribe({ next: displayStocks, error: function (err) { logger.log(err); } }); }

サーバーがストリームアイテムを送信するたびに、クライアントのdisplayStocksメソッドが呼び出されます

C＃コードからハブメソッドを呼び出す方法を以下に示します。

 private async Task StartStreaming() { var channel = connection.Stream<Stock>("StreamStocks", CancellationToken.None); while (await channel.WaitToReadAsync()) { while (channel.TryRead(out var stock)) { Console.WriteLine($"{stock.Symbol} {stock.Price}"); } } }

SignalRの既存のバージョンからのアップグレード

今後数週間で、SignalRの以前のバージョンからの移行ドキュメントがリリースされます。

既知の問題

サーバーがIISを介して起動された場合、非アクティブな状態が2分間続くと、SSEトランスポートを介した接続が失われる場合があります
IISがWindows 7またはWindows Server 2008 R2で使用されている場合、Webソケットは機能しません
C＃のクライアントでSSEを使用すると、サーバーからデータを受信している間にクライアントが閉じられた場合、クライアントがフリーズすることがあります
クライアントはストリーム呼び出しをキャンセルできません
UglifyJSはES6標準をサポートしていないため、angular-cliを使用して製品バージョンを構築することはできません。この問題の回避策は、このコメントに記載されています。

翻訳の著者から

私からは、AngularのSPAアプリケーションでTypeScriptバージョンのクライアントを使用する小さな例を追加します。上記の「はじめに」セクションのすべての手順を完了したら、AngularコンポーネントでHubConnection

クラスをインポートし、そのメソッドを使用するだけで十分です。 fetchdata.component.ts

を使用して作成されたアプリケーションの基本的な例では、次のように、 counter

コンポーネントからfetchdata.component.ts

コンポーネントへのクリック数を表示する機能を追加しました

 import { Component, Inject } from '@angular/core'; import { Http } from '@angular/http'; import { HubConnection } from "@aspnet/signalr-client"; @Component({ selector: 'fetchdata', templateUrl: './fetchdata.component.html' }) export class FetchDataComponent { public forecasts: WeatherForecast[]; public count: number; private notificationHub: HubConnection; constructor(http: Http, @Inject('BASE_URL') baseUrl: string) { http.get(baseUrl + 'api/SampleData/WeatherForecasts').subscribe(result => { this.forecasts = result.json() as WeatherForecast[]; }, error => console.error(error)); this.notificationHub = new HubConnection("/notifications"); this.notificationHub.on("send", (data) => { this.count = data; }); this.notificationHub.start(); } }

コンストラクター呼び出しで指定されたハブアドレスは、ASP.Net CoreアプリケーションのStartupクラスで指定されたものと一致する必要があります（変換の例では、このアドレスは "chat"です）。ハブのSendメソッドは、次のようにcounter

コンポーネントから呼び出されます

 this.notificationHub.invoke("send", this.currentCount);

PSこれは私の最初の投稿であり、同時に翻訳でもあります。このため、私はPMに送るためにその品質に関するコメントを求めます。

SignalR for ASP.Net Core 2.0の最初のバージョンがリリースされました

新機能