1.11. カスタム設定ソースの設定

手順

1. プロジェクトで、org.eclipse.microprofile.config.spi.ConfigSourceProvider インターフェイスを実装する新しいクラスを作成します。getConfigSources() メソッドをオーバーライドして、カスタム ConfigSource オブジェクトのリストを返します。

   org.acme.config.InMemoryConfigSourceProvider の例

   package org.acme.config;
   
   import org.eclipse.microprofile.config.spi.ConfigSource;
   import org.eclipse.microprofile.config.spi.ConfigSourceProvider;
   
   import java.util.List;
   
   public class InMemoryConfigSourceProvider implements ConfigSourceProvider {
   
     @Override
     public Iterable<ConfigSource> getConfigSources(ClassLoader classLoader) {
       return List.of(new InMemoryConfigSource());
     }
   }

2. カスタム設定ソースを定義するには、org.eclipse.microprofile.config.spi.ConfigSource インターフェイスを実装する InMemoryConfigSource クラスを作成します。

   org.acme.config.InMemoryConfigSource の例

   package org.acme.config;
   
   import org.eclipse.microprofile.config.spi.ConfigSource;
   
   import java.util.HashMap;
   import java.util.Map;
   import java.util.Set;
   
   public class InMemoryConfigSource implements ConfigSource {
   
     private static final Map<String, String> configuration = new HashMap<>();
   
     static {
       configuration.put("my.prop", "1234");
     }
   
     @Override
     public int getOrdinal() { 

   1

   
       return 275;
     }
   
     @Override
     public Set<String> getPropertyNames() {
       return configuration.keySet();
     }
   
     @Override
     public String getValue(final String propertyName) {
       return configuration.get(propertyName);
     }
   
     @Override
     public String getName() {
       return InMemoryConfigSource.class.getSimpleName();
     }
   }

   1

   getOrdinal() メソッドは、ConfigSource クラスの優先度を返します。そのため、複数の設定ソースが同じプロパティーを定義している場合でも、Quarkus は最も優先度の高い ConfigSource クラスで定義されている適切な値を選択できます。

3. プロジェクトの src/main/resources/META-INF/services/ サブディレクトリーに org.eclipse.microprofile.config.spi.ConfigSourceProvider という名前のファイルを作成し、作成したファイルに ConfigSourceProvider を実装するクラスの完全修飾名を入力します。

   org.eclipse.microprofile.config.spi.ConfigSourceProvider ファイルの例:

   org.acme.config.InMemoryConfigSourceProvider

   アプリケーションをコンパイルして開始する際に、作成した ConfigSourceProvider が確実に登録およびインストールされているようにするには、前の手順を完了する必要があります。

4. プロジェクト内の GreetingResource.java ファイルを編集して、次の更新を追加します。

   @ConfigProperty(name="my.prop") int value;

5. GreetingResource.java ファイルで、hello メソッドを展開して新しいプロパティーを使用します。

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

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

   ./mvnw quarkus:dev

7. ターミナルウィンドウを開き、/greeting エンドポイントにリクエストを送信します。

   curl http://localhost:8080/greeting

8. アプリケーションがカスタム設定を読み取り、期待どおりのメッセージを返したことを確認します。

   hello world 1234