チュートリアル:Azure App Service on Linux と Azure Cosmos DB を使用して Java Spring Boot Web アプリを構築する

• アクティブなサブスクリプションが含まれる Azure アカウント。 Azure アカウントがない場合は、無料で作成できます。
• GitHub アカウント。 1 つ無料で取得することもできます。
• Spring Framework 開発に関する Java の知識。
• (オプション) GitHub Copilot を試す場合は、GitHub Copilot アカウント。 30 日間の無料試用版が提供されています。

• アクティブなサブスクリプションが含まれる Azure アカウント。 Azure アカウントがない場合は、無料で作成できます。
• Azure Developer CLI がインストールされていること。 Azure Developer CLI が既にインストールされているため、Azure Cloud Shell の手順に従うことができます。
• Spring Framework 開発に関する Java の知識。
• (オプション) GitHub Copilot を試す場合は、GitHub Copilot アカウント。 30 日間の無料試用版が提供されています。

2.App Service と Cosmos DB を作成する

まず、Azure リソースを作成します。 このチュートリアルで使用する手順では、App Service と Azure Cosmos DB を含む、既定でセキュリティ保護されたリソースのセットを作成します。 作成プロセスでは、次のように指定します。

• 名前: Web アプリの名前。 これは、アプリの DNS 名の一部として https://<app-name>-<hash>.<region>.azurewebsites.net の形式で使用されます。
• 世界でアプリを物理的に実行するためのリージョン。 これは、アプリの DNS 名の一部としても使用されます。
• アプリのランタイム スタック。 ここで、アプリに使う Java のバージョンを選びます。
• アプリのホスティング プラン。 これは、アプリの一連の機能と容量のスケーリングを含む価格レベルです。
• アプリのリソース グループ。 リソース グループを使うと、アプリケーションに必要なすべての Azure リソースを (論理コンテナーに) グループ化できます。

Azure portal にサインインし、以下の手順に従って Azure App Service リソースを作成します。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

3.セキュリティで保護された接続のシークレット

作成ウィザードにより、接続文字列がアプリ設定として既に自動的に生成されています。 ただし、セキュリティのベスト プラクティスは、App Service からシークレットを完全に排除することです。 シークレットをキー コンテナーに移動し、サービス コネクタのヘルプを使用してアプリ設定を Key Vault 参照に変更します。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

4.サンプル コードをデプロイする

この手順では、GitHub Actions を使用して GitHub のデプロイを構成します。 これは、App Service にデプロイする多くの方法の 1 つにすぎませんが、デプロイ プロセスで継続的インテグレーションを実現する優れた方法でもあります。 既定では、GitHub リポジトリに git push があるたびにビルドとデプロイのアクションが起動されます。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

5.アプリの参照

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

6.診断ログをストリーミングする

Azure App Service では、アプリケーションに関する問題の診断に役立つように、コンソールに出力されたすべてのメッセージが収集されます。 次のスニペットに示すように、このサンプル アプリケーションには、この機能を示す標準の Log4j ログ記録ステートメントが含まれています。

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

Java アプリのログ記録の詳細については、シリーズの「.NET、Node.js、Python、Java アプリケーション用の Azure Monitor OpenTelemetry を有効にする」を参照してください。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

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

完了したら、リソース グループを削除することで、Azure サブスクリプションからすべてのリソースを削除できます。

2.Azure リソースを作成してサンプル アプリをデプロイする

このステップでは、Azure リソースを作成し、サンプル アプリを App Service on Linux にデプロイします。 このチュートリアルで使用する手順では、App Service と Azure Cosmos DB を含む、既定でセキュリティ保護されたリソースのセットを作成します。

開発コンテナーには、既に Azure Developer CLI (AZD) が含まれています。

1. リポジトリのルートから、azd init を実行します。

   azd init --template javase-app-service-cosmos-redis-infra
   

2. メッセージが表示されたら、次の回答を入力します。

   Question	Answer
   The current directory is not empty. (現在のディレクトリが空ではありません。) Would you like to initialize a project here in '<your-directory>'? ('<ディレクトリ>' でプロジェクトを初期化しますか?)	Y
   What would you like to do with these files? (これらのファイルをどうしますか?)	Keep my existing files unchanged (既存のファイルを変更しないでそのままにする)
   Enter a new environment name (新しい環境の名前を入力してください)	一意の名前を入力します。 AZD テンプレートでは、この名前を Azure での Web アプリの DNS 名の一部として使用します (<app-name>-<hash>.azurewebsites.net)。 英数字とハイフンを使用できます。

3. azd auth login コマンドを実行し、プロンプトに従って Azure にサインインします。

   azd auth login
   

