Quarkus アプリケーションの設定

手順

1. コマンドターミナルで以下のコマンドを入力し、Maven が JDK 11 を使用していること、そして Maven のバージョンが 3.6.2 以上であることを確認します。

   mvn --version

   Copy to Clipboard Toggle word wrap
2. 上記のコマンドで JDK 11 が返されない場合は、JDK 11 へのパスを PATH 環境変数に追加し、上記のコマンドを再度入力します。

3. プロジェクトを生成するには、以下のコマンドを入力します。

   mvn io.quarkus:quarkus-maven-plugin:1.3.4.Final-redhat-00004:create \
       -DprojectGroupId=org.acme \
       -DprojectArtifactId=config-quickstart \
       -DplatformGroupId=com.redhat.quarkus \
       -DplatformVersion=1.3.4.Final-redhat-00004 \
       -DclassName="org.acme.config.GreetingResource" \
       -Dpath="/greeting"
   cd config-quickstart

   Copy to Clipboard Toggle word wrap

   このコマンドは、./config-quickstart ディレクトリーに以下の要素を作成します。

   • Maven の構造
   • org.acme.config.GreetingResource リソース
   • アプリケーションの起動後に http://localhost:8080 でアクセス可能なランディングページ
   • src/main/docker の Dockerfile ファイルの例
   • アプリケーション設定ファイル

   • 関連するテスト

     注記

     このチュートリアルで使用する Quarkus Maven プロジェクトは、Quarkus quickstart archive からダウンロードするか、Quarkus Quickstarts Git リポジトリーをクローンしてください。この演習は config-quickstart ディレクトリーにあります。

手順

1. src/main/resources/application.properties ファイルを開きます。

2. 設定プロパティーを設定ファイルに追加します。<KEY> はプロパティー名に、<VALUE> はプロパティーの値に置き換えます。

   <KEY>=<VALUE>

   Copy to Clipboard Toggle word wrap

   以下の例は、Quarkus config-quickstart プロジェクトの greeting.message プロパティーおよび greeting.name プロパティーの値を設定する方法を示しています。

   greeting.message = hello
   greeting.name = quarkus

   Copy to Clipboard Toggle word wrap
   重要

   quarkus を Quarkus プロパティーの接頭辞として使用します。

3. GreetingResource.java ファイルを確認し、以下の import ステートメントが含まれることを確認します。

   import org.eclipse.microprofile.config.inject.ConfigProperty;
   import java.util.Optional;

   Copy to Clipboard Toggle word wrap

4. 以下の構文でアノテーションを付けて、同等のプロパティーを定義します。

   @ConfigProperty(name = "greeting.message") 

   1

   
   String message;
   
   @ConfigProperty(name = "greeting.suffix", defaultValue="!") 

   2

   
   String suffix;
   
   @ConfigProperty(name = "greeting.name")
   Optional<String> name; 

   3

   Copy to Clipboard Toggle word wrap

   1

   このプロパティーの値を指定しないと、アプリケーションは失敗し、以下の例外メッセージをスローします。
   javax.enterprise.inject.spi.DeploymentException: No config value of type [class java.lang.String] exists for: greeting.message

   2

   greeting.suffix の値を指定しない場合、Quarkus はこれをデフォルト値に解決します。

   3

   Optional パラメーターに値がない場合は、greeting.name に対する値は返されません。

   注記

   設定した値をインジェクトするには、@ConfigProperty を使用できます。@ConfigProperty アノテーションが付けられたメンバーには、@Inject アノテーションを付ける必要はありません。

5. hello メソッドを編集して、以下のメッセージを返します。

   @GET
   @Produces(MediaType.TEXT_PLAIN)
   public String hello() {
       return message + "  " + name.orElse("world") + suffix;
   }

   Copy to Clipboard Toggle word wrap

6. 開発モードで Quarkus アプリケーションをコンパイルするには、プロジェクトディレクトリーから以下のコマンドを入力します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

7. エンドポイントがメッセージを返すことを確認するには、新しいターミナルウィンドウに以下のコマンドを入力します。

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

   このコマンドは、以下の出力を返します。

   hello quarkus!

   Copy to Clipboard Toggle word wrap
8. アプリケーションを停止するには、CTRL+C を押します。

手順

1. Quarkus プロジェクトをパッケージ化するには、以下のコマンドを入力します。

   ./mvnw clean package

   Copy to Clipboard Toggle word wrap

