クイック スタート: Java を使用して Azure Functions と SignalR Service で GitHub の星の数を表示するアプリを作成する

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

前提条件

• コード エディター (Visual Studio Code など)。

• アクティブなサブスクリプションが含まれる Azure アカウント。 アカウントをまだ持っていない場合は、無料でアカウントを作成します。

• Azure Functions Core Tools。 Azure 関数アプリをローカルに実行する際に使用します。

  • Java では、必須の SignalR Service バインディングが Azure Function Core Tools バージョン 2.4.419 (ホスト バージョン 2.0.12332) 以降でのみサポートされます。
  • Azure Functions Core Tools では、拡張機能をインストールするために、.NET Core SDK がインストールされている必要があります。 ただし、Java Azure Functions アプリのビルドには、.NET の知識は必要ありません。

• Java Developer Kit、バージョン 11

• Apache Maven バージョン 3.0 以降。

このクイック スタートは、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 Function アプリを構成して実行する

Azure Function Core Tools、Java (サンプルではバージョン 11)、Maven がインストールされていることを確認します。

1. Maven を使用してプロジェクトを初期化します。

   mvn archetype:generate -DarchetypeGroupId=com.microsoft.azure -DarchetypeArtifactId=azure-functions-archetype -DjavaVersion=11
   

   Maven により、プロジェクトの生成を終了するために必要な値が要求されます。 次の値を指定します。

   Prompt	値	説明
   groupId	com.signalr	Java のパッケージ命名規則に従って、すべてのプロジェクトにわたって対象のプロジェクトを一意に識別する値。
   artifactId	java	バージョン番号のない、jar の名前である値。
   version	1.0-SNAPSHOT	既定値を選択します。
   package	com.signalr	生成された関数コードの Java パッケージである値。 既定値を使用します。

2. フォルダー src/main/java/com/signalr に移動し、次のコードを Function.java にコピーします。

   package com.signalr;
   
   import com.google.gson.Gson;
   import com.microsoft.azure.functions.ExecutionContext;
   import com.microsoft.azure.functions.HttpMethod;
   import com.microsoft.azure.functions.HttpRequestMessage;
   import com.microsoft.azure.functions.HttpResponseMessage;
   import com.microsoft.azure.functions.HttpStatus;
   import com.microsoft.azure.functions.annotation.AuthorizationLevel;
   import com.microsoft.azure.functions.annotation.FunctionName;
   import com.microsoft.azure.functions.annotation.HttpTrigger;
   import com.microsoft.azure.functions.annotation.TimerTrigger;
   import com.microsoft.azure.functions.signalr.*;
   import com.microsoft.azure.functions.signalr.annotation.*;
   
   import org.apache.commons.io.IOUtils;
   
   
   import java.io.IOException;
   import java.io.InputStream;
   import java.net.URI;
   import java.net.http.HttpClient;
   import java.net.http.HttpRequest;
   import java.net.http.HttpResponse;
   import java.net.http.HttpResponse.BodyHandlers;
   import java.nio.charset.StandardCharsets;
   import java.util.Optional;
   
   public class Function {
       private static String Etag = "";
       private static String StarCount;
   
       @FunctionName("index")
       public HttpResponseMessage run(
               @HttpTrigger(
                   name = "req",
                   methods = {HttpMethod.GET},
                   authLevel = AuthorizationLevel.ANONYMOUS)HttpRequestMessage<Optional<String>> request,
               final ExecutionContext context) throws IOException {
   
           InputStream inputStream = getClass().getClassLoader().getResourceAsStream("content/index.html");
           String text = IOUtils.toString(inputStream, StandardCharsets.UTF_8.name());
           return request.createResponseBuilder(HttpStatus.OK).header("Content-Type", "text/html").body(text).build();
       }
   
       @FunctionName("negotiate")
       public SignalRConnectionInfo negotiate(
               @HttpTrigger(
                   name = "req",
                   methods = { HttpMethod.POST },
                   authLevel = AuthorizationLevel.ANONYMOUS) HttpRequestMessage<Optional<String>> req,
               @SignalRConnectionInfoInput(
                   name = "connectionInfo",
                   hubName = "serverless") SignalRConnectionInfo connectionInfo) {
   
           return connectionInfo;
       }
   
       @FunctionName("broadcast")
       @SignalROutput(name = "$return", hubName = "serverless")
       public SignalRMessage broadcast(
           @TimerTrigger(name = "timeTrigger", schedule = "*/5 * * * * *") String timerInfo) throws IOException, InterruptedException {
           HttpClient client = HttpClient.newHttpClient();
           HttpRequest req = HttpRequest.newBuilder().uri(URI.create("https://api.github.com/repos/azure/azure-signalr")).header("User-Agent", "serverless").header("If-None-Match", Etag).build();
           HttpResponse<String> res = client.send(req, BodyHandlers.ofString());
           if (res.headers().firstValue("Etag").isPresent())
           {
               Etag = res.headers().firstValue("Etag").get();
           }
           if (res.statusCode() == 200)
           {
               Gson gson = new Gson();
               GitResult result = gson.fromJson(res.body(), GitResult.class);
               StarCount = result.stargazers_count;
           }
   
           return new SignalRMessage("newMessage", "Current start count of https://github.com/Azure/azure-signalr is:".concat(StarCount));
       }
   
       class GitResult {
           public String stargazers_count;
       }
   }
   

