Spring Bootでapplication.propertiesを外部化する方法を解説する記事のアイキャッチ。Java道場風の空間で若手エンジニアが環境変数とProfileを学ぶイラスト。

実装・エラー解決

Spring Bootの設定ファイルを外部化|locationとadditional-locationの違い

この記事でわかること

spring.config.additional-locationは既定の検索場所を残して追加し、spring.config.locationは検索場所を置き換えます。同じJARを使い、Profile・外部ファイル・環境変数・起動引数でタイムアウトが1000→2000→3000→4000→5000 msへ変わる例を確認します。外部ファイルの値が採用されても、JAR内だけの設定が残るとは限らないことを、二つの指定方法で比べます。

新人SE
新人SE
外部のapplication.propertiesを指定したら、JAR内に書いた設定まで読まれなくなりました。
ポンコツSE
ポンコツSE
spring.config.locationで、既定の検索場所を置き換えていないか確認します。外部ファイルを足したいだけならspring.config.additional-locationです。同じJARで違いを試しましょう。

DB接続先、外部APIのURL、タイムアウトなどを環境ごとに変えるため、application.propertiesをJARの外へ置くことがあります。ただし、ファイルを指定する起動引数が違うと、JAR内の設定を残すつもりでも読まれなくなります。設定ファイルが見つかったことと、必要な設定がすべて読み込まれたことは分けて確認します。

この記事では、まず環境変数・Profile・標準の外部設定ファイルを使う方法を押さえ、locationとadditional-locationの違いを確認します。優先順位は同じJARのタイムアウト値で比較し、JVMの-Dを置く位置も試します。DBや外部APIには接続せず、配布サンプルの設定値だけで再現できます。

同じJARで手作業とサービス起動の値が違うときは、作業ディレクトリと設定ファイルの配置を確認します。外部ファイルが反映されないときは、設定を渡す場所とディレクトリー末尾の/も確認します。同じJARで失敗と修正を試すこともできます。複数のProfileで想定外の値になるときは、外部フォルダーの区切りとProfileの順番を確認します。

設定ファイルの中から別のファイルを読む場合は、spring.config.importの相対パスの基準を確認します。

この記事のポイント

  • 既定の設定を残して外部ファイルを足すならadditional-locationを使う
  • 秘密情報はGit管理する設定ファイルへ入れない
  • Profileは環境別の共通設定、環境変数は実行時の値に向く
  • 同じJARのタイムアウト値と識別値で、優先順位と読み込まれた設定を確かめる

なぜ設定を外部化するのか

設定をJavaコードやjar内だけへ固定すると、値を変えるたびにビルドと再配布が必要です。また、本番パスワードを誤ってGitへコミットすると、履歴から削除する作業まで発生します。

// 避ける: 環境固有値と秘密情報の直書き
String url = "jdbc:postgresql://prod-db:5432/orderdb";
String username = "order_user";
String password = "production-password";

同じjarを開発、検証、本番へ配置し、環境側の設定だけを変えられる構成なら、成果物の取り違えも減らせます。設定値の変更権限を、開発者と運用担当で分けることも可能になります。

方法1: 環境変数から値を受け取る

properties内でプレースホルダーを使うと、OSやコンテナの環境変数から値を受け取れます。

spring.datasource.url=${DB_URL}
spring.datasource.username=${DB_USERNAME}
spring.datasource.password=${DB_PASSWORD}

external.payment.base-url=${PAYMENT_API_URL}
external.payment.timeout=${PAYMENT_API_TIMEOUT:3000}

${PAYMENT_API_TIMEOUT:3000}の3000は、環境変数がない場合の既定値です。タイムアウトのように安全な既定値を持てる設定には便利ですが、DBパスワードのような必須値へ安易な初期値を付けるべきではありません。

export DB_URL='jdbc:postgresql://localhost:5432/orderdb'
export DB_USERNAME='order_user'
export DB_PASSWORD='local-password'

java -jar order-app.jar

コマンド履歴やプロセス一覧へ秘密情報を残さないよう、現場の運用方式を確認してください。本番ではクラウドやコンテナ基盤のシークレット管理機能を使うこともあります。

方法2: Profileで環境別ファイルを分ける

開発、検証、本番で設定のまとまりを分けたい場合は、Profile別のファイルを使えます。

src/main/resources/
  application.properties
  application-local.properties
  application-staging.properties
  application-production.properties