4. 必要な Azure リソースを作成し、azd up コマンドを使用してアプリ コードをデプロイします。 プロンプトに従って、Azure リソースの目的のサブスクリプションと場所を選択します。

   azd up
   

   azd up コマンドが完了するまで約 15 分かかります (大部分の時間は Redis キャッシュに費やされます)。 また、アプリケーション コードのコンパイルとデプロイも行われますが、後でコードを変更して App Service で動作するようにします。 実行中、このコマンドは、Azure のデプロイへのリンクを含む、プロビジョニングとデプロイのプロセスに関するメッセージを提供します。 完了すると、コマンドはデプロイ アプリケーションへのリンクも表示します。

   この AZD テンプレートには、次の Azure リソースを使用して既定でセキュリティ保護されたアーキテクチャを生成するファイル (azure.yaml と infra ディレクトリ) が含まれています。

   • [リソース グループ]: 作成されたすべてのリソースのコンテナー。
   • [App Service プラン]: App Service のコンピューティング リソースを定義します。 B1 レベルの Linux プランが作成されます。
   • [App Service]: アプリを表し、App Service プランで実行されます。
   • [仮想ネットワーク]: App Service アプリと統合され、バックエンド ネットワーク トラフィックを分離します。
   • MongoDB API を使用した Azure Cosmos DB アカウント: プライベート エンドポイントの背後からのみアクセスできます。 サーバー上にデータベースが自動的に作成されます。
   • [Azure Cache for Redis]: 仮想ネットワーク内からのみアクセスできます。
   • キー コンテナー: プライベート エンドポイントの背後からのみアクセスできます。 App Service アプリのシークレットを管理するために使用されます。
   • プライベート エンドポイント: 仮想ネットワーク内のキー コンテナー、データベース サーバー、Redis キャッシュのアクセス エンドポイント。
   • プライベート DNS ゾーン: 仮想ネットワーク内の Cosmos DB データベース、Redis Cache、キー コンテナーの DNS 解決を有効にします。
   • [Log Analytics ワークスペース]: アプリでログを配布するためのターゲット コンテナーとして機能します。ここでは、ログにクエリを実行することもできます。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

3.接続文字列を確認する

使用している AZD テンプレートにより、接続変数がアプリ設定として既に自動的に生成されており、それらが便宜のためにターミナルに出力されます。 アプリの設定は、接続のシークレットをコード リポジトリに残さないための 1 つの方法です。

1. AZD の出力で、アプリ設定 spring.data.mongodb.uri を見つけます。 設定名のみが表示されます。 これらは、AZD の出力では次のようになります。

    App Service app has the following app settings:
            - spring.data.mongodb.uri
            - spring.data.mongodb.database
            - spring.redis.host
            - spring.redis.port
            - spring.redis.password
            - spring.redis.database
            - spring.redis.ssl
            - spring.cloud.azure.keyvault.secret.credential.managed_identity_enabled
            - spring.cloud.azure.keyvault.secret.endpoint
            - azure.keyvault.uri
            - azure.keyvault.scope
    

   spring.data.mongodb.uri には、Azure の Cosmos DB データベースへの接続 URI が含まれています。 これは標準の Spring Data 変数であり、アプリケーションが既に src/main/resources/application.properties ファイルで使用しています。

2. エクスプローラーで、src/main/resources/application.properties に移動し、Spring Boot アプリが既に spring.data.mongodb.uri 変数を使用してデータにアクセスしていることを確認します。

3. 利便性のために、AZD テンプレート出力には、アプリのアプリ設定ページへの直接リンクが表示されます。 そのリンクを見つけ、それを新しいブラウザー タブで開きます。

   spring.data.mongodb.uri の値を見ると、@Microsoft.KeyVault(...) になるはずです。これは、シークレットがキー コンテナーで管理されているため、これがキー コンテナー参照であることを意味します。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

4. アプリの参照

1. AZD の出力で、アプリの URL を見つけ、ブラウザーでそこに移動します。 URL は、AZD の出力では次のようになります。

    Deploying services (azd deploy)
   
      (✓) Done: Deploying service web
      - Endpoint: https://<app-name>-<hash>.azurewebsites.net/
    

2. 一覧にいくつかのタスクを追加します。

   

   おめでとうございます。Azure Cosmos DB へのセキュリティで保護された接続を使用して、Web アプリが Azure App Service で実行されています。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

5. 診断ログのストリーミング

Azure App Service はコンソール ログをキャプチャできるので、アプリケーションに関する問題の診断に役立ちます。 便宜のために、AZD テンプレートでは、既にローカル ファイル システムへのログ記録が有効になっており、それらのログが Log Analytics ワークスペースに配布されています。

次のスニペットに示すように、このサンプル アプリケーションには、この機能を示す標準の Log4j ログ記録ステートメントが含まれています。

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

AZD の出力で、App Service ログをストリーミングするためのリンクを見つけ、ブラウザーでそこに移動します。 このリンクは、AZD の出力では次のようになります。

Stream App Service logs at: https://portal.azure.com/#@/resource/subscriptions/<subscription-guid>/resourceGroups/<group-name>/providers/Microsoft.Web/sites/<app-name>/logStream

Java アプリのログ記録の詳細については、シリーズの「.NET、Node.js、Python、Java アプリケーション用の Azure Monitor OpenTelemetry を有効にする」を参照してください。

問題がある場合は、 「トラブルシューティング」セクションを確認してください。

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

現在のデプロイ環境内のすべての Azure リソースを削除するには、azd down を実行し、プロンプトに従います。

azd down