1.11. 使用自定义配置转换器作为配置值

流程

1. 在 org.acme.config 软件包 中，使用以下内容创建 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. 实施转换器类，以覆盖转换方法来生成 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
   注意

   您的自定义转换器类必须 是公共的 转换器，且必须有一个 公共 的非参数构造器。您的自定义转换器类无法 抽象。