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

手順

1. GreetingResource.java ファイルを確認し、次のインポートステートメントが含まれていることを確認します。

   src/main/java/org/acme/config/GreetingResource.java

   import java.util.Optional;
   import javax.inject.Inject;

   Copy to Clipboard Toggle word wrap

2. src/main/java/org/acme/config ディレクトリーに GreetingConfiguration.java ファイルを作成します。

3. ConfigProperties と Optional のインポートを GreetingConfiguration.java ファイルに追加します。

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;
   import javax.inject.Inject;

   Copy to Clipboard Toggle word wrap

4. GreetingConfiguration.java ファイルに greeting プロパティーの GreetingConfiguration クラスを作成します。

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting") 

   1

   
   public class GreetingConfiguration {
   
       private String message;
       private String suffix = "!"; 

   2

   
       private Optional<String> name;
   
       public String getMessage() {
           return message;
       }
   
       public void setMessage(String message) {
           this.message = message;
       }
   
       public String getSuffix() {
           return suffix;
       }
   
       public void setSuffix(String suffix) {
           this.suffix = suffix;
       }
   
       public Optional<String> getName() {
           return name;
       }
   
       public void setName(Optional<String> name) {
           this.name = name;
       }
   }

   Copy to Clipboard Toggle word wrap

   1

   prefix はオプションです。接頭辞を指定しない場合は、クラスの名前で決定されます。この例では、接頭辞は greeting です。

   2

   greeting.suffix が設定されていない場合、! はデフォルト値です。

5. @Inject アノテーションを使用して GreetingConfiguration クラスを GreetingResource クラスに注入します。

   src/main/java/org/acme/config/GreetingResource.java

   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.getMessage() + " " + config.getName().orElse("world") + config.getSuffix();
       }
   }

   Copy to Clipboard Toggle word wrap

6. 開発モードでアプリケーションをコンパイルして起動します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   重要

   クラスプロパティーの値を指定しないと、アプリケーションはコンパイルに失敗し、値が指定されていないことを示す javax.enterprise.inject.spi.DeploymentException を受け取ります。これは、Optional フィールドおよびデフォルト値のフィールドには適用されません。

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

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. 以下のメッセージが表示されます。

   hello quarkus!

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

手順

1. GreetingConfiguration.java ファイルを確認し、次のインポートステートメントが含まれていることを確認します。

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;
   import java.util.List;

   Copy to Clipboard Toggle word wrap

2. @ConfigProperties アノテーションを使用して、GreetingConfiguration.java ファイルに設定を追加します。

   次の例は、GreetingConfiguration クラスとそのプロパティーの設定を示しています。

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public class GreetingConfiguration {
   
       public String message;
       public String suffix = "!";
       public Optional<String> name;
   }

   Copy to Clipboard Toggle word wrap

3. 次の例に示すように、GreetingConfiguration クラス内にネストされたクラスを追加します。

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public class GreetingConfiguration {
   
       public String message;
       public String suffix = "!";
       public Optional<String> name;
       public ContentConfig content;
   
       public static class ContentConfig {
           public Integer prizeAmount;
           public List<String> recipients;
       }
   }

   Copy to Clipboard Toggle word wrap

   この例は、ネストされたクラス ContentConfig を示しています。フィールドの名前 (ここでは content) が、オブジェクトにバインドされるプロパティーの名前を決定します。

4. application.properties ファイルで greeting.content.prize-amount および greeting.content.recipients 設定プロパティーを設定します。

   次の例は、GreetingConfiguration クラスと ContentConfig クラスのプロパティーの値を示しています。

   src/main/resources/application.properties

   greeting.message = hello
   greeting.name = quarkus
   greeting.content.prize-amount=10
   greeting.content.recipients=Jane,John

   Copy to Clipboard Toggle word wrap

