第4章 Quarkus アプリケーションへの設定値の注入

手順

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

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

   package org.acme.config;
   
   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

   package org.acme.config;
   
   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;

   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 greetingConfiguration;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return message + " " + name.orElse("world") + suffix;
       }
   }

   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 ファイルに追加します。

   以下の例は、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 クラスに注入します。

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

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

   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

   package org.acme.config;
   
   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

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

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

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

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

   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 を押します。