シェルスクリプトで設定値を3層優先順位（CLIオプション・環境変数・設定ファイル）で管理する設計

この記事のポイント

・CLIオプション > 環境変数 > 設定ファイル > デフォルト値 の順で解決する
・getoptsで受けた値は専用変数に保持し、後段の層を上書きできる仕組みにする
・${VAR:-default}演算子で環境変数の存在確認とデフォルト代入を1行で書ける
・設定ファイルはsource前にパーミッション確認を入れるのが安全設計の基本

# 解決ロジックの骨格（イメージ）
FINAL_VALUE="${CLI_VALUE:-${ENV_VALUE:-${FILE_VALUE:-DEFAULT_VALUE}}}"

#!/bin/bash
set -euo pipefail

usage() {
    echo "Usage: $0 [-s server] [-p port] [-u user] [-c config_file]" >&2
    exit 1
}

# CLI専用変数（空文字 = 未指定）
CLI_SERVER=""
CLI_PORT=""
CLI_USER=""
CLI_CONFIG=""

OPTIND=1
while getopts "s:p:u:c:h" opt; do
    case "$opt" in
        s) CLI_SERVER="$OPTARG" ;;
        p) CLI_PORT="$OPTARG"   ;;
        u) CLI_USER="$OPTARG"   ;;
        c) CLI_CONFIG="$OPTARG" ;;
        h|*) usage              ;;
    esac
done
shift $((OPTIND - 1))

# 長オプションを手動解析する例（getoptsと併用しない）
for arg in "$@"; do
    case "$arg" in
        --server=*) CLI_SERVER="${arg#--server=}" ;;
        --port=*)   CLI_PORT="${arg#--port=}"     ;;
        --user=*)   CLI_USER="${arg#--user=}"     ;;
        --config=*) CLI_CONFIG="${arg#--config=}" ;;
    esac
done

# 環境変数専用変数（ENV_プレフィックスで層を明示する）
ENV_SERVER="${MYAPP_SERVER:-}"
ENV_PORT="${MYAPP_PORT:-}"
ENV_USER="${MYAPP_USER:-}"

# ~/.myapp.conf の例
server=prod01.example.com
port=5432
user=appuser
# コメント行は # で始める

load_config() {
    local config_file="${1:-}"
    FILE_SERVER=""
    FILE_PORT=""
    FILE_USER=""

    [[ -z "$config_file" || ! -f "$config_file" ]] && return 0

    # others への書き込み権限があれば拒否（改ざんリスク）
    local perm
    perm="$(stat -c '%a' "$config_file")"
    if [[ "${perm: -1}" != "0" && "${perm: -1}" != "4" ]]; then
        echo "[WARN] $config_file にothers書き込み権限があります。スキップします。" >&2
        return 0
    fi

    while IFS='=' read -r key value; do
        # コメント行と空行をスキップ
        [[ "$key" =~ ^[[:space:]]*(#|$) ]] && continue
        key="${key// /}"        # キーの前後スペース除去
        value="${value%% *}"    # 値のインラインコメント（# 以降）を除去
        case "$key" in
            server) FILE_SERVER="$value" ;;
            port)   FILE_PORT="$value"   ;;
            user)   FILE_USER="$value"   ;;
        esac
    done < "$config_file"
}

resolve_config_path() {
    # CLIで明示指定されていればそちらを優先
    [[ -n "$CLI_CONFIG" ]] && { echo "$CLI_CONFIG"; return; }
    # XDG標準パス → HOME直下の順で探す
    local xdg="${XDG_CONFIG_HOME:-$HOME/.config}"
    [[ -f "$xdg/myapp/config" ]] && { echo "$xdg/myapp/config"; return; }
    [[ -f "$HOME/.myapp.conf" ]] && { echo "$HOME/.myapp.conf"; return; }
    echo ""  # 見つからなければ空文字を返す（設定ファイルなし）
}

#!/bin/bash
# myapp.sh — 3層優先順位設定管理の実装例
# 使用法: ./myapp.sh [-s server] [-p port] [-u user] [-c config]
set -euo pipefail

usage() {
    echo "Usage: $0 [-s server] [-p port] [-u user] [-c config]" >&2
    exit 1
}

# ---- 第1層: CLIオプション解析 ----
CLI_SERVER="" CLI_PORT="" CLI_USER="" CLI_CONFIG=""
OPTIND=1
while getopts "s:p:u:c:h" opt; do
    case "$opt" in
        s) CLI_SERVER="$OPTARG" ;;
        p) CLI_PORT="$OPTARG"   ;;
        u) CLI_USER="$OPTARG"   ;;
        c) CLI_CONFIG="$OPTARG" ;;
        h|*) usage              ;;
    esac