5. @Inject アノテーションを使用して GreetingConfiguration クラスを GreetingResource クラスに注入し、/greeting エンドポイントが返すメッセージ文字列を更新し、追加した新しい greeting.content.prize-amount プロパティーおよび greeting.content.recipients プロパティーに設定した値をメッセージに表示させます。

   src/main/java/org/acme/config/GreetingResource.java

   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.message + " " + config.name.orElse("world") + config.suffix + "\n" + config.content.recipients + " receive total of candies: " + config.content.prizeAmount;
       }
   }

   Copy to Clipboard Toggle word wrap

6. 開発モードでアプリケーションをコンパイルして起動します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   重要

   クラスプロパティーの値を指定しないと、アプリケーションはコンパイルに失敗し、値が指定されていないことを示す javax.enterprise.inject.spi.DeploymentException を受け取ります。これは、Optional フィールドおよびデフォルト値のフィールドには適用されません。

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

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. 1 行目に挨拶、2 行目に賞金の受賞者と賞金額が書かれたメッセージを受信します。

   hello quarkus!
   Jane,John receive total of candies: 10

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

手順

1. GreetingConfiguration.java ファイルを確認し、次のインポートステートメントが含まれていることを確認します。

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   import java.util.Optional;

   Copy to Clipboard Toggle word wrap

2. GreetingConfiguration クラスをインターフェイスとして GreetingConfiguration.java ファイルに追加します。

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public interface GreetingConfiguration {
   
       @ConfigProperty(name = "message") 

   1

   
       String message();
   
       @ConfigProperty(defaultValue = "!")
       String getSuffix(); 

   2

   
   
       Optional<String> getName(); 

   3

   
   }

   Copy to Clipboard Toggle word wrap

   1

   設定プロパティーの名前が getter メソッド命名規則に準拠しないため、@ConfigProperty アノテーションを設定する必要があります。

   2

   この例では、name は設定されていないため、対応するプロパティーは greeting.suffix になります。

   3

   @ConfigProperty アノテーションを指定する必要はありません。これは、メソッド名が getter メソッドの命名規則に従い (greeting.name が対応するプロパティー)、デフォルト値が不要であるためです。

3. @Inject アノテーションを使用して GreetingConfiguration クラスを GreetingResource クラスに注入します。

   src/main/java/org/acme/config/GreetingResource.java

   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.message() + " " + config.getName().orElse("world") + config.getSuffix();
       }
   }

   Copy to Clipboard Toggle word wrap

4. 開発モードでアプリケーションをコンパイルして起動します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   重要

   クラスプロパティーの値を指定しないと、アプリケーションはコンパイルに失敗し、値が指定されていないことを示す javax.enterprise.inject.spi.DeploymentException を受け取ります。これは、Optional フィールドおよびデフォルト値のフィールドには適用されません。

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

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

6. 以下のメッセージが表示されます。

   hello quarkus!

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

手順

1. カスタムプロファイルを設定するには、application.properties ファイルのプロファイル名で設定プロパティーを作成します。<key> はプロパティー名に、<value> はプロパティーの値に、そして <profile> はプロファイル名に置き換えます。

    %<profile>.<key>=<value>

   Copy to Clipboard Toggle word wrap

   以下の設定例では、quarkus.http.port の値はデフォルトで 9090 で、dev プロファイルがアクティブ化されると 8181 になります。

   quarkus.http.port=9090
   %dev.quarkus.http.port=8181

   Copy to Clipboard Toggle word wrap

2. プロファイルを有効にするには、以下のいずれかの方法を使用します。

   • quarkus.profile システムプロパティーを設定します。

     • quarkus.profile システムプロパティーを使用してプロファイルを有効にするには、以下のコマンドを入力します。

       mvn -Dquarkus.profile=<value> quarkus:dev

       Copy to Clipboard Toggle word wrap

   • QUARKUS_PROFILE 環境変数を設定します。

     • 環境変数を使用してプロファイルを有効にするには、以下のコマンドを入力します。

       export QUARKUS_PROFILE=<profile>

       Copy to Clipboard Toggle word wrap
       注記

       システムプロパティーの値は環境変数の値よりも優先されます。

