Linux 与服务器运维 / 系统课时

统一脚本配置与环境变量

统一脚本配置与环境变量

同一套运维脚本进入测试、预发和生产后,最容易失控的不是命令本身,而是参数来源不一致。本节把默认值、配置文件、环境变量和命令行参数统一成明确优先级,并在执行前集中校验必填项,最终得到一份可复用、可验证的 Bash 配置骨架。

学习目标

  • 设计“命令行参数 > 环境变量 > 配置文件 > 默认值”的稳定覆盖规则
  • 在脚本真正执行前完成必填项、枚举值和数值范围校验
  • 用测试、预发、生产三套配置复用同一份脚本,并确认最终生效值

固定配置优先级

配置来源越多,越不能依赖“谁最后赋值谁生效”这种隐式行为。推荐固定为:默认值提供兜底,配置文件承载环境级静态参数,环境变量用于 CI/CD 或临时注入,命令行参数用于单次执行覆盖。

例如配置文件指定端口 8080,流水线通过环境变量注入 9090,本次执行又传入 --port 10080,最终端口必须明确为 10080。只要优先级固定,同一脚本就不需要复制出 test、staging、prod 三个版本。

实现统一加载与校验

下面脚本先解析命令行参数并保留外部环境变量,再清空相关变量后加载配置文件,最后按固定优先级合并。这样配置文件缺少某个字段时,不会误把原有环境变量当成“文件配置”。

bash
#!/usr/bin/env bash
set -euo pipefail

DEFAULT_APP_ENV="test"
DEFAULT_DEPLOY_PORT="8080"
DEFAULT_CONFIG_FILE="./deploy.env"

CLI_APP_ENV=""
CLI_DEPLOY_HOST=""
CLI_DEPLOY_PORT=""
CONFIG_FILE="$DEFAULT_CONFIG_FILE"

while (($# > 0)); do
  case "$1" in
    --env)
      CLI_APP_ENV="${2:?missing value for --env}"
      shift 2
      ;;
    --host)
      CLI_DEPLOY_HOST="${2:?missing value for --host}"
      shift 2
      ;;
    --port)
      CLI_DEPLOY_PORT="${2:?missing value for --port}"
      shift 2
      ;;
    --config)
      CONFIG_FILE="${2:?missing value for --config}"
      shift 2
      ;;
    *)
      printf 'unknown argument: %s\n' "$1" >&2
      exit 2
      ;;
  esac
done

ENV_APP_ENV="${APP_ENV-}"
ENV_DEPLOY_HOST="${DEPLOY_HOST-}"
ENV_DEPLOY_PORT="${DEPLOY_PORT-}"

unset APP_ENV DEPLOY_HOST DEPLOY_PORT
FILE_APP_ENV=""
FILE_DEPLOY_HOST=""
FILE_DEPLOY_PORT=""

if [[ -f "$CONFIG_FILE" ]]; then
  # 配置文件只负责约定字段,环境变量已提前保存。
  # shellcheck disable=SC1090
  source "$CONFIG_FILE"
  FILE_APP_ENV="${APP_ENV-}"
  FILE_DEPLOY_HOST="${DEPLOY_HOST-}"
  FILE_DEPLOY_PORT="${DEPLOY_PORT-}"
fi

APP_ENV="${CLI_APP_ENV:-${ENV_APP_ENV:-${FILE_APP_ENV:-$DEFAULT_APP_ENV}}}"
DEPLOY_HOST="${CLI_DEPLOY_HOST:-${ENV_DEPLOY_HOST:-$FILE_DEPLOY_HOST}}"
DEPLOY_PORT="${CLI_DEPLOY_PORT:-${ENV_DEPLOY_PORT:-${FILE_DEPLOY_PORT:-$DEFAULT_DEPLOY_PORT}}}"

require_non_empty() {
  local name="$1"
  local value="$2"
  if [[ -z "$value" ]]; then
    printf 'required config is empty: %s\n' "$name" >&2
    exit 1
  fi
}

require_non_empty "DEPLOY_HOST" "$DEPLOY_HOST"

case "$APP_ENV" in
  test|staging|prod) ;;
  *)
    printf 'APP_ENV must be test, staging or prod: %s\n' "$APP_ENV" >&2
    exit 1
    ;;
esac

if [[ ! "$DEPLOY_PORT" =~ ^[0-9]+$ ]] || ((DEPLOY_PORT < 1 || DEPLOY_PORT > 65535)); then
  printf 'DEPLOY_PORT must be an integer from 1 to 65535: %s\n' "$DEPLOY_PORT" >&2
  exit 1
fi

printf 'APP_ENV=%s\n' "$APP_ENV"
printf 'DEPLOY_HOST=%s\n' "$DEPLOY_HOST"
printf 'DEPLOY_PORT=%s\n' "$DEPLOY_PORT"
printf 'CONFIG_FILE=%s\n' "$CONFIG_FILE"

准备一份预发配置,保存为 staging.env。这是供主脚本加载的配置片段,不应放入密码、令牌或私钥等敏感信息。

bash
APP_ENV="staging"
DEPLOY_HOST="staging.example.internal"
DEPLOY_PORT="8080"

让环境变量覆盖主机地址,再让命令行参数覆盖端口:

bash
DEPLOY_HOST="ci-staging.example.internal" ./deploy.sh --config ./staging.env --port 10080

预期输出:

text
APP_ENV=staging
DEPLOY_HOST=ci-staging.example.internal
DEPLOY_PORT=10080
CONFIG_FILE=./staging.env

这四行分别证明配置文件、环境变量和命令行参数按预定规则参与合并。真实主机名和目录可以不同,但覆盖关系不应随环境改变。

把环境差异留在配置层

脚本主体应尽量避免大量 if [[ "$APP_ENV" == "prod" ]] 后再硬编码地址。环境差异应该收敛到配置文件或部署平台的环境变量中,让同一份脚本只负责读取、校验和执行。

普通地址、端口和功能开关可以进入环境配置;密码、访问令牌、私钥等秘密值则应由 CI/CD 密钥、Secret 管理系统或受控运行环境注入。脚本只读取秘密值并检查是否存在,不应主动把它们打印出来。

在副作用发生前失败

必填项、环境枚举和端口范围的校验必须发生在上传文件、重启进程、删除目录等副作用之前。可以用缺少目标主机的场景验证保护是否生效:

bash
./deploy.sh --config /tmp/not-exist.env --env prod

预期输出:

text
required config is empty: DEPLOY_HOST

脚本此时以退出码 1 结束,并且还没有执行任何部署动作。后续只需把上传、重启和健康检查等真实逻辑接在校验代码之后,就能让测试、预发和生产共用同一执行路径,同时保持配置来源清晰、覆盖规则稳定。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

统一脚本配置与环境变量

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通