# application.properties: 全環境で共通する構造
spring.application.name=order-app
external.payment.timeout=3000

# application-local.properties: ローカル向け上書き
logging.level.com.example.order=DEBUG
spring.datasource.url=jdbc:h2:mem:orderdb

Profileは環境変数や起動引数などで有効化します。

java -jar order-app.jar --spring.profiles.active=production

Profileファイルを使っても、パスワードをapplication-production.propertiesへ直書きしてGit管理すれば安全にはなりません。Profileは設定の分類であり、秘密情報を守る仕組みではない点に注意します。

方法3: jarの外にapplication.propertiesを置く

Spring Bootは、jar内の設定だけでなく、実行時のカレントディレクトリやそのconfigディレクトリなど、外部の標準的な場所から設定ファイルを読み込めます。外部設定はjar内の設定を上書きできます。

/opt/order-app/
  order-app.jar
  config/
    application.properties
cd /opt/order-app
java -jar order-app.jar

どのディレクトリをカレントとしてサービスを起動するかによって、見える設定ファイルが変わります。手作業では動くのにsystemdやジョブ管理から起動すると読めない場合は、実行ユーザー、カレントディレクトリ、ファイル権限を確認します。

同じJARでも、起動する場所で外部設定が変わる

手作業では6000ms、サービスから起動すると1000msだった場合、まず起動時の作業ディレクトリを照合します。JARを絶対パスで指定していても、標準で探す./config/application.propertiesの起点は作業ディレクトリです。

同じJARを使い、service/config/application.propertiesだけにdemo.timeout=6sを書いて比べます。

同じJARで起動場所と指定方法を変えた結果
起動する場所追加先の指定タイムアウト
service/指定なし6000ms
other/指定なし1000ms
other/相対パス+optional1000ms
other/絶対パス6000ms

other/にconfig/はありません。optional:file:./config/では設定が見つからなくても起動し、JAR内の1000msが使われました。環境変数SPRING_CONFIG_ADDITIONALLOCATIONでservice/config/の絶対パスを指定すると6000msになります。4回ともjar.marker=inside-jarが残ります。

対処は、サービスの作業ディレクトリを設定ファイルの配置に揃えるか、外部設定の場所を絶対パスで渡すことです。外部ファイルを必須にする運用なら、欠落時に起動を止める設定にします。

この記事の配布サンプルを取得し、展開したフォルダーでmvn -B packageを実行します。同じ場所で次のシェルを実行します。macOS・Linux向けです。

再現コマンドと4回の出力を見る
#!/bin/sh

(
  set -eu
  jar="$PWD/target/spring-maintenance-diagnostics-1.0.0.jar"
  work=$(mktemp -d)
  trap 'rm -rf "$work"' EXIT
  mkdir -p "$work/service/config" "$work/other"
  printf 'demo.timeout=6s\n' > "$work/service/config/application.properties"

  probe() {
    env -i PATH="$PATH" "$@" java -jar "$jar" \
      --spring.main.web-application-type=none \
      --spring.main.banner-mode=off --logging.level.root=ERROR \
      --demo.print-config=true
  }

  cd "$work/service"
  printf 'case=service-default\n'
  probe

  cd "$work/other"
  printf 'case=other-default\n'
  probe

  printf 'case=other-optional-relative\n'
  probe SPRING_CONFIG_ADDITIONALLOCATION=optional:file:./config/

  printf 'case=other-absolute\n'
  probe "SPRING_CONFIG_ADDITIONALLOCATION=file:$work/service/config/"
)
case=service-default
timeout.ms=6000
jar.marker=inside-jar
case=other-default
timeout.ms=1000
jar.marker=inside-jar
case=other-optional-relative
timeout.ms=1000
jar.marker=inside-jar
case=other-absolute
timeout.ms=6000
jar.marker=inside-jar

探索先の定義はSpring Boot 3.5の外部設定ファイル仕様を参照できます。

additional-locationとlocationの違い

標準以外の場所に設定ファイルを置く場合、spring.config.additional-locationで検索場所を追加できます。

java -jar order-app.jar \
  --spring.config.additional-location=optional:file:/etc/order-app/

optional:を付けると、その場所が存在しなくても起動を継続します。必須設定としてファイルの欠落を検知したいなら、無条件にoptionalを付けず、運用要件に合わせます。