2. 以下のメソッドのいずれかを使用して、設定プロパティーを設定します。

   • システムプロパティーの設定

     以下のコマンドを入力します。<KEY> は追加する設定プロパティーの名前に、<VALUE> はプロパティーの値に置き換えます。

     java -D<KEY>=<VALUE> -jar target/myapp-runner.jar

     Copy to Clipboard Toggle word wrap

     たとえば、quarkus.datasource.password プロパティーの値を設定するには、以下のコマンドを入力します。

     java -Dquarkus.datasource.password=youshallnotpass -jar target/myapp-runner.jar

     Copy to Clipboard Toggle word wrap

   • 環境変数の設定

     以下のコマンドを入力します。<KEY> は設定する設定プロパティーの名前に、<VALUE> はプロパティーの値に置き換えます。

     export <KEY>=<VALUE> ; java -jar target/myapp-runner.jar

     Copy to Clipboard Toggle word wrap
     注記

     環境変数名は、Eclipse MicroProfile の変換ルールに従います。名前を大文字に変換し、英数字以外の文字をすべてアンダースコア (_) に置き換えます。

   • 環境ファイルの使用

     現在の作業ディレクトリーに .env ファイルを作成し、設定プロパティーを追加します。<KEY> はプロパティー名に、<VALUE> はプロパティーの値に置き換えます。

     <KEY>=<VALUE>

     Copy to Clipboard Toggle word wrap
     注記

     開発モードでは、このファイルはプロジェクトの root ディレクトリーに置かれますが、バージョン管理でファイルを追跡しないことが推奨されます。プロジェクトのルートディレクトリーに .env ファイルを作成する場合は、プログラムがプロパティーとして読み取るキーおよび値を定義できます。

   • application.properties ファイルの使用

     アプリケーションが実行される $PWD/config/application.properties ディレクトリーに設定ファイルを配置し、そのファイルに定義されたランタイムプロパティーがデフォルト設定を上書きできるようにします。

     注記

     開発モードで config/application.properties 機能を使用することもできます。target ディレクトリー内に config/application.properties を配置します。ビルドツールからのクリーニング操作 (例: mvn clean) は、config ディレクトリーも削除します。

手順

1. Java リソースファイルを開き、以下の import ステートメントを追加します。

   import io.quarkus.runtime.configuration.ProfileManager;

   Copy to Clipboard Toggle word wrap

2. 現在の設定プロファイルを表示するには、ProfileManager.getActiveProfile() メソッドを呼び出すログを追加します。

   LOGGER.infof("The application is starting with profile `%s`", ProfileManager.getActiveProfile());

   Copy to Clipboard Toggle word wrap
   注記

   @ConfigProperty("quarkus.profile") メソッドを使用して、現在のプロファイルにアクセスすることはできません。

手順

1. プロジェクト内に ExampleConfigSourceProvider.java ファイルを作成し、以下の import を追加します。

   package org.acme.config;
   
   import java.util.Collections;
   import java.util.HashMap;
   import java.util.Map;
   import java.util.Set;
   
   import org.eclipse.microprofile.config.spi.ConfigSource;
   import org.eclipse.microprofile.config.spi.ConfigSourceProvider;

   Copy to Clipboard Toggle word wrap

2. ConfigSourceProvider インターフェースを実装するクラスを作成し、その getConfigSources メソッドを上書きして ConfigSource オブジェクトの一覧を返すようにします。

   以下の例は、カスタムの ConfigSourceProvider クラスおよび ConfigSource クラスの実装を示しています。

   public class ExampleConfigSourceProvider implements ConfigSourceProvider {
   
       private final int times = 2;
       private final String name = "example";
       private final String value = "value";
   
       @Override
       public Iterable<ConfigSource> getConfigSources(ClassLoader forClassLoader) {
           InMemoryConfigSource configSource = new InMemoryConfigSource(Integer.MIN_VALUE, "example config source");
           for (int i = 0; i < this.times; i++) {
               configSource.add(this.name + ".key" + (i + 1), this.value + (i + 1));
           }
           return Collections.singletonList(configSource);
       }
   
       private static final class InMemoryConfigSource implements ConfigSource {
   
           private final Map<String, String> values = new HashMap<>();
           private final int ordinal;
           private final String name;
   
           private InMemoryConfigSource(int ordinal, String name) {
               this.ordinal = ordinal;
               this.name = name;
           }
   
           public void add(String key, String value) {
               values.put(key, value);
           }
   
           @Override
           public Map<String, String> getProperties() {
               return values;
           }
   
           @Override
           public Set<String> getPropertyNames() {
               return values.keySet();
           }
   
           @Override
           public int getOrdinal() {
               return ordinal;
           }
   
           @Override
           public String getValue(String propertyName) {
               return values.get(propertyName);
           }
   
           @Override
           public String getName() {
               return name;
           }
       }
   }

   Copy to Clipboard Toggle word wrap
