設定リファレンスガイド

システムプロパティーは、起動時に -D フラグを介してアプリケーションに渡すことができます。次の例では、値 youshallnotpass を属性 quarkus.datasource.password に割り当てます。

dev モードの場合、このファイルはプロジェクトのルートに置くことができますが、バージョン管理を選択 しない ことが推奨されます。

Quarkus アプリケーション設定ファイルは、クラスパスリソース (たとえば、src/main/resources/application.properties、src/test/resources/application.properties) から、または application.properties エントリーが含まれる jar 依存関係から読み込まれます。見つかった各 application.properties は個別の ConfigSource として扱われ、他のすべてのソースと同じルールに従います (プロパティーごとのオーバーライド)。さらに、設定ファイルは $PWD/config/application.properties に存在する場合もあります。読み込みは config フォルダーから始まり、次にクラスパスの順序になります (アプリケーションソース内の application.properties ファイルがクラスローダー読み込み順序で優先されます)。

src/main/resources/META-INF/microprofile-config.properties にある MicroProfile Config 設定ファイル。

Quarkus は、他の設定フォーマットとストアをカバーする追加のエクステンションを提供します。

プロパティーが (defaultValue 属性を介して) デフォルト値に関連付けられており、プロパティーに設定値が指定されていない場合、javax.enterprise.inject.spi.DeploymentException をスローせずにデフォルト値が使用されます。defaultValue の値は String として表され、設定値の処理に使用されるのと同じ変換メカニズムを使用します。プリミティブ、ボックス化されたプリミティブ、およびその他のクラス用に、いくつかの組み込みコンバーターがすでに存在します。以下に例を示します。

As you might expect, these converters are org.eclipse.microprofile.config.spi.Converter implementations. Therefore, these converters comply with the Microprofile or custom implementation providers expression rules like:

Optional* タイプと defaultValue 属性の組み合わせが使用される場合、定義された defaultValue が引き続き使用され、プロパティーに値が指定されていない場合、Optional* が存在し、変換されたデフォルト値が入力されることに注意してください。ただし、プロパティーが明示的に空の場合、デフォルト値は使用されず、Optional は空になります。この例を考えてみましょう。

この場合、greeting.name は上記の Optional* になるように設定されているため、対応するプロパティー値は空の Optional になり、実行は通常どおり続行されます。これは、デフォルト値が設定されている場合でも当てはまります。プロパティーが設定で明示的にクリアされている場合、デフォルト値は 使用されません。

一方、以下の例では、

起動時に java.util.NoSuchElementException: SRCFG02004: Required property greeting.message not found が発生し、デフォルト値は割り当てられません。

以下は、Quarkus が提供するコンバーターの例です。

同じ名前のプロパティーを設定できるようにするには、各プロパティーは、%{profile-name}.config.name の構文で、プロファイル名とドット . の前にパーセント記号 % を付ける必要があります。

Quarkus HTTP ポートは 9090 になります。dev プロファイルがアクティブな場合、8181 になります。

.env ファイルのプロファイルは構文 _{PROFILE}_CONFIG_KEY=value に従います。

プロファイルが特定の属性の値を定義していない場合、デフォルト (プロファイルなし) の値が使用されます。

dev プロファイルを有効にすると、プロパティー bar の値は hallo になりますが、プロパティー baz の値は bonjour になります。prod プロファイルが有効になっている場合、bar の値は hello (` prod` プロファイルには特定の値がないため) であり、baz の値は bonjour です。

デフォルトでは、Quarkus は 3 つのプロファイルを提供し、特定の条件で自動的にアクティブになります。

追加のプロファイルを作成し、quarkus.profile 設定プロパティーを使用してそれらをアクティブ化することもできます。新しいプロファイル名を持つ単一の設定プロパティーが唯一の要件です。

quarkus.profile を staging に設定すると、staging プロファイルがアクティブになります。

この場合、特定のプロファイルのプロパティは、 application-{profile}.properties という名前のファイルに格納されます。先ほどの例は次のように表現できます。

親プロファイルは、現在のプロファイルに 1 レベルの階層を追加します。設定 quarkus.config.profile.parent は、単一のプロファイル名を受け入れます。

親プロファイルがアクティブなときに、現在アクティブなプロファイルにプロパティーが見つからない場合、設定ルックアップは親プロファイルにフォールバックします。以下の例を考えてみます。

この場合、

デフォルトの Quarkus 実行時プロファイルは、アプリケーションのビルドに使用されるプロファイルに設定されます。

プロパティー式は環境変数でも機能します。

これは HOST 環境変数を展開し、HOST が設定されていない場合は、プロパティー remote.host の値をデフォルト値として使用します。

Quarkusの設定の中には、ビルド時にのみ有効になるものがあり、実行時に変更することはできません。これらの設定は実行時でも利用可能ですが、読み取り専用であり、Quarkusの動作には影響しません。これらの設定を変更するには、そのようなプロパティの変更を反映させる場合、アプリケーション自体を再ビルドする必要があります。

しかし、いくつかのエクステンションは 実行時にオーバーライド可能な プロパティーを定義しています。定型的な例としては、データベースの URL、ユーザー名とパスワードがあります。これはターゲット環境によって定まるものであり、実行時にセットされ、アプリケーションの動作に影響を与えるものです。