バージョン:

YAML configuration

標準の Java プロパティファイル application.properties の代わりに、YAML ファイル application.yaml を使って Quarkus アプリケーションを設定することもできます。

YAML は、特にKubernetesでリソース記述子を定義するために広く使用されています。

YAML設定の有効化

YAML設定を有効にするには、 quarkus-config-yaml エクステンションを追加します。

CLI

quarkus extension add 'quarkus-config-yaml'

Maven

./mvnw quarkus:add-extension -Dextensions='quarkus-config-yaml'

Gradle

./gradlew addExtension --extensions='quarkus-config-yaml'

あるいは、以下の依存関係をプロジェクトに追加してください：

pom.xml

<dependency>
    <groupId>io.quarkus</groupId>
    <artifactId>quarkus-config-yaml</artifactId>
</dependency>

build.gradle

implementation("io.quarkus:quarkus-config-yaml")

エクステンションまたは依存関係を追加した後、混乱を避けるために、 src/main/resources/application.properties ファイルを削除し、 src/main/resources/application.yaml ファイルを作成します。

If both files are present, Quarkus gives precedence to properties in the YAML file.

Quarkus recognizes both .yml and .yaml file extensions.

YAML 設定例

次のスニペットは YAML 設定の例です：

# YAML supports comments
quarkus:
  datasource:
    db-kind: postgresql
    jdbc:
      url: jdbc:postgresql://localhost:5432/some-database

# REST Client configuration property
quarkus:
  rest-client:
    org.acme.rest.client.ExtensionsService:
      url: https://stage.code.quarkus.io/api

# For configuration property names that use quotes, do not split the string inside the quotes
quarkus:
  log:
    category:
      "io.quarkus.category":
        level: INFO

quarkus:
  datasource:
    url: jdbc:postgresql://localhost:5432/quarkus_test

  hibernate-orm:
    database:
      generation: drop-and-create

  oidc:
    enabled: true
    auth-server-url: http://localhost:8180/auth/realms/quarkus
    client-id: app


app:
  frontend:
    oidc-realm: quarkus
    oidc-app: app
    oidc-server: http://localhost:8180/auth

# With profiles
"%test":
   quarkus:
     oidc:
       enabled: false
     security:
        users:
            file:
              enabled: true
              realm-name: quarkus
              plain-text: true

プロファイル

As you can see in the previous snippet, you can use profiles in YAML.

YAML において、 % で始まるキーは許されません。しかし、プロファイルキーはこのシンボルで始めなければなりません。 "%test" これを解決するには、プロファイルキーを二重引用符で囲みます。

"%test" キーの下にあるすべての設定は、 test プロファイルが有効になっているときにのみ有効になります。例えば、前述のスニペットでは、 test プロファイルが有効な場合、OpenID Connect (OIDC) ( quarkus.oidc.enabled: false ) は無効になっています。 test プロファイルがない場合、OIDC はデフォルトで有効になります。

以下の例の %staging のように、カスタムプロファイルを定義することもできます：

quarkus:
  http:
    port: 8081

"%staging":
    quarkus:
        http:
          port: 8082

staging プロファイルを有効にすると、HTTP ポートは 8081 ではなく 8082 に設定されます。

YAML 設定はプロファイル対応ファイルもサポートします。この場合、特定のプロファイルのプロパティは application-{profile}.yaml という名前のファイルに保存できます。先程の例は次のように表現できます：

quarkus:
  http:
    port: 8081

application-staging.yaml

quarkus:
  http:
    port: 8082

式

YAML フォーマットは Java プロパティと同じフォーマットを使うことでプロパティ式もサポートします：

mach: 3
x:
  factor: 2.23694

display:
  mach: ${mach}
  unit:
    name: "mph"
    factor: ${x.factor}

${x.factor} のように、 . （ドット）セパレーターを用いることで、入れ子になったプロパティを参照することができます。

外部application.yamlファイル

application.yaml ファイルは、実行時設定を特殊化するために config/application.yaml に置くこともできます。このファイルはQuarkusアプリケーション・ランナーに相対する作業ディレクトリのルートに存在しなければなりません：

.
├── config
│    └── application.yaml
├── my-app-runner

このファイルの値は、通常の application.yaml ファイルが存在する場合、そのファイルの値を上書きします。

設定キーの競合

The MicroProfile Config specification defines configuration keys as an arbitrary .-delimited string. However, structured formats such as YAML only support a subset of the possible configuration namespace. For example, consider the two configuration properties quarkus.http.cors and quarkus.http.cors.methods. One property is the prefix of another, so it might not be immediately evident how to specify both keys in your YAML configuration.

これは ~ を null キーとして使い、他のプロパティのプレフィックスである YAML プロパティを表すことで解決されます：

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

YAML null keys are not included in the assembly of the configuration property name, allowing them to be used at any level for disambiguating configuration keys.