1.11. カスタム設定コンバーターの設定値としての使用

手順

1. org.acme.config package で、次の内容を含む org.acme.config.MyCustomValue クラスを作成します。

   カスタム設定値の例

     package org.acme.config;
   
     public class MyCustomValue {
   
       private final int value;
   
       public MyCustomValue(Integer value) {
          this.value = value;
      }
   
      public int value() {
          return value;
      }
   }

   Copy to Clipboard Toggle word wrap

2. コンバータークラスを実装し、convert メソッドをオーバーライドして MyCustomValue インスタンスを生成します。

   コンバータークラスの実装例

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

   Copy to Clipboard Toggle word wrap

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

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

   org.acme.config.MyCustomValueConverter
   org.acme.config.SomeOtherConverter
   org.acme.config.YetAnotherConverter

   Copy to Clipboard Toggle word wrap

4. GreetingResource.java ファイルに、MyCustomValue プロパティーを注入します。

   @ConfigProperty(name="custom")
       MyCustomValue value;

   Copy to Clipboard Toggle word wrap

5. この値を使用するように hello メソッドを編集します。

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

   Copy to Clipboard Toggle word wrap

6. application.properties ファイルに、変換する文字列表現を追加します。

   custom=1234

   Copy to Clipboard Toggle word wrap

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

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

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

   要求の例

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

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

   hello world - 1234

   Copy to Clipboard Toggle word wrap
   注記

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