クイック スタート:ASP.NET と SignalR Service を使ってチャット ルームを作成する

Azure SignalR Service は SignalR for ASP.NET Core 2.1 に基づいており、ASP.NET SignalR との互換性は 100% ではありません。 Azure SignalR Service では、最新の ASP.NET コア テクノロジに基づいて、SignalR データ プロトコル ASP.NET 再実装されました。 ASP.NET SignalR に Azure SignalR Service を使用する場合、一部の ASP.NET SignalR 機能はサポートされなくなりました。たとえば、クライアントが再接続したときに Azure SignalR がメッセージを再生しない場合などです。 また、Forever Frame トランスポートと JSONP はサポートされていません。 ASP.NET SignalR アプリケーションを SignalR Service と共に使用するには、いくらかのコード変更や適切なバージョンの依存ライブラリが必要になります。

ASP.NET SignalR と ASP.NET Core SignalR の機能の比較の完全なリストについては、バージョンの違いに関するドキュメントを参照してください。

このクイック スタートでは、同様 の Chat Room アプリケーションの ASP.NET と Azure SignalR Service の使用を開始する方法について説明します。

Azure サブスクリプションをお持ちでない場合は、開始する前に無料アカウントを作成してください。

前提条件

• Visual Studio 2019
• .NET Framework 4.6.1
• ASP.NET SignalR 2.4.1

問題がある場合は、 トラブルシューティング ガイドをお試しになるか、ご連絡ください。

Azure へのサインイン

Azure アカウントで Azure Portal にサインインします。

問題がある場合は、 トラブルシューティング ガイドをお試しになるか、ご連絡ください。

このセクションでは、アプリに使う基本的な Azure SignalR インスタンスを作成します。 次の手順では、Azure portal を使って新しいインスタンスを作成しますが、Azure CLI を使うこともできます。 詳細については、Azure SignalR Service CLI リファレンスの az signalr create コマンドを参照してください。

1. Azure portal にサインインします。
2. ページの左上にある [+ リソースの作成] を選択します。
3. [リソースの作成] ページで、[Search services and marketplace](サービスとマーケットプレースを検索) テキスト ボックスに「signalr」と入力し、リストから [SignalR Service] を選びます。
4. [SignalR Service] ページで [作成] を選びます。
5. [基本] タブで、新しい SignalR Service のインスタンスに必要な情報を入力します。 次の値を入力します。

SignalR チュートリアルでは、[ネットワーク] と [タグ] タブの設定を変更する必要はありません。

6. [基本] タブの下部にある [確認と作成] ボタンを選びます。
7. [確認と作成] タブで、値を確認し [作成] を選びます。 デプロイが完了するまでしばらくかかります。
8. デプロイが完了したら、[リソースに移動] ボタンを選びます。
9. SignalR リソース ページで、左側のメニューから、[設定] の下にある [キー] を選びます。
10. 主キーの [接続文字列] をコピーします。 この接続文字列は、このチュートリアルで後ほどアプリを構成するために必要です。

ASP.NET SignalR アプリケーションでは、サーバーレス モードはサポートされていません。 Azure SignalR Service インスタンスの場合、必ず Default または Classic を使用してください。

「SignalR Service の作成」にあるスクリプトを使用して、このクイック スタートで使用されている Azure リソースを作成することもできます。

問題がある場合は、 トラブルシューティング ガイドをお試しになるか、ご連絡ください。

サンプル アプリケーションの複製

サービスのデプロイ中、コードでの作業に切り替えましょう。 GitHub からサンプル アプリを複製し、SignalR Service 接続文字列を設定し、アプリケーションをローカルで実行します。

1. git ターミナル ウィンドウを開きます。 サンプル プロジェクトを複製するフォルダーに移動します。

2. 次のコマンドを実行して、サンプル レポジトリを複製します。 このコマンドは、コンピューター上にサンプル アプリのコピーを作成します。

   git clone https://github.com/aspnet/AzureSignalR-samples.git
   

問題がある場合は、 トラブルシューティング ガイドをお試しになるか、ご連絡ください。

チャット ルーム Web アプリの構成と実行

1. Visual Studio を起動し、複製したリポジトリの aspnet-samples/ChatRoom/ フォルダーにあるソリューションを開きます。

2. Azure portal を開いたブラウザーで、作成したインスタンスを探して選択します。

3. [Key](キー) を選択し、SignalR Service インスタンスの接続文字列を表示します。

4. プライマリ接続文字列を選択してコピーします。

5. web.config ファイルで接続文字列を設定します。

   <configuration>
   <connectionStrings>
       <add name="Azure:SignalR:ConnectionString" connectionString="<Replace By Your Connection String>"/>
   </connectionStrings>
   ...
   </configuration>
   

6. Startup.cs で、MapSignalR() を呼び出す代わりに MapAzureSignalR({YourApplicationName}) を呼び出して接続文字列に渡し、アプリケーション自身が SignalR をホストするのではなく、サービスに接続するようにします。 {YourApplicationName} を自分のアプリケーションの名前と置き換えます。 この名前は、このアプリケーションを他のアプリケーションから区別するための一意の名前です。 値として this.GetType().FullName を使用することができます。

   public void Configuration(IAppBuilder app)
   {
       // Any connection or hub wire up and configuration should go here
       app.MapAzureSignalR(this.GetType().FullName);
   }
   

   これらの API を使用する前にサービス SDK を参照する必要もあります。 [ツール]、[NuGet パッケージ マネージャー]、[パッケージ マネージャー コンソール] を開き、コマンドを実行します。

   Install-Package Microsoft.Azure.SignalR.AspNet
   

   これらの変更以外はすべてのそのままで、使い慣れたハブ インターフェイスを引き続き使用してビジネス ロジックを作成することができます。

   Note

   この実装では、エンドポイント /signalr/negotiate が Azure SignalR Service SDK によるネゴシエーションに対して公開されます。 クライアントが接続を試行すると特別なネゴシエーション応答が返され、クライアントは接続文字列で定義されたサービス エンドポイントにリダイレクトされます。

7. F5 を押し、プロジェクトをデバッグ モードで実行します。 アプリケーションがローカルで実行されます。 アプリケーションそのものが SignalR ランタイムをホストする代わりに、Azure SignalR Service に接続するようになります。

問題がある場合は、 トラブルシューティング ガイドをお試しになるか、ご連絡ください。

リソースをクリーンアップする

このアプリの使用を続けない場合は、次の手順に従って、このクイック スタートで作成したすべてのリソースを削除して、課金が発生しないようにします。

1. Azure Portal の左端で [リソース グループ] を選択し、作成したリソース グループを選択します。 検索ボックスを使用して名前でリソース グループを検索することもできます。

2. 表示されたウィンドウでリソース グループを選択し、[リソース グループの削除] をクリックします。

3. 新しいウィンドウで、削除するリソース グループの名前を入力し、[削除] をクリックします。

Azure portal にサインインし、 [リソース グループ] を選択します。

[名前でフィルター] ボックスにリソース グループの名前を入力します。 このクイックスタートの手順では、SignalRTestResources という名前のリソース グループを使用しました。 結果一覧でリソース グループの [...] をクリックし、 [リソース グループの削除] をクリックします。

しばらくすると、リソース グループとそこに含まれているすべてのリソースが削除されます。

問題がある場合は、 トラブルシューティング ガイドをお試しになるか、ご連絡ください。

次のステップ

このクイック スタートでは、新しい Azure SignalR Service リソースを作成して、ASP.NET Web アプリと共に使用しました。 次に、Azure SignalR Service を ASP.NET Core と共に使用して、リアルタイム アプリケーションを開発する方法について学びます。