3. アプリケーションを再パッケージしてプロファイルを変更するには、以下のコマンドを入力します。

   ./mvnw package -Dquarkus.profile=<profile>
    java -jar target/myapp-runner.jar

   Copy to Clipboard Toggle word wrap

   以下の例は、prod-aws プロファイルをアクティブ化するコマンドを示しています。

   ./mvnw package -Dquarkus.profile=prod-aws
    java -jar target/myapp-runner.jar

   Copy to Clipboard Toggle word wrap

手順

1. 以下のインポートステートメントをサービスファイルに追加します。

   package org.acme.config;
   
   import javax.annotation.Priority;
   import org.eclipse.microprofile.config.spi.Converter;

   Copy to Clipboard Toggle word wrap

2. クラスに @Priority アノテーションを付け、優先度の値を渡して、カスタムコンバーターの優先度を設定します。

   @Priority(150)
   public class MyCustomConverter implements Converter<MicroProfileCustomValue> {
   
       @Override
       public MicroProfileCustomValue convert(String value) {
   
           final int secretNumber;
           if (value.startsFrom("OBF:")) {
               secretNumber = Integer.valueOf(SecretDecoder.decode(value));
           } else {
               secretNumber = Integer.valueOf(value);
           }
   
           return new MicroProfileCustomValue(secretNumber);
       }
   }

   Copy to Clipboard Toggle word wrap
   注記

   新しいコンバーターを追加する場合は、META-INF/services/org.eclipse.microprofile.config.spi.Converter サービスファイルにリストする必要があります。

手順

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

2. 以下の例のように、ネストされたクラス設定プロパティーを application.yaml ファイルに追加します。

   src/main/resources/application.yaml

   # Properties that configure the JDBC data source driver of your PostgreSQL data source
   quarkus:
     datasource:
       url: jdbc:postgresql://localhost:5432/some-database
       driver: org.postgresql.Driver
       username: quarkus
       password: quarkus
   
   # Property that configures the URL of the endpoint to which the rest client sends requests
   org:
     acme:
       restclient:
         CountriesService/mp-rest/url: https://restcountries.eu/rest
   
   # Property that configures the log message level for your application
   quarkus:
     log:
       category:
         # Do not use spaces in names of configuration properties that you place inside quotation marks
         "io.quarkus.category":
           level: INFO

   Copy to Clipboard Toggle word wrap

   コメントを使用して、application.properties で使用する場合と同じ方法で設定プロパティーを記述できることに留意してください。

   注記

   YAML 設定ファイル内のプロパティーをインデントするには、常にスペースを使用してください。YAML では、インデントにタブを使用できません。

手順

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

2. プロファイル依存設定を設定するには、"%<profile_name>" 構文を使用してキーと値のペアを定義する前にプロファイル名を追加します。プロファイル名は必ず引用符で囲んでください。YAML では、特殊文字で始まるすべての文字列を引用符で囲む必要があります。

   以下の例では、開発モードで Quarkus アプリケーションを起動する際に、PostgreSQL データベースを jdbc:postgresql://localhost:5432/some-database URL で利用できるように設定されています。

   src/main/resources/application.yaml

   "%dev":
     # Properties that configure the JDBC data source driver of your PostgreSQL data source
     quarkus:
       datasource:
         url: jdbc:postgresql://localhost:5432/some-database
         driver: org.postgresql.Driver
         username: quarkus
         password: quarkus

   Copy to Clipboard Toggle word wrap

手順

1. YAML 設定ファイルを開きます。

2. YAML プロパティーを別のプロパティーの接頭辞として定義するには、以下の例に示すようにプロパティーの範囲にティルデ (~) を追加します。

   quarkus:
     http:
       cors:
         ~: true
         methods: GET,PUT,POST

   Copy to Clipboard Toggle word wrap

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

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   注記

   YAML キーは設定プロパティー名のアセンブリーに含まれないため、任意のレベルの競合する設定キーに使用できます。