設定動き注意点
spring.config.additional-location既定の検索場所へ追加するjar内や標準外部設定も引き続き使える
spring.config.location既定の検索場所を置き換える指定漏れで通常のapplication.propertiesを読まなくなることがある

既定設定を残して外部設定を足したいだけなら、まずadditional-locationを検討します。

配布サンプルでは、同じ外部ファイルにdemo.timeout=6sを指定して比べると、どちらもtimeout.ms=6000になります。違いはJAR内にだけあるdemo.jar-markerです。additional-locationではinside-jar、locationではabsentと表示されます。タイムアウトが期待どおりでも、JAR内の他の既定値が残っているとは限りません。次の章で、同じJARを実行してこの差を確認します。

外部ファイルが読まれないときは、指定する場所と末尾の「/」を確認する

起動するが、外部設定の値に変わらない。 spring.config.locationとspring.config.additional-locationは、Spring Bootが設定ファイルを探すときに使います。探索先は、環境変数、JVMの-D、または--spring.config.additional-locationなどの起動引数で先に渡します。同じJARでは、application.propertiesの中だけに探索先を書いた場合は既定値の1000ms、起動引数にも渡すと外部ファイルの6000msでした。

ディレクトリーを渡すと起動前に失敗する。 file:./replacement/のように、ディレクトリーの末尾に/を付けます。file:./replacementと書いた場合は、この例では設定ファイルの拡張子を判定できないというエラーになりました。optional:は設定が見つからない場合の指定です。エラーにディレクトリー末尾の案内があれば、パスの/を確認します。

環境変数で渡す場合、Spring Bootの命名規則に沿う名前はSPRING_CONFIG_ADDITIONALLOCATIONです。additional-locationのハイフンを取り除きます。この記事のSpring Boot 3.5.16では、検索でも見かけるSPRING_CONFIG_ADDITIONAL_LOCATIONも単独で試すと6000msを読みました。運用手順では、公式の命名規則で統一すると設定名を判断しやすくなります。

確認に使ったSpring Boot 3.5の設定ファイルの読み込み順と、環境変数の命名規則。

配布ZIPを展開したディレクトリーでmvn -B packageを実行し、同じディレクトリーで次のコマンドを試します。先頭2回は1000msと6000ms、最後は末尾の/を確認する起動エラーです。

jar="$PWD/target/spring-maintenance-diagnostics-1.0.0.jar"
work=$(mktemp -d)
(
  cd "$work" || exit 1
  unset DEMO_TIMEOUT SPRING_CONFIG_NAME SPRING_CONFIG_LOCATION
  unset SPRING_CONFIG_ADDITIONAL_LOCATION SPRING_CONFIG_ADDITIONALLOCATION
  unset SPRING_PROFILES_ACTIVE SPRING_APPLICATION_JSON
  mkdir replacement
  printf 'demo.timeout=6s\n' > replacement/application.properties
  printf 'spring.config.additional-location=file:./replacement/\n' > application.properties

  probe() {
    java -jar "$jar" --spring.main.web-application-type=none \
      --spring.main.banner-mode=off --logging.level.root=ERROR \
      --demo.print-config=true "$@"
  }

  probe
  probe --spring.config.additional-location=file:./replacement/
  probe --spring.config.additional-location=file:./replacement
)

spring.config.importの相対パスは、宣言したファイルが基準

起動時に additional-location で外部ファイルを一枚読み、そのファイルの中から spring.config.import で追加設定を読み込む場合です。limits.properties と書くと、importを書いたファイルの場所が基準です。この例で file:./limits.properties と書くと、起動時の作業ディレクトリーから探します。

同じJARを other/ から起動します。params/parent.properties には3秒、隣の params/limits.properties には8秒、other/limits.properties には9秒を設定し、どの値が採用されるか比べます。読み込めた設定ファイルの値は、この例ではimportを書いたファイルの3秒より優先します。

外部設定から読み込むファイルを変えた結果
importの値読む場所・条件実行結果
limits.properties宣言した設定ファイルの隣起動・8000ms
file:./limits.properties起動したディレクトリー起動・9000ms
optional:missing.propertiesファイルがない起動・3000ms
missing.propertiesファイルがない起動失敗・終了コード1
optional:invalid.propertiesファイルはある。値が不正起動失敗・終了コード1

