使用属性文件配置红帽构建的 Quarkus 应用程序

流程

1. 验证 Maven 是否使用 OpenJDK 11 或 17，并且 Maven 版本是否为 3.8.6 或更高版本：

   mvn --version

   Copy to Clipboard Toggle word wrap

2. 如果 mvn 命令没有返回 OpenJDK 11 或 17，请确保在系统上安装 OpenJDK 11 或 17 的目录包含在 PATH 环境变量中：

   export PATH=$PATH:<path_to_JDK>

   Copy to Clipboard Toggle word wrap

3. 输入以下命令来生成项目：

   mvn com.redhat.quarkus.platform:quarkus-maven-plugin:3.2.12.SP1-redhat-00003:create \
       -DprojectGroupId=org.acme \
       -DprojectArtifactId=config-quickstart \
       -DplatformGroupId=com.redhat.quarkus.platform \
       -DplatformVersion=3.2.12.SP1-redhat-00003 \
       -DclassName="org.acme.config.GreetingResource" \
       -Dpath="/greeting"
   cd config-quickstart

   Copy to Clipboard Toggle word wrap

流程

1. 打开 src/main/resources/application.properties 文件。

2. 在您的配置文件中添加配置属性，其中 &lt ;property_name& gt; 是属性 name，< value> 是属性值：

   <property_name>=<value>

   Copy to Clipboard Toggle word wrap

   以下示例演示了如何在 Quarkus config-quickstart 项目中为 greeting.message 和 greeting.name 属性设置值：

   application.properties 文件示例

   greeting.message = hello
   greeting.name = quarkus

   Copy to Clipboard Toggle word wrap

   重要

   当您配置应用程序时，请不要使用字符串 quarkus 为特定于应用程序的属性添加前缀。quarkus 前缀被保留在框架级别上配置 Quarkus。使用 quarkus 作为应用程序特定属性的前缀，可能会导致应用程序运行时出现意外结果。

3. 查看项目中的 GreetingResource.java 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 {
   
       String message;
       Optional<String> name;
       String suffix;
   
   
       @GET
       @Produces(MediaType.TEXT_PLAIN)
       public String hello() {
           return message + " " + name.orElse("world") + suffix;
       }
   }

   Copy to Clipboard Toggle word wrap

   在提供的示例中，hello （） 方法中的 message 和 name string 的值不会被初始化。当调用端点并在此状态成功启动时，应用会抛出 NullPointerException。

4. 定义 消息、name 和 suffix 字段，并使用 @ConfigProperty 标注，与您为 greeting.message 和 greeting .name 属性定义 的值匹配。使用 @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") 

   1

   
     String message;
   
     @ConfigProperty(name = "greeting.suffix", defaultValue="!") 

   2

   
     String suffix;
   
     @ConfigProperty(name = "greeting.name")
     Optional<String> name; 

   3

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

   Copy to Clipboard Toggle word wrap

   1

   如果您没有为 greeting.message 字符串配置值，应用程序会失败并抛出以下异常： jakarta.enterprise.inject.spi.DeploymentException: io.quarkus.runtime.configuration.ConfigurationException: Failed to load config value of type class java.lang.String for: greeting.message

   2

   如果没有为 greeting.suffix 配置值，则 Quarkus 会将它解析为默认值。

   3

   如果您没有定义 greeting.name 属性，则 name 的值不可用。即使这个值不可用，您的应用程序仍会运行，因为您在 名称 上设置 Optional 参数。

   注意

   要注入配置的值，您可以使用 @ConfigProperty。您不需要为使用 @ConfigProperty 标注的成员包含 @Inject 注释。

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

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

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

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

   这个命令返回以下输出：

   hello quarkus!

   Copy to Clipboard Toggle word wrap
7. 要停止应用程序，请按 Ctrl+C。

流程

1. 打开 GreetingResourceTest.java 文件。

2. 更新 testHelloEndpoint 方法的内容：

   package org.acme.config;
   
   import io.quarkus.test.junit.QuarkusTest;
   import org.junit.jupiter.api.Test;
   
   import static io.restassured.RestAssured.given;
   import static org.hamcrest.CoreMatchers.is;
   
   @QuarkusTest
   public class GreetingResourceTest {
   
       @Test
       public void testHelloEndpoint() {
           given()
             .when().get("/greeting")
             .then()
                .statusCode(200)
                .body(is("hello quarkus!")); // Modified line
       }
   
   }

   Copy to Clipboard Toggle word wrap

流程

1. 要打包 Quarkus 项目，请输入以下命令：

   ./mvnw clean package

   Copy to Clipboard Toggle word wrap

