Skip to content

変数展開

env ライブラリは設定ファイル内での変数参照をサポートし、設定の再利用と動的値置換を実現します。

変数展開の有効化

go
cfg := env.DefaultConfig()
cfg.ExpandVariables = true  // デフォルトで有効

loader, _ := env.New(cfg)
loader.LoadFiles(".env")

基本構文

シンプルな参照

bash
# 他の変数を参照
BASE_URL=https://api.example.com
API_URL=${BASE_URL}/v1
# API_URL は展開後: https://api.example.com/v1

# 簡略構文
HOST=localhost
URL=$HOST:8080
# URL は展開後: localhost:8080

デフォルト値構文

構文説明
${VAR:-default}VAR が存在しない場合、default を使用
${VAR:=default}VAR が存在しない場合、default を使用(:- と同じ)
${VAR:?error}VAR が存在しないまたは空の場合、エラーを返す

自己参照の制限

:-:=:? が参照する変数は、代入先のキーと異なる必要があります。KEY=${KEY:-default} のような自己参照は循環参照として検出され、ロード時に ErrExpansionDepth エラーになります。キーにデフォルト値を設定するには、リテラルを直接代入(KEY=default)するか、別の変数を参照してください(下記の例を参照)。


構文の詳細

${VAR:-default} - デフォルト値の使用

最も一般的なデフォルト値構文です。変数が存在しない場合にデフォルト値を使用し、変数が存在する場合(値が空でも)は元の値を使用します:

bash
# HOST は定義済み、その値を使用
HOST=localhost
PRIMARY_HOST=${HOST:-127.0.0.1}
# PRIMARY_HOST は展開後: localhost

# TIMEOUT が未定義の場合、デフォルト値 "30s" を使用
TIMEOUT_VALUE=${TIMEOUT:-30s}
# TIMEOUT_VALUE は展開後: 30s

# ネストされたデフォルト値
DB_HOST=localhost
DB_URL=${DB_HOST}:${DB_PORT:-5432}
# DB_HOST=localhost で DB_PORT が未定義の場合
# DB_URL は展開後: localhost:5432

使用シーン:

  • オプション設定項目のデフォルト値
  • 開発/本番環境の統一設定

${VAR:=default} - デフォルト値の使用

${VAR:-default} と同じ動作で、変数が存在しない場合にデフォルト値を使用します:

bash
# DEBUG が未定義の場合、"false" を使用
DEBUG_VALUE=${DEBUG:=false}

# CACHE_TTL が未定義の場合、デフォルト値を使用
CACHE_TTL_VALUE=${CACHE_TTL:=3600}

と :- の関係

${VAR:=default} はこのライブラリでは ${VAR:-default} と全く同じ動作です。変数が存在しない場合、デフォルト値を展開結果として使用します。:= はデフォルト値を変数ストアに書き戻しません。


${VAR:?error} - エラープロンプト

変数が存在しないまたは空の場合、エラーを返します:

bash
# DATABASE_URL が未定義の場合、読み込み失敗しエラーを表示
DB_URL=${DATABASE_URL:?Database URL is required}

# API_TOKEN が未定義の場合、エラー
AUTH_TOKEN=${API_TOKEN:?API_TOKEN must be set}

使用シーン:

  • 必須設定項目の検証
  • 早期フェイル、ランタイムエラーの回避

エスケープ

ドル記号のエスケープ

$$ を使用してリテラル $ を表します:

bash
# 価格設定
PRICE=$$99.99
# 展開後: $99.99

# $ を含む文字列
MESSAGE=Price is $$100
# 展開後: Price is $100

引用符と展開

変数展開は引用符が剥がされた後の統一的な後処理ステージで行われます。シングルクォートもダブルクォートも変数展開に影響しません。例えば SINGLE='${BASE}'BASE=hello)の展開後の値は hello となり、ダブルクォートと同じ挙動です。参照先の変数が未定義の場合(例:LITERAL='${NO_EXPANSION}')、結果は空文字列になり、${NO_EXPANSION} というリテラルは保持されません。

シングルクォートとダブルクォートの違いはリテラル解析のみです:ダブルクォートは \n\t などのエスケープシーケンスを処理しますが、シングルクォートはそのまま保持します(エスケープしません)。

注意

引用符を使って「展開を禁止」しないでください。${VAR} リテラルを保持する必要がある場合は、以下の方法を使用してください:

bash
# 方法 1:ドル記号をエスケープ($$ はリテラル $ に展開)
LITERAL='$${NO_EXPANSION}'
# 値: ${NO_EXPANSION}
go
// 方法 2:グローバルな変数展開を無効化
cfg := env.DefaultConfig()
cfg.ExpandVariables = false

ネストされた展開

変数はネストして参照できます:

bash
# 基本設定(組み込み禁止キー ENV を避け、DEPLOY_ENV を使用)
APP_NAME=myapp
DEPLOY_ENV=production

# ネストされた参照
DB_HOST=db.${DEPLOY_ENV}.example.com
# 展開後: db.production.example.com

API_URL=https://${APP_NAME}.${DEPLOY_ENV}.api.example.com
# 展開後: https://myapp.production.api.example.com

循環検出

ライブラリは循環参照を自動的に検出し、エラーを返します:

bash
# 循環参照(エラー)
A=${B}
B=${A}

# 読み込み時に ErrExpansionDepth エラーが返される

展開深度制限

デフォルトの最大展開深度は 5、ハードリミットは 20 です:

go
cfg := env.DefaultConfig()
cfg.MaxExpansionDepth = 10  // カスタム深度
定数説明
DefaultMaxExpansionDepth5デフォルト値(公開 API)

ヒント

ハードリミットは 20(内部制限)です。設定の MaxExpansionDepth はこの制限を超えることはできません。


完全な例

bash
# .env ファイル

# 基本設定(組み込み禁止キー ENV を避ける)
APP_NAME=myapp
DEPLOY_ENV=development
DEBUG=true

# データベース設定
DB_HOST=localhost
DB_PORT=5432
DB_NAME=${APP_NAME}
DB_URL=postgres://${DB_HOST}:${DB_PORT}/${DB_NAME}

# API 設定
API_BASE=https://api.${DEPLOY_ENV}.example.com
API_URL=${API_BASE}/v1

# ログ設定
LOG_LEVEL=info

# 価格(エスケープ)
PRICE=$$99.99
go
package main

import (
    "fmt"
    "log"

    "github.com/cybergodev/env"
)

func main() {
    cfg := env.DefaultConfig()
    cfg.ExpandVariables = true

    loader, err := env.New(cfg)
    if err != nil {
        log.Fatal(err)
    }
    defer loader.Close()

    err = loader.LoadFiles(".env")
    if err != nil {
        log.Fatal(err)
    }

    fmt.Println("DB_URL:", loader.GetString("DB_URL"))
    fmt.Println("API_URL:", loader.GetString("API_URL"))
    fmt.Println("PRICE:", loader.GetString("PRICE"))
}

関連ドキュメント