第 11 章 添加 YAML 配置支持
红帽构建的 Quarkus 通过 Eclipse MicroProfile 配置的 SmallRye Config 实现支持 YAML 配置文件。您可以添加 Quarkus Config YAML 扩展,并使用 YAML over 属性进行配置。Quarkus 支持使用 application.yml 以及 application.yaml 作为 YAML 文件的名称。
YAML 配置文件优先于 application.properties 文件。推荐的方法是删除 application.properties 文件,仅使用一种配置文件来避免错误。
流程
使用以下方法之一在项目中添加 YAML 扩展:
打开
pom.xml文件,并将quarkus-config-yaml扩展添加为依赖项:<dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-config-yaml</artifactId> </dependency><dependency> <groupId>io.quarkus</groupId> <artifactId>quarkus-config-yaml</artifactId> </dependency>Copy to Clipboard Copied! Toggle word wrap Toggle overflow 要从命令行添加
quarkus-config-yaml扩展,请在项目目录中输入以下命令:./mvnw quarkus:add-extension -Dextensions="quarkus-config-yaml"
./mvnw quarkus:add-extension -Dextensions="quarkus-config-yaml"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
11.1. 使用带有 YAML 的嵌套对象配置 复制链接链接已复制到粘贴板!
您可以在已经存在的类中定义嵌套类。此流程演示了如何使用 YAML 格式的配置文件为 Quarkus 应用程序设置嵌套配置属性。
先决条件
- 具有 Quarkus Maven 项目。
- 具有 PostgreSQL 数据源。
在项目的
pom.xml文件中有以下扩展作为依赖项:-
quarkus-rest-client, -
quarkus-jdbc-postgresql -
quarkus-config-yaml
-
流程
-
打开
src/main/resources/application.yaml配置文件。 在
application.yaml文件中添加嵌套类配置属性,如下例所示:src/main/resources/application.yaml
Copy to Clipboard Copied! Toggle word wrap Toggle overflow 请注意,您可以使用注释来描述配置属性,其方式与在
application.properties中使用它们类似。注意始终使用空格在 YAML 配置文件中缩进属性。YAML 不允许使用标签页来缩进。