optional: は、ファイルがなくても起動してよい場合に使います。必須のファイルがないと実習は終了コード1で止まりました。optional: 付きでも、読み込めたファイルに demo.timeout=invalid があれば時間の長さ(Duration)に変換できず、同じく起動に失敗します。

既存の配布ZIPを展開し、そのディレクトリーで mvn -B package を実行してから試せます。検証用の設定ファイルは下のシェルが一時ディレクトリーに作ります。Spring Boot 3.5.16、JDK 17、macOS・Linux向けです。

5条件を試すコマンドと出力を見る
#!/bin/sh

(
  set -eu
  jar="$PWD/target/spring-maintenance-diagnostics-1.0.0.jar"
  if [ ! -f "$jar" ]; then
    printf '%s\n' "Build the sample with mvn package first." >&2
    exit 1
  fi
  work=$(mktemp -d)
  trap 'rm -rf "$work"' EXIT
  mkdir -p "$work/params" "$work/other"

  printf '%s\n' 'demo.timeout=3s' 'spring.config.import=limits.properties' > "$work/params/parent.properties"
  printf '%s\n' 'demo.timeout=3s' 'spring.config.import=file:./limits.properties' > "$work/params/working-dir.properties"
  printf '%s\n' 'demo.timeout=3s' 'spring.config.import=optional:missing.properties' > "$work/params/optional.properties"
  printf '%s\n' 'demo.timeout=3s' 'spring.config.import=missing.properties' > "$work/params/required.properties"
  printf '%s\n' 'demo.timeout=3s' 'spring.config.import=optional:invalid.properties' > "$work/params/invalid-parent.properties"
  printf '%s\n' 'demo.timeout=8s' > "$work/params/limits.properties"
  printf '%s\n' 'demo.timeout=9s' > "$work/other/limits.properties"
  printf '%s\n' 'demo.timeout=invalid' > "$work/params/invalid.properties"

  probe() {
    env -i PATH="$PATH" java -jar "$jar" \
      "--spring.config.additional-location=file:$work/params/$1" \
      --spring.main.web-application-type=none \
      --spring.main.banner-mode=off --logging.level.root=ERROR \
      --demo.print-config=true
  }

  cd "$work/other"
  printf '%s\n' 'case=relative-import'
  probe parent.properties

  printf '%s\n' 'case=file-prefix'
  probe working-dir.properties

  printf '%s\n' 'case=optional-missing'
  probe optional.properties

  printf '%s\n' 'case=required-missing'
  if probe required.properties > "$work/required.log" 2>&1; then
    printf '%s\n' "Unexpected successful startup" >&2
    exit 1
  else
    printf 'exit=%s\n' "$?"
    grep 'does not exist' "$work/required.log"
  fi

  printf '%s\n' 'case=optional-invalid-value'
  if probe invalid-parent.properties > "$work/invalid.log" 2>&1; then
    printf '%s\n' "Unexpected successful startup" >&2
    exit 1
  else
    printf 'exit=%s\n' "$?"
    grep -F "is not a valid duration" "$work/invalid.log"
  fi
)

下は、採用されたタイムアウトと起動エラーの抜粋です。<work> は実行ごとに変わる一時ディレクトリーを指します。

case=relative-import
timeout.ms=8000
jar.marker=inside-jar

case=file-prefix
timeout.ms=9000
jar.marker=inside-jar

case=optional-missing
timeout.ms=3000
jar.marker=inside-jar

case=required-missing
exit=1
Config data resource 'file [<work>/params/missing.properties]' via location 'missing.properties' does not exist

case=optional-invalid-value
exit=1
java.lang.IllegalArgumentException: 'invalid' is not a valid duration

相対指定と file: の扱いは、Spring Boot 3.5の設定ファイルのimport仕様で確認できます。

設定値の優先順位を理解する

実行用サンプル

実行できる同じjarを使い、同じ設定値の取得元を順に変えます。 検証コードを見る。 JDK 17とMaven 3.9系で試せます。ソース・テスト・pom.xml・READMEをZIPに収録しています。

mvn package の後、sh scripts/verify-config.sh target/spring-maintenance-diagnostics-1.0.0.jar を実行します。サンプルの起動確認にはタイムアウト値だけを使い、DB接続情報は設定しません。

