配置 Quarkus 应用程序

流程

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

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

   import java.util.Optional;
   import javax.inject.Inject;

   Copy to Clipboard Toggle word wrap

2. 在 src/main/java/org/acme/config 目录中创建一个文件 GreetingConfiguration.java。

3. 将 ConfigProperties 和 Optional 导入添加到 GreetingConfiguration.java 文件中：

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

   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;
   import javax.inject.Inject;

   Copy to Clipboard Toggle word wrap

4. 为 GreetingConfiguration.java 文件中的 问候 属性创建一个 GreetingConfiguration 类：

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

   @ConfigProperties(prefix = "greeting") 

   1

   
   public class GreetingConfiguration {
   
       private String message;
       private String suffix = "!"; 

   2

   
       private Optional<String> name;
   
       public String getMessage() {
           return message;
       }
   
       public void setMessage(String message) {
           this.message = message;
       }
   
       public String getSuffix() {
           return suffix;
       }
   
       public void setSuffix(String suffix) {
           this.suffix = suffix;
       }
   
       public Optional<String> getName() {
           return name;
       }
   
       public void setName(Optional<String> name) {
           this.name = name;
       }
   }

   Copy to Clipboard Toggle word wrap

   1

   prefix 是可选的。如果没有指定前缀，它由类的名称决定。在本例中，前缀为 greeting。

   2

   如果没有设置 greeting.suffix，! 是默认值。

5. 使用 @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.getMessage() + " " + config.getName().orElse("world") + config.getSuffix();
       }
   }

   Copy to Clipboard Toggle word wrap

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

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   重要

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

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

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. 您会收到以下信息：

   hello quarkus!

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

流程

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

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

   import io.quarkus.arc.config.ConfigProperties;
   import java.util.Optional;
   import java.util.List;

   Copy to Clipboard Toggle word wrap

2. 使用 @ConfigProperties 注释在 GreetingConfiguration.java 文件中添加配置。

   以下示例显示了 GreetingConfiguration 类及其属性的配置：

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

   @ConfigProperties(prefix = "greeting")
   public class GreetingConfiguration {
   
       public String message;
       public String suffix = "!";
       public Optional<String> name;
   }

   Copy to Clipboard Toggle word wrap

3. 在 GreetingConfiguration 类中添加一个嵌套类，如下例所示：

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

   @ConfigProperties(prefix = "greeting")
   public class GreetingConfiguration {
   
       public String message;
       public String suffix = "!";
       public Optional<String> name;
       public ContentConfig content;
   
       public static class ContentConfig {
           public Integer prizeAmount;
           public List<String> recipients;
       }
   }

   Copy to Clipboard Toggle word wrap

   本例显示了一个嵌套类 ContentConfig。字段的名称（本例中为 content ）决定了绑定到对象的属性的名称。

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

   以下示例显示了 GreetingConfiguration 和 ContentConfig 类的属性值：

   src/main/resources/application.properties

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

   Copy to Clipboard Toggle word wrap

5. 使用 @Inject 注解将 GreetingConfiguration 类注入 GreetingResource 类，并更新 /greeting 端点返回的消息字符串，显示您为新 greeting.content.prize-amount 和 greeting.content.recipients 属性设置的值：

   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.name.orElse("world") + config.suffix + "\n" + config.content.recipients + " receive total of candies: " + config.content.prizeAmount;
       }
   }

   Copy to Clipboard Toggle word wrap

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

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   重要

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

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

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. 您会收到一条信息，其中包含第一行上的问候以及第二行上的原概量：

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

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

流程

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 停止应用程序。

流程

1. 要设置自定义配置集，请在 application.properties 文件中使用配置集名称创建一个配置属性，其中 < key&gt; 是属性的名称，< value&gt; 是属性值，& lt;profile > 是配置集的名称：

    %<profile>.<key>=<value>

   Copy to Clipboard Toggle word wrap

   在以下示例中，quarkus.http.port 的值默认为 9090，当 dev 配置集被激活时会变为 8181 ：

   quarkus.http.port=9090
   %dev.quarkus.http.port=8181

   Copy to Clipboard Toggle word wrap

