1.10. 使用配置配置集
您可以使用配置配置集为不同的环境定制应用程序行为。使用配置集,您可以定义多组配置值,并在运行时激活特定的集合。
Red Hat build of Quarkus 包括以下默认配置配置集:
- Dev: 在开发模式下运行时激活。
- 测试 :在运行测试时激活。
- prod :当没有以开发或测试模式运行时,默认激活。
您还可以定义和激活自定义配置配置文件。
要定义特定于配置集的配置,您可以:
-
添加以百分比符号和配置文件名称开头的属性键,如
%custom.my.property
-
创建特定于配置集的配置文件,如
application-custom.properties
要激活自定义配置集,请在运行时设置 quarkus.profile
属性。
如需更多信息 ,请参阅设置自定义配置配置集。
先决条件
- 您已创建了 Quarkus Maven 项目。
流程
-
打开项目的
src/main/resources
目录中的application.properties
文件。 使用以下方法之一添加特定于配置集的配置:
在您的属性文件中添加属性,并在
%
和 之间嵌套配置集名称作为前缀。
,如%dev.
、%test.
或%prod
。例如:%dev.quarkus.datasource.username=devuser %prod.quarkus.datasource.username=produser
%dev.quarkus.datasource.username=devuser %prod.quarkus.datasource.username=produser
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 或者,创建特定于配置集的配置文件,如
application-dev.properties
、application-test.properties
或application-prod.properties
,使其包含特定于配置集的值。application-dev.properties
示例quarkus.datasource.username=devuser
quarkus.datasource.username=devuser
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
通过将
quarkus.profile
配置选项设置为系统属性或环境变量,在运行时激活配置集:./mvnw package -Dquarkus.profile=<profile>
$ ./mvnw package -Dquarkus.profile=<profile>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 将
<profile
> 替换为一个或多个以逗号分隔的配置集名称,如dev
、test
或prod
。
1.10.1. 设置自定义配置配置集 复制链接链接已复制到粘贴板!
您可以根据需要创建任意数量的配置配置集。同一文件中可以有多个配置,您可以使用配置集名称选择配置。
流程
要设置自定义配置集,请在
application.properties
文件中使用配置集名称创建一个配置属性,其中 <property_name
> 是属性的名称,<value>
; 是属性值,<profile
> 是配置集的名称:创建配置属性
%<profile>.<property_name>=<value>
%<profile>.<property_name>=<value>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 在以下示例配置中,
quarkus.http.port
的值默认为9090
,并在激活dev
配置集时变为8181
:配置示例
quarkus.http.port=9090 %dev.quarkus.http.port=8181
quarkus.http.port=9090 %dev.quarkus.http.port=8181
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 使用以下方法之一启用配置集:
设置
quarkus.profile
系统属性。要使用
quarkus.profile
系统属性启用配置集,请输入以下命令:使用
quarkus.profile
属性启用配置集mvn -Dquarkus.profile=<value> quarkus:dev
mvn -Dquarkus.profile=<value> quarkus:dev
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
设置
QUARKUS_PROFILE
环境变量。要使用环境变量启用配置集,请输入以下命令:
使用环境变量启用配置集
export QUARKUS_PROFILE=<profile>
export QUARKUS_PROFILE=<profile>
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 注意系统属性值优先于环境变量值。
要重新打包应用程序并更改配置集,请输入以下命令:
更改配置集
./mvnw package -Dquarkus.profile=<profile> java -jar target/quarkus-app/quarkus-run.jar
./mvnw package -Dquarkus.profile=<profile> java -jar target/quarkus-app/quarkus-run.jar
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 以下示例显示了激活
prod-aws
配置集的命令:激活配置集的命令示例
./mvnw package -Dquarkus.profile=prod-aws java -jar target/quarkus-app/quarkus-run.jar
./mvnw package -Dquarkus.profile=prod-aws java -jar target/quarkus-app/quarkus-run.jar
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
默认 Quarkus 应用程序运行时配置集设置为用于构建应用程序的配置集。Red Hat build of Quarkus 会自动根据您的环境模式选择配置集。例如,当应用程序作为 JAR 运行时,Quarkus 处于 prod
模式。