確認結果は、jar内の既定値が1000 ms、local Profileが2000 ms、外部ファイルが3000 ms、環境変数が4000 ms、CLI指定が5000 msです。同じjarのまま、どの値が採用されたかを比較できます。

6000 msのファイルを追加する場合、spring.config.additional-location ではjar内だけの識別値も残ります。spring.config.location に同じファイルの場所を指定すると識別値は読み込まれません。

verify-config.sh の全文

#!/bin/sh
set -eu

jar=$(cd "$(dirname "$1")" && pwd)/$(basename "$1")
temp=$(mktemp -d)
trap 'rm -rf "$temp"' 0
cd "$temp"

probe() {
    java -jar "$jar" --spring.main.web-application-type=none \
        --spring.main.banner-mode=off --logging.level.root=OFF --demo.print-config=true "$@"
}

expect() {
    label=$1
    milliseconds=$2
    marker=$3
    shift 3
    output=$(probe "$@")
    expected=$(printf 'timeout.ms=%s\njar.marker=%s' "$milliseconds" "$marker")
    [ "$output" = "$expected" ] || {
        printf '%s: expected %s; got %s\n' "$label" "$expected" "$output" >&2
        exit 1
    }
    printf '%s: %s ms (%s)\n' "$label" "$milliseconds" "$marker"
}

unset DEMO_TIMEOUT SPRING_CONFIG_LOCATION SPRING_CONFIG_ADDITIONAL_LOCATION SPRING_PROFILES_ACTIVE
expect jar-default 1000 inside-jar
expect jar-local-profile 2000 inside-jar --spring.profiles.active=local
mkdir config replacement
printf 'demo.timeout=3s\n' > config/application.properties
expect outside-jar 3000 inside-jar
(export DEMO_TIMEOUT=4s; expect environment 4000 inside-jar)
(export DEMO_TIMEOUT=4s; expect command-line 5000 inside-jar --demo.timeout=5s)
printf 'demo.timeout=6s\n' > replacement/application.properties
expect additional-location 6000 inside-jar --spring.config.additional-location=file:./replacement/
expect replacement-location 6000 absent --spring.config.location=file:./replacement/

Spring Bootには複数の設定元があり、後から優先される値で上書きされます。すべての細かな順序を暗記するより、現場でよく使う次の流れを押さえます。

  1. jar内のapplication.propertiesに共通の既定値を書く
  2. jar外のapplication.propertiesで環境固有値を上書きする
  3. 環境変数で値を上書きし、同じキーをJVMのシステムプロパティでも指定すると後者が優先される
  4. コマンドライン引数でその起動だけの値を上書きする

同じキーを環境変数・-D・起動引数で渡したときに、どの値が採用されるか

上のZIPを展開したフォルダで mvn package を済ませ、次をシェルで実行します。毎回 DEMO_TIMEOUT=4s を残し、同じJARを起動します。出力の timeout.ms を1行目から順に比べてください。手順の4行は、ZIP内の7条件とは別の追加確認です。

jar="$PWD/target/spring-maintenance-diagnostics-1.0.0.jar"
probe() {
  java "$@" --spring.main.web-application-type=none \
    --spring.main.banner-mode=off --logging.level.root=OFF \
    --demo.print-config=true
}

export DEMO_TIMEOUT=4s
probe -jar "$jar"                                      # 4000 ms
probe -Ddemo.timeout=4500ms -jar "$jar"                  # 4500 ms
probe -Ddemo.timeout=4500ms -jar "$jar" --demo.timeout=5s # 5000 ms
probe -jar "$jar" -Ddemo.timeout=4500ms                  # 4000 ms
unset DEMO_TIMEOUT

JVMのシステムプロパティは -Ddemo.timeout=4500ms を -jar の前に置きます。この条件では環境変数の4000 msより優先され、4500 msになります。さらにJARの後へSpring Bootの引数 --demo.timeout=5s を加えると5000 msです。-D をJARの後に置いた最後の起動では、JVMの設定として渡らず、環境変数の4000 msが採用されます。

Spring Bootの完全な優先順位には、テスト用プロパティやJSON形式の設定なども含まれます。障害調査では推測せず、利用中のSpring Bootバージョンの公式ドキュメントと実際の起動方法を確認してください。

# その起動だけポートを変更する例
java -jar order-app.jar --server.port=9090

複数のProfileを使うと、カンマとセミコロンで優先順位が変わる

