Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

使用 YAML 文件配置 Quarkus 应用程序

Red Hat build of Quarkus 2.13

摘要

本指南论述了如何使用 YAML 文件配置红帽构建的 Quarkus 应用程序。

第 1 章 使用 YAML 文件配置 Quarkus 应用程序
复制链接

作为应用程序开发人员，您可以使用 Red Hat build of Quarkus 创建使用 Java 编写的基于微服务的应用程序，这些应用程序在 OpenShift Container Platform 和无服务器环境中运行。编译到原生可执行文件的应用程序具有较少的内存占用率和快速启动时间。

通过更新 application.yaml 文件来配置 Quarkus 应用程序来应用结构化配置。

注意

另外，您可以通过在 application.properties 文件中设置属性来配置 Quarkus 应用程序。如需更多信息，请参阅设置配置属性。

该流程包括使用 Quarkus config-quickstart exercise 创建的配置示例。

先决条件

1.1. 红帽配置选项
复制链接

配置选项允许您在单个配置文件中更改应用程序的设置。Red Hat build of Quarkus 支持用于对相关属性进行分组的配置文件，并根据需要在配置集间切换。

默认情况下，Quarkus 从 src/main/resources 目录中的 application.properties 文件中读取属性。您还可以将 Quarkus 配置为从 YAML 文件中读取属性。

当您将 quarkus-config-yaml 依赖项添加到项目 pom.xml 文件时，您可以在 application.yaml 文件中配置和管理应用程序属性。如需更多信息，请参阅 添加 YAML 配置支持。

红帽构建的 Quarkus 还支持 MicroProfile Config，它可让您从其他来源加载应用的配置。

您可以使用 Eclipse MicroProfile 项目的 MicroProfile Config 规范将配置属性注入到应用中，并使用代码中定义的方法访问它们。

Quarkus 也可以从不同的来源读取应用程序属性，包括以下源：

  • 文件系统
  • 数据库
  • Kubernetes 或 OpenShift Container Platform ConfigMap 或 Secret 对象
  • Java 应用程序可以加载的任何源

1.2. 添加 YAML 配置支持
复制链接

红帽构建的 Quarkus 通过 Eclipse MicroProfile Config 的 SmallRye Config 实现支持 YAML 配置文件。您可以添加 Quarkus Config YAML 扩展，并在属性文件中使用 YAML 配置文件进行配置。Quarkus 支持使用 application.yml 和 application.yaml 作为 YAML 文件的名称。

YAML 配置文件优先于 application.properties 文件。要避免错误，您可以删除 application.properties 文件，并仅使用一种配置文件。

流程

  1. 使用以下方法之一在项目中添加 YAML 扩展：

    • 打开 pom.xml 文件，将 quarkus-config-yaml 扩展添加为依赖项：

      pom.xml 文件示例

      <dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-config-yaml</artifactId>
</dependency>
      Copy to Clipboard Toggle word wrap

    • 要从命令行添加 quarkus-config-yaml 扩展，请在项目目录中输入以下命令：

      添加 quarkus-config-yaml 扩展

      ./mvnw quarkus:add-extension -Dextensions="quarkus-config-yaml"
      Copy to Clipboard Toggle word wrap

1.2.1. 将嵌套对象配置与 YAML 搭配使用
复制链接

您可以在已经存在的类中定义嵌套类。此流程演示了如何通过使用 YAML 格式的配置文件来为 Quarkus 应用程序设置嵌套配置属性。

先决条件

  • 您有一个 Quarkus Maven 项目。
  • 您有一个 PostgreSQL 数据源。

  • 在项目的 pom.xml 文件中有以下扩展作为依赖项：

    • quarkus-rest-client
    • quarkus-jdbc-postgresql
    • quarkus-config-yaml

流程

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

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

    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 配置文件中的属性。YAML 不允许将标签页用于缩进。

1.2.2. 使用 YAML 设置自定义配置配置集
复制链接

使用 Quarkus，您可以设置特定于应用程序不同配置配置集的配置属性和值。您可以使用特定的配置文件启动应用程序，以访问特定的配置。此流程演示了如何以 YAML 格式为特定配置集提供配置。