3. 依存関係をいくつか追加する必要があります。 pom.xml を開き、コードで使用される次の依存関係を追加します。

   <dependency>
       <groupId>com.microsoft.azure.functions</groupId>
       <artifactId>azure-functions-java-library-signalr</artifactId>
       <version>1.0.0</version>
   </dependency>
   <dependency>
       <groupId>commons-io</groupId>
       <artifactId>commons-io</artifactId>
       <version>2.4</version>
   </dependency>
   <dependency>
       <groupId>com.google.code.gson</groupId>
       <artifactId>gson</artifactId>
       <version>2.8.7</version>
   </dependency>
   

4. このサンプルのクライアント インターフェイスは Web ページです。 index 関数内の content/index.html から HTML コンテンツを読み取り、resources ディレクトリに新しいファイル content/index.html を作成します。 ディレクトリ ツリーは次のようになります。

       | - src
       | | - main
       | | | - java
       | | | | - com
       | | | | | - signalr
       | | | | | | - Function.java
       | | | - resources
       | | | | - content
       | | | | | - index.html
       | - pom.xml
       | - host.json
       | - local.settings.json
   

5. index.html を開き、次の内容をコピーします。

   <html>
   
   <body>
       <h1>Azure SignalR Serverless Sample</h1>
       <div id="messages"></div>
       <script src="https://cdnjs.cloudflare.com/ajax/libs/microsoft-signalr/3.1.7/signalr.min.js"></script>
       <script>
       let messages = document.querySelector('#messages');
       const apiBaseUrl = window.location.origin;
       const connection = new signalR.HubConnectionBuilder()
           .withUrl(apiBaseUrl + '/api')
           .configureLogging(signalR.LogLevel.Information)
           .build();
           connection.on('newMessage', (message) => {
           document.getElementById("messages").innerHTML = message;
           });
   
           connection.start()
           .catch(console.error);
       </script>
   </body>
   
   </html>
   

6. Azure Functions が機能するには、ストレージ アカウントが必要になります。 Azure ストレージ エミュレーターをインストールして実行できます。

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

   1. Azure portal の [検索] ボックスを使用して、前にデプロイした Azure SignalR インスタンスを検索します。 インスタンスを選択して開きます。

      

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

      

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

      func settings add AzureSignalRConnectionString "<signalr-connection-string>"
      # Also we need to set AzureWebJobsStorage as Azure Function's requirement
      func settings add AzureWebJobsStorage "UseDevelopmentStorage=true"
      

8. Azure Functions をローカルで実行します:

   mvn clean package
   mvn azure-functions:run
   

   Azure Functions がローカルで実行された後、http://localhost:7071/api/index に移動すると、現在の星の数が表示されます。 GitHub で星を付けたり "外したり" すると、数秒ごとに星の数が更新されます。

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

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

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

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

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

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

次のステップ

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