クイックスタート:Azure App Configuration を使用して Java Spring アプリを作成する

[アーティクル]
09/27/2023

このクイックスタートでは、コードとは別にアプリケーション設定のストレージと管理を一元化するために、Azure App Configuration を Java Spring アプリに組み込みます。

前提条件

アクティブなサブスクリプションが含まれる Azure アカウント。無料で作成できます。
App Configuration ストア。ストアを作成します。
バージョン 11 を含む、サポートされている Java Development Kit (JDK)。
Apache Maven バージョン 3.0 以降。
Spring Boot アプリケーション。ない場合は、Spring Initializr で Maven プロジェクトを作成します。必ず、[Maven プロジェクト] を選択し、[依存関係] に [Spring Web] 依存関係を追加してから、Java のバージョン 8 以降を選択してください。

キーと値を追加する

App Configuration ストアに次のキーと値を追加し、[ラベル] と [コンテンツのタイプ] を既定値のままにします。 Azure portal または CLI を使用してストアにキーと値を追加する方法の詳細については、キーと値の作成に関する記事を参照してください。

キー	値
/application/config.message	こんにちは

App Configuration ストアに接続する

App Configuration ストアが作成されたので、Spring Cloud Azure Config スターターを使用して、作成した App Configuration ストアとアプリケーションが通信できるようにすることができます。

Spring Cloud Azure Config スターターモジュールをインストールするには、次の依存関係を pom.xml ファイルに追加します。

Spring Boot 3
Spring Boot 2

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-appconfiguration-config-web</artifactId>
</dependency>

<dependencyManagement>
    <dependencies>
        <dependency>
        <groupId>com.azure.spring</groupId>
        <artifactId>spring-cloud-azure-dependencies</artifactId>
        <version>5.8.0</version>
        <type>pom</type>
        <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

<dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-appconfiguration-config-web</artifactId>
</dependency>

<dependencyManagement>
    <dependencies>
        <dependency>
        <groupId>com.azure.spring</groupId>
        <artifactId>spring-cloud-azure-dependencies</artifactId>
        <version>4.14.0</version>
        <type>pom</type>
        <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

アプリケーションをコーディングする

Spring Cloud Azure Config スターターを使用して、作成した App Configuration ストアとアプリケーションが通信できるようにするには、次の手順に従ってアプリケーションを構成します。

MessageProperties.java という名前の新しい Java ファイルを作成し、次の行を追加します。

import org.springframework.boot.context.properties.ConfigurationProperties;

@ConfigurationProperties(prefix = "config")
public class MessageProperties {
    private String message;

    public String getMessage() {
        return message;
    }

    public void setMessage(String message) {
        this.message = message;
    }
}

HelloController.java という名前の新しい Java ファイルを作成し、次の行を追加します。

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    private final MessageProperties properties;

    public HelloController(MessageProperties properties) {
        this.properties = properties;
    }

    @GetMapping
    public String getMessage() {
        return "Message: " + properties.getMessage();
    }
}

メインアプリケーションの Java ファイルで、@EnableConfigurationProperties を追加して、MessageProperties.java 構成プロパティクラスを有効にし、それを Spring コンテナーに登録します。

import org.springframework.boot.context.properties.EnableConfigurationProperties;

@SpringBootApplication
@EnableConfigurationProperties(MessageProperties.class)
public class DemoApplication {
    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }
}

自動生成された単体テストを開き、Azure App Configuration を無効にするように更新します。そうしないと、単体テストの実行時にサービスからの読み込みが試行されます。

import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest(properties = "spring.cloud.azure.appconfiguration.enabled=false")
class DemoApplicationTests {

    @Test
    void contextLoads() {
    }

}

アプリの resources ディレクトリに、bootstrap.properties という名前の新しいファイルを作成し、そのファイルに以下の行を追加します。
```
spring.cloud.azure.appconfiguration.stores[0].connection-string= ${APP_CONFIGURATION_CONNECTION_STRING}
```
APP_CONFIGURATION_CONNECTION_STRING という名前の環境変数に、App Configuration ストアへのアクセスキーを設定します。コマンドラインで次のコマンドを実行してコマンドプロンプトを再起動し、変更が反映されるようにします。
```
setx APP_CONFIGURATION_CONNECTION_STRING "connection-string-of-your-app-configuration-store"
```
Windows PowerShell を使用する場合は、次のコマンドを実行します。
```
$Env:APP_CONFIGURATION_CONNECTION_STRING = "connection-string-of-your-app-configuration-store"
```
macOS または Linux を使用する場合は、次のコマンドを実行します。
```
export APP_CONFIGURATION_CONNECTION_STRING='connection-string-of-your-app-configuration-store'
```

アプリをビルドしてローカルで実行する

ルートディレクトリに対するコマンドプロンプトを開き、次のコマンドを実行して、Maven を使用して Spring Boot アプリケーションをビルドし、実行します。
```
mvn clean package
mvn spring-boot:run
```
アプリケーションが実行されたら、curl を使用してアプリケーションをテストできます。次に例を示します。
```
curl -X GET http://localhost:8080/
```
App Configuration ストアに入力したメッセージが表示されます。

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

この記事で作成したリソースを継続して使用しない場合は、ここで作成したリソースグループを削除して課金されないようにしてください。

重要

リソースグループを削除すると、元に戻すことができません。リソースグループとそのすべてのリソースは完全に削除されます。間違ったリソースグループやリソースをうっかり削除しないようにしてください。この記事のリソースを、保持したい他のリソースを含むリソースグループ内に作成した場合は、リソースグループを削除する代わりに、各リソースをそれぞれのペインから個別に削除します。

Azure portal にサインインし、 [リソースグループ] を選択します。
[名前でフィルター] ボックスにリソースグループの名前を入力します。
結果一覧でリソースグループ名を選択し、概要を表示します。
[リソースグループの削除] を選択します。
リソースグループの削除の確認を求めるメッセージが表示されます。確認のためにリソースグループの名前を入力し、 [削除] を選択します。

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

次のステップ

このクイックスタートでは、新しい App Configuration ストアを作成して、Java Spring アプリで使用しました。詳細については、「Azure の Spring」を参照してください。その他の質問については、リファレンスドキュメントを参照してください。Spring Cloud Azure App Configuration ライブラリのしくみに関する詳細がすべて記載されています。 Java Spring アプリで構成設定を動的に更新できるようにする方法については、次のチュートリアルに進んでください。

動的な構成を有効にする

クイック スタート:Azure App Configuration を使用して Java Spring アプリを作成する