たとえば運用用のprodと切り替え用のliveを同時に有効にしているとします。配布の同じJARを使い、cfg/application-live.propertiesに7200ms、ext/application-prod.propertiesに6100msを入れます。両方に書く設定キーはdemo.timeoutです。

  1. prod,live、場所をカンマで区切る。 cfgとextは別グループです。後に処理するext側が勝ち、6100msになります。
  2. prod,live、場所をセミコロンで区切る。 cfgとextは同じグループです。後に指定したlive側が勝ち、7200msになります。
  3. live,prod、場所は同じセミコロン区切り。 Profileの順番だけを逆にすると、今度はprod側が勝ち、6100msになります。

配布ZIPを展開したフォルダーでmvn -B packageを実行し、そのフォルダーで下のシェルを実行します。場所をディレクトリーとして指定する末尾の/を残し、;を含む引数はシェルで引用します。環境変数の影響を除くためenv -iで同じJARを3回起動します。実行例はJDK 17・Spring Boot 3.5.16を使い、ファイルはシェル内の一時フォルダーに作ります。

#!/bin/sh

jar="${1:-$PWD/target/spring-maintenance-diagnostics-1.0.0.jar}"
(
  set -eu
  work=$(mktemp -d)
  trap 'rm -rf "$work"' EXIT
  cd "$work"
  mkdir cfg ext
  printf 'demo.timeout=7200ms\n' > cfg/application-live.properties
  printf 'demo.timeout=6100ms\n' > ext/application-prod.properties

  probe() {
    printf 'profiles=%s locations=%s\n' "$1" "$2"
    env -i PATH="$PATH" java -jar "$jar" \
      --spring.main.web-application-type=none \
      --spring.main.banner-mode=off --logging.level.root=ERROR \
      --demo.print-config=true --spring.profiles.active="$1" \
      --spring.config.additional-location="$2"
  }

  probe prod,live 'file:./cfg/,file:./ext/'
  probe prod,live 'file:./cfg/;file:./ext/'
  probe live,prod 'file:./cfg/;file:./ext/'
)
profiles=prod,live locations=file:./cfg/,file:./ext/
timeout.ms=6100
jar.marker=inside-jar
profiles=prod,live locations=file:./cfg/;file:./ext/
timeout.ms=7200
jar.marker=inside-jar
profiles=live,prod locations=file:./cfg/;file:./ext/
timeout.ms=6100
jar.marker=inside-jar

3回ともjar.marker=inside-jarが残ります。既定の検索場所を保ったまま、追加したファイルのどれが採用されるかを比較した例です。障害調査では、起動引数の外部フォルダーの区切りとspring.profiles.activeの値を控え、実行時の値と照合します。

一次資料 Spring Boot 3.5のProfile別設定とロケーショングループ。

@ConfigurationPropertiesで関連設定をまとめる

設定が1つなら@Valueでも読めますが、外部APIのURL、接続時間、読取時間など関連項目が増えたら@ConfigurationPropertiesで型へまとめると管理しやすくなります。

external.payment.base-url=https://payment.example.com
external.payment.connect-timeout=1s
external.payment.read-timeout=3s
@ConfigurationProperties(prefix = "external.payment")
public record PaymentProperties(
        URI baseUrl,
        Duration connectTimeout,
        Duration readTimeout) {
}

型変換されるため、文字列を各Serviceで解析する必要がありません。設定クラスをBean登録する方法はSpring Bootの構成によって異なるため、@ConfigurationPropertiesScanや@EnableConfigurationPropertiesなど、プロジェクトの既存方式へ揃えます。

関連記事Spring Bootの@ConfigurationPropertiesを起動時に検証する|必須・範囲・型エラーの見分け方 設定値は届いているのに起動できないときは、ログのPropertyとReasonを照合します。同じ設定キーで、未指定・範囲外・型変換の失敗を比べます。 記事を読む

Dockerで環境変数を渡す例

services:
  order-app:
    image: example/order-app:1.0.0
    environment:
      DB_URL: jdbc:postgresql://db:5432/orderdb
      DB_USERNAME: order_user
      DB_PASSWORD: ${DB_PASSWORD}
      SPRING_PROFILES_ACTIVE: production

Composeファイルへ本番パスワードを直接書かず、実行環境からDB_PASSWORDを渡す形にしています。ただし、環境変数なら無条件に安全という意味ではありません。閲覧権限、デプロイログ、障害調査時の出力を含め、基盤側の管理方法を確認します。