2. 使用以下方法之一启用配置集：

   • 设置 quarkus.profile 系统属性。

     • 要使用 quarkus.profile 系统属性启用配置集，请输入以下命令：

       mvn -Dquarkus.profile=<value> quarkus:dev

       Copy to Clipboard Toggle word wrap

   • 设置 QUARKUS_PROFILE 环境变量。

     • 要使用环境变量启用配置集，请输入以下命令：

       export QUARKUS_PROFILE=<profile>

       Copy to Clipboard Toggle word wrap
       注意

       system 属性值优先于环境变量值。

3. 要重新打包应用程序并更改配置集，请输入以下命令：

   ./mvnw package -Dquarkus.profile=<profile>
    java -jar target/myapp-runner.jar

   Copy to Clipboard Toggle word wrap

   以下示例显示了激活 prod-aws 配置集的命令：

   ./mvnw package -Dquarkus.profile=prod-aws
    java -jar target/myapp-runner.jar

   Copy to Clipboard Toggle word wrap

流程

1. 在您的服务文件中添加以下导入语句：

   package org.acme.config;
   
   import javax.annotation.Priority;
   import org.eclipse.microprofile.config.spi.Converter;

   Copy to Clipboard Toggle word wrap

2. 通过为自定义转换器添加带有 @Priority 注解的类并传递优先级值，为您的自定义转换器设置优先级：

   @Priority(150)
   public class MyCustomConverter implements Converter<MicroProfileCustomValue> {
   
       @Override
       public MicroProfileCustomValue convert(String value) {
   
           final int secretNumber;
           if (value.startsFrom("OBF:")) {
               secretNumber = Integer.valueOf(SecretDecoder.decode(value));
           } else {
               secretNumber = Integer.valueOf(value);
           }
   
           return new MicroProfileCustomValue(secretNumber);
       }
   }

   Copy to Clipboard Toggle word wrap
   注意

   如果添加新的转换器，您必须在 META-INF/services/org.eclipse.microprofile.config.spi.Converter 服务文件中列出它。

流程

1. 打开 src/main/resources/application.yaml 配置文件。

2. 在 application.yaml 文件中添加嵌套类配置属性，如下例所示：

   src/main/resources/application.yaml

   # Properties that configure the JDBC data source driver of your PostgreSQL data source
   quarkus:
     datasource:
       url: jdbc:postgresql://localhost:5432/some-database
       driver: org.postgresql.Driver
       username: quarkus
       password: quarkus
   
   # Property that configures the URL of the endpoint to which the rest client sends requests
   org:
     acme:
       restclient:
         CountriesService/mp-rest/url: https://restcountries.eu/rest
   
   # Property that configures the log message level for your application
   quarkus:
     log:
       category:
         # Do not use spaces in names of configuration properties that you place inside quotation marks
         "io.quarkus.category":
           level: INFO

   Copy to Clipboard Toggle word wrap

   请注意，您可以使用注释来描述配置属性，其方式与在 application.properties 中使用它们类似。

   注意

   始终使用空格在 YAML 配置文件中缩进属性。YAML 不允许使用标签页来缩进。

流程

1. 打开 src/main/resources/application.yaml 配置文件。

2. 要设置配置集依赖的配置，请在使用 "%<profile_name>" 语法定义键值对前添加 配置集名称。确保将配置集名称放在引号内。在 YAML 中，以特殊字符开头的所有字符串都必须放在引号内。

   在以下示例中，当您以开发模式启动 Quarkus 应用程序时，PostgreSQL 数据库被配置为位于 jdbc:postgresql://localhost:5432/some-database URL 中：

   src/main/resources/application.yaml

   "%dev":
     # Properties that configure the JDBC data source driver of your PostgreSQL data source
     quarkus:
       datasource:
         url: jdbc:postgresql://localhost:5432/some-database
         driver: org.postgresql.Driver
         username: quarkus
         password: quarkus

   Copy to Clipboard Toggle word wrap

流程

1. 打开 YAML 配置文件。

2. 要将 YAML 属性定义为另一个属性的前缀，请在属性范围内添加一个 kiosk (~)，如下例所示：

   quarkus:
     http:
       cors:
         ~: true
         methods: GET,PUT,POST

   Copy to Clipboard Toggle word wrap

3. 要将 Quarkus 应用程序编译为开发模式，请从项目目录输入以下命令：

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap
   注意

   您可以使用 YAML 密钥在任何级别上冲突配置密钥，因为它们没有包含在配置属性名称的汇编中。