先决条件

  • 您有一个 Quarkus Maven 项目，它配置为使用带有 JDBC 数据源驱动程序的 PostgreSQL 数据源
  • 您有 quarkus-jdbc-postgresql 和 quarkus-config-yaml 扩展作为项目的 pom.xml 文件中的依赖项

流程

  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.3. 属性表达式
复制链接

属性表达式是属性引用和纯文本字符串的组合，可用于替换配置中属性值。

与变量一样，您可以使用 Quarkus 中的属性表达式来替换配置属性的值，而不是硬编码。当 java.util.Properties 从应用中的配置源读取属性值时，属性表达式会被解析。

这意味着，如果在编译时从配置中读取配置属性，则属性表达式也会在编译时解析。如果在运行时覆盖配置属性，则其值会在运行时解析。

您可以使用多个配置源解析属性表达式。这意味着，您可以使用一个配置源中定义的属性值来扩展您在另一个配置源中使用的属性表达式。

如果表达式中的属性值无法解析，并且您没有为表达式设置默认值，则应用会遇到 NoSuchElementException。

1.3.1. 使用 YAML 文件的属性表达式的使用示例
复制链接

本节展示了如何使用属性表达式在配置 Quarkus 应用程序时实现灵活性的示例。

注意

您可以使用 {x.factor} 中的 . (dot)分隔符来引用嵌套属性。

application.yaml 文件示例

mach: 3
x:
  factor: 2.23694

display:
  mach: ${mach}
  unit:
    name: "mph"
    factor: ${x.factor}
Copy to Clipboard Toggle word wrap

要在运行时配置应用程序属性，请将 application.yaml 文件添加到 config 目录中。

注意

config/application.yaml 文件中的值如果存在，则覆盖常规 application.yaml 文件中的任何值。

确保 config/application.yaml 文件位于相对于 Quarkus 应用程序运行程序的工作目录的根目录中，如下例所示： 

├── config
│    └── application.yaml
├── my-app-runner
Copy to Clipboard Toggle word wrap

1.5. 管理配置键冲突
复制链接

结构化格式，如 YAML 只支持可能配置命名空间的子集。以下流程演示了如何在两个配置属性 quarkus.http.cors 和 quarkus.http.cors.methods 之间解决冲突，其中一个属性是另一个属性的前缀。

先决条件

  • 您有一个 Quarkus 项目，它被配置为读取 YAML 配置文件。

流程

  1. 打开 YAML 配置文件。

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

    YAML 属性作为前缀的定义示例

    quarkus:
  http:
    cors:
      ~: true
      methods: GET,PUT,POST
    Copy to Clipboard Toggle word wrap

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

    编译 Quarkus 应用程序

    ./mvnw quarkus:dev
    Copy to Clipboard Toggle word wrap

    [NOTE

您可以在任何级别上将 YAML 键用于冲突的配置键，因为它们没有包含在配置属性名称的装配中。

法律通告
复制链接

Copyright © 2024 Red Hat, Inc.
The text of and illustrations in this document are licensed by Red Hat under a Creative Commons Attribution–Share Alike 3.0 Unported license ("CC-BY-SA"). An explanation of CC-BY-SA is available at http://creativecommons.org/licenses/by-sa/3.0/. In accordance with CC-BY-SA, if you distribute this document or an adaptation of it, you must provide the URL for the original version.
Red Hat, as the licensor of this document, waives the right to enforce, and agrees not to assert, Section 4d of CC-BY-SA to the fullest extent permitted by applicable law.
Red Hat, Red Hat Enterprise Linux, the Shadowman logo, the Red Hat logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.
Linux® is the registered trademark of Linus Torvalds in the United States and other countries.
Java® is a registered trademark of Oracle and/or its affiliates.
XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.
MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.
Node.js® is an official trademark of Joyent. Red Hat is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.
The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation's permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.
All other trademarks are the property of their respective owners.
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2026 Red Hat返回顶部