よくある「設定が反映されない」原因

  • 環境変数を設定したシェルと、アプリを起動したサービスの実行環境が違う
  • 有効なProfile名とファイル名が一致していない
  • 外部ファイルを置いたが、カレントディレクトリが想定と違う
  • spring.config.locationで既定の検索場所を置き換えてしまった
  • より優先度の高いコマンドライン引数や環境変数が残っている
  • プロパティ名のタイプミスで別の設定として扱われている
  • 設定ファイルの読取権限が実行ユーザーにない

値をログへ出して確認したくなりますが、パスワードやトークンを出力してはいけません。接続先ホスト、Profile名、設定ファイルの配置場所など、秘密ではない情報から切り分けます。Actuatorの設定公開機能も、アクセス制御なしで外部公開しないようにします。

現場での設定管理ルール例

設定の種類置き場所の例
全環境共通の既定値jar内application.properties
開発用の非機密設定application-local.properties
本番の接続先や運用値jar外設定、環境変数
パスワード・APIキーシークレット管理、権限制御された環境変数
一時的な起動変更コマンドライン引数

設定をどこへ置くかだけでなく、誰が変更するか、変更履歴をどこに残すか、再起動が必要か、切り戻し方法は何かまで運用手順へ書きます。本番障害はコードではなく設定変更から起きることも珍しくありません。

現場レビューでよくある指摘

// レビューコメント例
本番DBのURLがJavaコードへ直書きされています。
application.propertiesへ移し、環境変数で上書きできるようにしてください。

// レビューコメント例
application-production.propertiesにパスワードが含まれています。
Git管理から外し、プロジェクトのシークレット管理方式へ移してください。

// レビューコメント例
spring.config.locationは既定場所を置き換えます。
追加が目的ならadditional-locationでよいか確認してください。

提出・リリース前のセルフチェック

  • 環境固有値をJavaコードへ直書きしていないか
  • 秘密情報がGit履歴や配布jarへ含まれていないか
  • 有効化するProfileと設定ファイル名が一致しているか
  • 外部設定ファイルのパス、権限、実行ユーザーを確認したか
  • どの設定元が最終的に優先されるか説明できるか
  • 設定変更と切り戻しの手順が文書化されているか

Spring Bootでアプリを作りながら設定を読む参考書

『作って学ぶ Spring Boot入門』は、Spring JDBCやSpring MVCのアプリを作りながらapplication.propertiesを触りたい人向けです。5.3.3節ではDBを使うための設定、7.5.2節ではMVCアプリを動かすための設定を学べます。環境変数・Profile・外部ファイルのうち何が採用されるかを調べるときは、この記事の「設定値の優先順位を理解する」で、同じJARに渡す設定だけを変えて結果を比べてください。

書籍「作って学ぶ Spring Boot入門」の表紙
商品画像:Amazon.co.jp
PR Java新人・若手向け

作って学ぶ Spring Boot入門

多田 真敏 (著)

Spring Bootを、動くWebアプリを作りながら覚える。

Controller、画面、DB連携などを一つのアプリとして実装できます。Java基礎からSpringの現場へ進む橋渡しに向く一冊です。

  • Spring Bootを手を動かして学びたい
  • Webアプリ開発の流れをつかみたい

当サイトはAmazonアソシエイト・プログラムの参加者です。価格・在庫・配送条件はAmazonでご確認ください。

この記事とあわせて読みたい

関連記事SpringBootの設定ファイルを外だしするには 既存記事で、アプリ外のpropertiesファイルを扱う実装例を確認できます。 記事を読む 関連記事Spring Bootの「No qualifying bean of type」原因|DIできないときの対処法 Beanの登録、スキャン範囲、コンストラクタ注入を確認します。 記事を読む

まとめ

Spring Bootでは、jar内のapplication.propertiesに共通の既定値を置き、環境変数、Profile、jar外ファイルで環境固有値を上書きできます。秘密情報はソース管理へ含めず、現場のシークレット管理方式へ寄せます。

設定が反映されないときは、Profile名、外部ファイルの場所、実行ユーザー、優先度の高い設定元を順番に確認します。spring.config.locationとspring.config.additional-locationの違いも、起動手順へ明記しておきましょう。

-実装・エラー解決
-