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

手順

1. org.eclipse.microprofile.config.spi.ConfigSourceProvider インターフェイスを実装するプロジェクトでクラスファイルを作成します。ConfigSource オブジェクトのリストを返すには、getConfigSources() メソッドをオーバーライドする必要があります。

   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());
       }
   }

   Copy to Clipboard Toggle word wrap

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();
       }
   }

   Copy to Clipboard Toggle word wrap

   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

   Copy to Clipboard Toggle word wrap

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

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

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

   Copy to Clipboard Toggle word wrap

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

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

   Copy to Clipboard Toggle word wrap

6. 以下のコマンドを入力して、開発モードでアプリケーションをコンパイルし、起動します。

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

7. ターミナルウィンドウを開いて次のコマンドを入力し、/greeting エンドポイントが予期したメッセージを返すことを確認します。

   要求の例

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. アプリケーションがカスタム設定を正常に読み取ると、コマンドは次のレスポンスを返します。

   hello world 1234

   Copy to Clipboard Toggle word wrap