3. META-INF/services/ ディレクトリーに org.eclipse.microprofile.config.spi.ConfigSourceProvider サービスファイルを作成します。

4. org.eclipse.microprofile.config.spi.ConfigSourceProvider ファイルを開き、カスタム ConfigSourceProvider クラスの完全修飾名を追加します。

   org.acme.config.ExampleConfigSourceProvider

   Copy to Clipboard Toggle word wrap

5. 開発モードでアプリケーションをコンパイルするには、プロジェクトディレクトリーから以下のコマンドを入力します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

   アプリケーションを再起動すると、Quarkus はカスタム設定プロバイダーを選択します。

手順

1. 以下の例に示すように、META-INF/services/org.eclipse.microprofile.config.spi.Converter サービスファイルにコンバーターの完全修飾クラス名を含めます。

   org.acme.config.MicroProfileCustomValueConverter
   org.acme.config.SomeOtherConverter
   org.acme.config.YetAnotherConverter

   Copy to Clipboard Toggle word wrap

2. converter クラスを実装し、convert メソッドを上書きします。

   package org.acme.config;
   
   import org.eclipse.microprofile.config.spi.Converter;
   
   public class MicroProfileCustomValueConverter implements Converter<MicroProfileCustomValue> {
   
       @Override
       public MicroProfileCustomValue convert(String value) {
           return new MicroProfileCustomValue(Integer.valueOf(value));
       }
   }

   Copy to Clipboard Toggle word wrap
   注記

   カスタムコンバータークラスは public で、引数なしのコンストラクター public がなければなりません。カスタムコンバータークラスは abstract であってはなりません。

3. カスタムタイプを設定値として使用します。

   @ConfigProperty(name = "configuration.value.name")
   MicroProfileCustomValue value;

   Copy to Clipboard Toggle word wrap

手順

1. GreetingResourceTest.java ファイルを開きます。

2. testHelloEndpoint メソッドの内容を更新します。

   package org.acme.config;
   
   import io.quarkus.test.junit.QuarkusTest;
   import org.junit.jupiter.api.Test;
   
   import static io.restassured.RestAssured.given;
   import static org.hamcrest.CoreMatchers.is;
   
   @QuarkusTest
   public class GreetingResourceTest {
   
       @Test
       public void testHelloEndpoint() {
           given()
             .when().get("/greeting")
             .then()
                .statusCode(200)
                .body(is("hello quarkus!")); // Modified line
       }
   
   }

   Copy to Clipboard Toggle word wrap

手順

1. Quarkus プロジェクトをパッケージ化するには、root ディレクトリーで以下のコマンドを入力します。

   ./mvnw clean package

   Copy to Clipboard Toggle word wrap

   このコマンドは、以下の JAR ファイルを /target ディレクトリーに生成します。

   • config-quickstart-1.0-SNAPSHOT.jar: プロジェクトのクラスおよびリソースが含まれます。これは、Maven ビルドで生成される通常のアーティファクトです。
   • config-quickstart-1.0-SNAPSHOT-runner.jar: 実行可能な JAR ファイルです。依存関係は target/lib ディレクトリーにコピーされるため、このファイルは uber-JAR ファイルではない点に注意してください。
2. 開発モードを実行している場合は、CTRL+C を押して開発モードを停止します。停止しないと、ポートの競合が発生します。

3. アプリケーションを実行するには、以下のコマンドを入力します。

   java -jar target/config-quickstart-1.0-SNAPSHOT-runner.jar

   Copy to Clipboard Toggle word wrap
   注記

   runner JAR ファイルからの MANIFEST.MF ファイルのClass-Path エントリーは、lib ディレクトリーからの JAR ファイルを明示的に記述します。別の場所からアプリケーションをデプロイする場合は、runner JAR ファイルと lib ディレクトリーをコピーする必要があります。