クイック スタート: Azure SignalR Service と Azure Functions、および JavaScript を使用してサーバーレス アプリを作成する

この記事では、Azure SignalR Service、Azure Functions、JavaScript を使用して、クライアントにメッセージをブロードキャストするサーバーレス アプリケーションを構築します。

前提条件

このクイック スタートは、macOS、Windows、または Linux で実行できます。

Azure SignalR Service のインスタンスを作成する

このセクションでは、アプリに使う基本的な 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. 主キーの [接続文字列] をコピーします。 この接続文字列は、このチュートリアルで後ほどアプリを構成するために必要です。

関数プロジェクトのセットアップ

Azure Functions Core Tools がインストールされていることを確認します。

1. コマンド ラインを開きます。
2. プロジェクト ディレクトリを作成し、そのディレクトリに移動します。
3. Azure Function の func init コマンドを実行して、新しいプロジェクトを初期化します。

func init --worker-runtime javascript --language javascript --model V4

プロジェクト関数を作成する

プロジェクトを初期化した後、関数を作成する必要があります。 このプロジェクトには、次の 3 つの関数が必要です。

• index: クライアントの Web ページをホストします。
• negotiate: クライアントがアクセス トークンを取得できるようにします。
• broadcast: タイム トリガーを使用して、すべてのクライアントにメッセージを定期的にブロードキャストします。

プロジェクトのルート ディレクトリから func new コマンドを実行すると、Azure Function の Core Tools によって関数ソース ファイルが作成されて、関数名を持つフォルダーに格納されます。 必要に応じてファイルを編集し、既定のコードをアプリ コードに置き換えます。

インデックス関数を作成する

1. 次のコマンドを実行して index 関数を作成します。

   func new -n index -t HttpTrigger
   

2. src/functions/httpTrigger.js を編集し、内容を次の json コードに置き換えます。

   const { app } = require('@azure/functions');
   const fs = require('fs').promises;
   const path = require('path');
   
   app.http('index', {
       methods: ['GET', 'POST'],
       authLevel: 'anonymous',
       handler: async (request, context) => {
   
           try {
   
               context.log(`Http function processed request for url "${request.url}"`);
   
               const filePath = path.join(__dirname,'../content/index.html');
               const html = await fs.readFile(filePath);
   
               return {
                   body: html,
                   headers: {
                       'Content-Type': 'text/html'
                   }
               };
   
           } catch (error) {
               context.log(error);
               return {
                   status: 500,
                   jsonBody: error
               }
           }
       }
   });
   

ネゴシエート関数を作成する

1. 次のコマンドを実行して negotiate 関数を作成します。

   func new -n negotiate -t HttpTrigger
   

2. src/functions/negotiate.js を編集し、内容を次の json コードに置き換えます。

   const { app, input } = require('@azure/functions');
   
   const inputSignalR = input.generic({
       type: 'signalRConnectionInfo',
       name: 'connectionInfo',
       hubName: 'serverless',
       connectionStringSetting: 'SIGNALR_CONNECTION_STRING',
   });
   
   app.post('negotiate', {
       authLevel: 'anonymous',
       handler: (request, context) => {
           try {
               return { body: JSON.stringify(context.extraInputs.get(inputSignalR)) }
           } catch (error) {
               context.log(error);
               return {
                   status: 500,
                   jsonBody: error
               }
           }
       },
       route: 'negotiate',
       extraInputs: [inputSignalR],
   });
   

ブロードキャスト関数を作成します。

1. 次のコマンドを実行して broadcast 関数を作成します。

   func new -n broadcast -t TimerTrigger
   

2. src/functions/broadcast.js を編集し、内容を次のコードに置き換えます。

   const { app, output } = require('@azure/functions');
   const getStars = require('../getStars');
   
   var etag = '';
   var star = 0;
   
   const goingOutToSignalR = output.generic({
       type: 'signalR',
       name: 'signalR',
       hubName: 'serverless',
       connectionStringSetting: 'SIGNALR_CONNECTION_STRING',
   });
   
   app.timer('sendMessasge', {
       schedule: '0 * * * * *',
       extraOutputs: [goingOutToSignalR],
       handler: async (myTimer, context) => {
   
           try {
               const response = await getStars(etag);
   
               if(response.etag === etag){
                   console.log(`Same etag: ${response.etag}, no need to broadcast message`);
                   return;
               }
           
               etag = response.etag;
               const message = `${response.stars}`;
   
               context.extraOutputs.set(goingOutToSignalR,
                   {
                       'target': 'newMessage',
                       'arguments': [message]
                   });
           } catch (error) {
               context.log(error);
           }
   
       }
   });
   

index.html ファイルを作成する

このアプリのクライアント インターフェイスは Web ページです。 index 関数は content/index.html ファイルから HTML コンテンツを読み取ります。

1. content という名前のフォルダーをプロジェクト ルート フォルダーに作成します。

2. content/index.html ファイルを作成します。

3. 次のコンテンツを content/index.html ファイルにコピーして保存します。

   <html>
   
   <body>
     <h1>Azure SignalR Serverless Sample</h1>
     <div>Instructions: Goto <a href="https://github.com/Azure/azure-signalr">GitHub repo</a> and star the repository.</div>
     <hr>
     <div>Star count: <div id="messages"></div></div>
     <script src="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/8.0.0/signalr.min.js"></script>
     <script>
       let messages = document.querySelector('#messages');
       const apiBaseUrl = window.location.origin;
       console.log(`apiBaseUrl: ${apiBaseUrl}`);
       const connection = new signalR.HubConnectionBuilder()
           .withUrl(apiBaseUrl + '/api')
           .configureLogging(signalR.LogLevel.Information)
           .build();
         connection.on('newMessage', (message) => {
           console.log(`message: ${message}`);
           document.getElementById("messages").innerHTML = message;
         });
   
         connection.start()
           .catch(console.error);
     </script>
   </body>
   
   </html>
   

Azure Storage を設定する

Azure Functions が機能するには、ストレージ アカウントが必要になります。 次の 2 つのオプションのいずれかを選択します。

• 無料の Azure Storage エミュレータを実行する。
• Azure Storage サービスを使用する。 使い続けるとコストが発生する可能性があります。

func settings add AzureWebJobsStorage "<storage-connection-string>"

SignalR Service 接続文字列を関数アプリの設定に追加する

あともう少しで終了です。 最後の手順では、 Azure Function アプリ設定に SignalR Service 接続文字列を設定します。

1. Azure portal で、先ほどデプロイした SignalR インスタンスに移動します。

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

   

3. プライマリ接続文字列をコピーし、コマンドを実行します。

   func settings add AzureSignalRConnectionString "<signalr-connection-string>"
   

Azure Function アプリをローカルで実行します

Azure Function アプリをローカル環境で実行します。

func start

Azure Function がローカルで実行された後、http://localhost:7071/api/index に移動します。 ページには、GitHub Azure/azure-signalr リポジトリの現在の星数が表示されます。 GitHub でリポジトリに星を付けたり外したりすると、数秒ごとに更新された数が表示されます。

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

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

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

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

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

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

サンプル コード

この記事で使用されているコードはすべて、GitHub リポジトリで入手できます。

• aspnet/AzureSignalR-samples。

次のステップ

このクイックスタートでは、localhost でリアルタイムのサーバーレス アプリケーションを構築して実行しました。 次に、SignalR Service を使用して、クライアントと Azure Functions の間で双方向通信を行う方法について詳しく説明します。