1.6. 高级配置映射

流程

1. 查看项目中的 GreetingResource.java 文件，并确保该文件包含以下示例中显示的内容。要使用 @ConfigPoperties 注释，将另一个配置源的配置属性注入此类，您必须导入 java.util.Optional 和 org.eclipse.microprofile.config.inject.ConfigProperty 软件包。

   GreetingResource.java 文件示例

   import java.util.Optional;
   
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   
   @Path("/greeting")
   public class GreetingResource {
   
       @ConfigProperty(name = "greeting.message")
       String message;
   
       @ConfigProperty(name = "greeting.suffix", defaultValue="!")
       String suffix;
   
       @ConfigProperty(name = "greeting.name")
       Optional<String> name;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return message + " " + name.orElse("world") + suffix;
       }
   }

2. 在 src/main/java/org/acme/config 目录中创建一个 GreetingConfiguration.java 文件。将 ConfigMapping 和 Optional 的导入语句添加到文件中：

   GreetingConfiguration.java 文件示例

   import io.smallrye.config.ConfigMapping;
   import io.smallrye.config.WithDefault;
   import java.util.Optional;
   
   @ConfigMapping(prefix = "greeting") 

   1

   
   public interface GreetingConfiguration {
       String message();
   
       @WithDefault("!") 

   2

   
       String suffix();
   
       Optional<String> name();
   }

   1

   prefix 属性是可选的。例如，在这种情况下，前缀是 问候语。

   2

   如果没有设置 greeting.suffix，则使用 ! 作为默认值。

3. 使用 @Inject 注释将 GreetingConfiguration 实例注入 GreetingResource 类，如下所示：

   注意

   此片段取代了在 config-quickstart 项目的初始版本中标上 @ConfigProperty 的三个字段。

   GreetingResource.java 文件示例

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

4. 以开发模式编译并启动应用程序：

   ./mvnw quarkus:dev

   重要

   如果没有为类属性提供值，应用程序将无法编译，并返回 io.smallrye.config.ConfigValidationException 错误来指示缺少值。这不适用于带有默认值的可选字段或字段。

5. 要验证端点是否返回信息，请在一个新的终端窗口中输入以下命令：

   curl http://localhost:8080/greeting

6. 您会收到以下信息：

   hello quarkus!

7. 要停止应用程序，请按 Ctrl+C。

流程

1. 查看项目中的 GreetingResource.java。文件包含带有 hello （） 方法的 GreetingResource 类，该方法在 /greeting 端点上发送 HTTP 请求时返回一条消息：

   GreetingResource.java 文件示例

   import java.util.Optional;
   
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   
   @Path("/greeting")
   public class GreetingResource {
   
       @ConfigProperty(name = "greeting.message")
       String message;
   
       @ConfigProperty(name = "greeting.suffix", defaultValue="!")
       String suffix;
   
       @ConfigProperty(name = "greeting.name")
       Optional<String> name;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return message + " " + name.orElse("world") + suffix;
       }
   }

2. 使用 GreetingConfiguration.java 实例创建一个 GreetingConfiguration.java 类文件。此类包含 GreetingResource 类中定义的 hello （） 方法的外部化配置：

   GreetingConfiguration.java 文件示例

   import io.smallrye.config.ConfigMapping;
   import io.smallrye.config.WithDefault;
   import java.util.Optional;
   
   @ConfigMapping(prefix = "greeting")
   public interface GreetingConfiguration {
       String message();
   
       @WithDefault("!")
       String suffix();
   
       Optional<String> name();
   }

3. 创建嵌套在 GreetingConfiguration 实例中的 ContentConfig 类，如下例所示：

   GreetingConfiguration.java 文件示例

   import io.smallrye.config.ConfigMapping;
   import io.smallrye.config.WithDefault;
   
   import java.util.List;
   import java.util.Optional;
   
   @ConfigMapping(prefix = "greeting")
   public interface GreetingConfiguration {
       String message();
   
       @WithDefault("!")
       String suffix();
   
       Optional<String> name();
   
       ContentConfig content();
   
       interface ContentConfig {
           Integer prizeAmount();
   
           List<String> recipients();
       }
   }

   注意

   ContentConfig 类的方法名称为 content。要确保您将属性绑定到正确的接口，当您为此类定义配置属性时，请使用前缀 中的内容。这样，您还可以防止属性名称冲突和意外的应用程序行为。

4. 在 application.properties 文件中定义 greeting.content.prize-amount 和 greeting.content.recipients 配置属性。

   以下示例显示了为 GreetingConfiguration 实例和 ContentConfig 类定义的属性：

   application.properties 文件示例

   greeting.message = hello
   greeting.name = quarkus
   greeting.content.prize-amount=10
   greeting.content.recipients=Jane,John

5. 使用 @Inject 注释，将 GreetingConfiguration 实例注入 GreetingResource 类，而不是三个 @ConfigProperty 字段注释，如下例所示。另外，您必须更新 /greeting 端点返回的消息字符串，并带有您为新的 greeting.content.prize-amount 和 greeting.content.recipients 属性设置的值。

   GreetingResource.java 文件示例

   import java.util.Optional;
   
   import jakarta.ws.rs.GET;
   import jakarta.ws.rs.Path;
   import jakarta.ws.rs.Produces;
   import jakarta.ws.rs.core.MediaType;
   
   import jakarta.inject.Inject;
   
   @Path("/greeting")
   public class GreetingResource {
   
       @Inject
       GreetingConfiguration config;
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return config.message() + " " + config.name().orElse("world") + config.suffix() + "\n" + config.content().recipients() + " receive total of candies: " + config.content().prizeAmount();
       }
   }

6. 以开发模式编译并启动应用程序：

   ./mvnw quarkus:dev

   重要

   如果没有为类属性提供值，应用程序将无法编译，您会收到一个 jakarta.enterprise.inject.spi.DeploymentException 异常来指示缺少值。这不适用于带有 默认值的 Optional 字段和字段。

7. 要验证端点是否返回信息，请打开一个新的终端窗口并输入以下命令：

   curl http://localhost:8080/greeting

   这时将显示一条消息，其中包含两行输出。第一行显示问候语，第二行报告 prize 收件人以及奖品量，如下所示：

   hello quarkus!
   Jane,John receive total of candies: 10

8. 要停止应用程序，请按 Ctrl+C。