第6章 設定プロパティーの設定

デフォルトでは、Quarkus は src/main/resources ディレクトリーにある application.properties ファイルからプロパティーを読み取ります。ビルドプロパティーを変更する場合は、アプリケーションを必ず再パッケージしてください。

Quarkus はビルド時にほとんどのプロパティーを設定します。エクステンションはプロパティーを実行時に上書き可能であると定義できます (例: データベース URL、ユーザー名、ターゲット環境に固有のパスワード)。

前提条件

  • Quarkus Maven プロジェクトがある。

手順

  1. Quarkus プロジェクトをパッケージ化するには、以下のコマンドを入力します。 

    ./mvnw clean package

  2. 以下のメソッドのいずれかを使用して、設定プロパティーを設定します。

    • システムプロパティーの設定

      以下のコマンドを入力します。<key> は追加する設定プロパティーの名前に、<value> はプロパティーの値に置き換えます。 

      java -D<key>=<value> -jar target/myapp-runner.jar

      たとえば、quarkus.datasource.password プロパティーの値を設定するには、以下のコマンドを入力します。 

      java -Dquarkus.datasource.password=youshallnotpass -jar target/myapp-runner.jar

    • 環境変数の設定

      以下のコマンドを入力します。<key> は設定する設定プロパティーの名前に、<value> はプロパティーの値に置き換えます。 

      export <key>=<value> ; java -jar target/myapp-runner.jar
      注記

      環境変数名は、Eclipse MicroProfile の変換ルールに従います。名前を大文字に変換し、英数字以外の文字をすべてアンダースコア (_) に置き換えます。

    • 環境ファイルの使用

      現在の作業ディレクトリーに .env ファイルを作成し、設定プロパティーを追加します。<PROPERTY_KEY> はプロパティー名に、<value> はプロパティーの値に置き換えます。 

      <PROPERTY_KEY>=<value>
      注記

      開発モードでは、このファイルはプロジェクトの root ディレクトリーに置かれますが、バージョン管理でファイルを追跡しないことが推奨されます。プロジェクトのルートディレクトリーに .env ファイルを作成する場合は、プログラムがプロパティーとして読み取るキーおよび値を定義できます。

    • application.properties ファイルを使用します。

      アプリケーションが実行される $PWD/config/application.properties ディレクトリーに設定ファイルを配置し、そのファイルに定義されたランタイムプロパティーがデフォルト設定を上書きできるようにします。

      注記

      開発モードで config/application.properties 機能を使用することもできます。config/application.properties を target ディレクトリーに配置します。ビルドツールからのクリーニング操作 (例: mvn clean) は、config ディレクトリーも削除します。