4.3. 使用 @ConfigProperties 注解接口

流程

1. 查看 GreetingConfiguration.java 文件，并确保它包括以下导入语句：

   src/main/java/org/acme/config/GreetingConfiguration.java

   import io.quarkus.arc.config.ConfigProperties;
   import org.eclipse.microprofile.config.inject.ConfigProperty;
   import java.util.Optional;

   Copy to Clipboard Toggle word wrap

2. 将 GreetingConfiguration 类作为接口添加到 GreetingConfiguration.java 文件中：

   src/main/java/org/acme/config/GreetingConfiguration.java

   @ConfigProperties(prefix = "greeting")
   public interface GreetingConfiguration {
   
       @ConfigProperty(name = "message") 

   1

   
       String message();
   
       @ConfigProperty(defaultValue = "!")
       String getSuffix(); 

   2

   
   
       Optional<String> getName(); 

   3

   
   }

   Copy to Clipboard Toggle word wrap

   1

   您必须设置 @ConfigProperty 注释，因为配置属性的名称不遵循 getter 方法命名约定。

   2

   在本例中，没有设置 name，因此对应的属性将为 greeting.suffix。

   3

   您不需要指定 @ConfigProperty 注释，因为方法名称遵循 getter 方法命名约定(greeting.name 作为对应属性)，且不需要默认值。

3. 使用 @Inject 注解将 GreetingConfiguration 类注入 GreetingResource 类：

   src/main/java/org/acme/config/GreetingResource.java

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

   Copy to Clipboard Toggle word wrap

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

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   重要

   如果没有为类属性提供值，应用程序无法编译，您会收到 javax.enterprise.inject.spi.DeploymentException，它表示缺失的值。这不适用于带有 默认值的 Optional 字段和字段。

5. 在新终端窗口中输入以下命令来验证端点是否返回消息：

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

6. 您会收到以下信息：

   hello quarkus!

   Copy to Clipboard Toggle word wrap
7. 按 CTRL+C 停止应用程序。