2. 使用以下方法之一设置配置属性：

   • 设置系统属性：

     输入以下命令，其中 &lt ;property_name > 是您要添加的配置属性的名称，&lt ;value > 是属性值：

     java -D<property_name>=<value> -jar target/myapp-runner.jar

     Copy to Clipboard Toggle word wrap

     例如，要设置 quarkus.datasource.password 属性的值，请输入以下命令：

     java -Dquarkus.datasource.password=youshallnotpass -jar target/myapp-runner.jar

     Copy to Clipboard Toggle word wrap

   • 设置环境变量：

     输入以下命令，其中 &lt ;property_name > 是您要设置的配置属性的名称，&lt ;value > 是属性值：

     export <property_name>=<value> ; java -jar target/myapp-runner.jar

     Copy to Clipboard Toggle word wrap
     注意

     环境变量名称遵循 Eclipse MicroProfile 的转换规则。将名称转换为大写，并将不是字母数字字符的任何字符替换为下划线(_)。

   • 使用环境文件：

     在当前工作目录中创建 .env 文件并添加配置属性，其中 < PROPERTY_NAME& gt; 是属性 name，&lt ;value > 是属性值：

     <PROPERTY_NAME>=<value>

     Copy to Clipboard Toggle word wrap
     注意

     在开发模式中，此文件位于项目的根目录中。不要跟踪版本控制中的文件。如果您在项目的根目录中创建 .env 文件，您可以定义程序读取为属性的键和值。

   • 使用 application.properties 文件：

     将配置文件放在运行应用程序的 $PWD/config/application.properties 目录中，以便该文件中定义的任何运行时属性都覆盖默认配置。

     注意

     您还可以在开发模式中使用 config/application.properties 功能。将 config/application.properties 文件放在 目标 目录中。来自构建工具的任何清理操作（例如 mvn clean ）也会删除 配置目录。

流程

1. 打开 Java 资源文件并添加以下导入语句：

   import io.quarkus.runtime.configuration.ProfileManager;

   Copy to Clipboard Toggle word wrap

2. 要显示当前的配置配置集，通过调用 ProfileManager.getActiveProfile （） 方法来添加日志：

   LOGGER.infof("The application is starting with profile `%s`", ProfileManager.getActiveProfile());

   Copy to Clipboard Toggle word wrap
   注意

   您不能使用 @ConfigProperty ("quarkus.profile") 方法访问当前的配置文件。

流程

1. 在项目中创建一个类文件，它将实施 org.eclipse.microprofile.config.spi.ConfigSourceProvider 接口。要返回 ConfigSource 对象列表，您必须覆盖 getConfigSources （） 方法。

   Example org.acme.config.InMemoryConfigSourceProvider

   package org.acme.config;
   
   import org.eclipse.microprofile.config.spi.ConfigSource;
   import org.eclipse.microprofile.config.spi.ConfigSourceProvider;
   
   import java.util.List;
   
   public class InMemoryConfigSourceProvider implements ConfigSourceProvider {
   
       @Override
       public Iterable<ConfigSource> getConfigSources(ClassLoader classLoader) {
       return List.of(new InMemoryConfigSource());
       }
   }

   Copy to Clipboard Toggle word wrap

2. 创建实现 org.eclipse.microprofile.config.spi.ConfigSource 接口的 InMemoryConfigSource 类：

   Example org.acme.config.InMemoryConfigSource

   package org.acme.config;
   
   import org.eclipse.microprofile.config.spi.ConfigSource;
   
   import java.util.HashMap;
   import java.util.Map;
   import java.util.Set;
   
   public class InMemoryConfigSource implements ConfigSource {
   private static final Map<String, String> configuration = new HashMap<>();
   
   
     static {
         configuration.put("my.prop", "1234");
     }
   
       @Override
       public int getOrdinal() { 

   1

   
         return 275;
       }
   
       @Override
       public Set<String> getPropertyNames() {
         return configuration.keySet();
       }
   
       @Override
       public String getValue(final String propertyName) {
         return configuration.get(propertyName);
       }
   
       @Override
       public String getName() {
         return InMemoryConfigSource.class.getSimpleName();
       }
   }

   Copy to Clipboard Toggle word wrap

   1

   getOrdinal （） 方法返回 ConfigSource 类的优先级。因此，当多个配置源定义相同的属性时，Quarkus 可以选择由具有最高优先级的 ConfigSource 类定义的相应值。

3. 在项目的 src/main/resources/META-INF/services/ 子目录中，创建一个名为 org.eclipse.microprofile.config.spi.ConfigSourceProvider 的文件，并在您创建的文件中输入实施 ConfigSourceProvider 的完全限定名称：

   org.eclipse.microprofile.config.spi.ConfigSourceProvider 文件示例：

   org.acme.config.InMemoryConfigSourceProvider

   Copy to Clipboard Toggle word wrap

   要确保在编译和启动应用程序时注册并安装您创建的 ConfigSourceProvider，您必须完成上一步。

4. 编辑项目中的 GreetingResource.java 文件，以添加以下更新：

   @ConfigProperty(name="my.prop") int value;

   Copy to Clipboard Toggle word wrap

5. 在 GreetingResource.java 文件中，扩展 hello 方法以使用新属性：

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

   Copy to Clipboard Toggle word wrap

6. 要以开发模式编译并启动应用程序，请输入以下命令：

   ./mvnw quarkus:dev

   Copy to Clipboard Toggle word wrap

7. 要验证 /greeting 端点是否返回预期的消息，请打开终端窗口并输入以下命令：

   请求示例

   curl http://localhost:8080/greeting

   Copy to Clipboard Toggle word wrap

8. 当应用程序成功读取自定义配置时，命令会返回以下响应：

   hello world 1234

   Copy to Clipboard Toggle word wrap

流程

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
   注意

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