done
shift $((OPTIND - 1))

# ---- 第3層: 設定ファイル読み込み ----
load_config() {
    local config_file="${1:-}"
    FILE_SERVER="" FILE_PORT="" FILE_USER=""
    [[ -z "$config_file" || ! -f "$config_file" ]] && return 0
    local perm; perm="$(stat -c '%a' "$config_file")"
    if [[ "${perm: -1}" != "0" && "${perm: -1}" != "4" ]]; then
        echo "[WARN] $config_file: others書き込み可。スキップ。" >&2; return 0
    fi
    while IFS='=' read -r key value; do
        [[ "$key" =~ ^[[:space:]]*(#|$) ]] && continue
        key="${key// /}"; value="${value%% *}"
        case "$key" in
            server) FILE_SERVER="$value" ;;
            port)   FILE_PORT="$value"   ;;
            user)   FILE_USER="$value"   ;;
        esac
    done < "$config_file"
}

resolve_config_path() {
    [[ -n "$CLI_CONFIG" ]] && { echo "$CLI_CONFIG"; return; }
    local xdg="${XDG_CONFIG_HOME:-$HOME/.config}"
    [[ -f "$xdg/myapp/config" ]]  && { echo "$xdg/myapp/config"; return; }
    [[ -f "$HOME/.myapp.conf" ]]  && { echo "$HOME/.myapp.conf"; return; }
    echo ""
}

# ---- 第2層: 環境変数 ----
ENV_SERVER="${MYAPP_SERVER:-}"
ENV_PORT="${MYAPP_PORT:-}"
ENV_USER="${MYAPP_USER:-}"

# ---- 設定ファイルを読む ----
config_path="$(resolve_config_path)"
load_config "$config_path"

# ---- 優先順位を適用して最終値を決定 ----
SERVER="${CLI_SERVER:-${ENV_SERVER:-${FILE_SERVER:-localhost}}}"
PORT="${CLI_PORT:-${ENV_PORT:-${FILE_PORT:-5432}}}"
USER="${CLI_USER:-${ENV_USER:-${FILE_USER:-$(whoami)}}}"

# ---- デバッグ出力（DEBUG_CONFIG=1 で有効化） ----
if [[ "${DEBUG_CONFIG:-}" == "1" ]]; then
    echo "[DEBUG] CLI:   SERVER='${CLI_SERVER}' PORT='${CLI_PORT}' USER='${CLI_USER}'"
    echo "[DEBUG] ENV:   SERVER='${ENV_SERVER}' PORT='${ENV_PORT}' USER='${ENV_USER}'"
    echo "[DEBUG] FILE:  SERVER='${FILE_SERVER}' PORT='${FILE_PORT}' USER='${FILE_USER}'"
    echo "[DEBUG] FINAL: SERVER='${SERVER}' PORT='${PORT}' USER='${USER}'"
fi

# ---- メイン処理 ----
echo "接続先: ${SERVER}:${PORT} (ユーザー: ${USER})"

# 設定ファイルを作成する
$ cat ~/.myapp.conf
server=db01.example.com
port=5432
user=dbadmin

# 第3層（設定ファイル）のみ使われるケース
$ bash myapp.sh
接続先: db01.example.com:5432 (ユーザー: dbadmin)

# 第2層（環境変数）で上書きするケース
$ MYAPP_SERVER=db02.example.com bash myapp.sh
接続先: db02.example.com:5432 (ユーザー: dbadmin)

# 第1層（CLIオプション）で全上書きするケース
$ MYAPP_SERVER=db02.example.com bash myapp.sh -s db03.example.com -p 5433
接続先: db03.example.com:5433 (ユーザー: dbadmin)

# 設定ファイルも環境変数もなし → デフォルト値が使われる
$ bash myapp.sh
接続先: localhost:5432 (ユーザー: tomohiro)

# デバッグモードで各層の値を確認する
$ DEBUG_CONFIG=1 bash myapp.sh -s db03.example.com
[DEBUG] CLI:   SERVER='db03.example.com' PORT='' USER=''
[DEBUG] ENV:   SERVER='' PORT='' USER=''
[DEBUG] FILE:  SERVER='db01.example.com' PORT='5432' USER='dbadmin'
[DEBUG] FINAL: SERVER='db03.example.com' PORT='5432' USER='dbadmin'
接続先: db03.example.com:5432 (ユーザー: dbadmin)