Bash getopts 命令

Begindev 编辑部 March 30, 2026

命令行选项（Command line options）提供了一种极其灵活的方式，让用户能够在不修改脚本源代码的情况下定制脚本的行为。

在之前的章节中，我们使用了诸如 $1、$2 等位置参数和 $@ 等特殊变量来获取用户输入。然而，当脚本变得复杂时，我们往往需要更高级的选项解析机制。特别是当你需要处理标志位（flags）（例如使用 -v 表示输出详细信息）或者带参数的选项（例如使用 -f filename 指定文件名）时，简单的位置变量就显得力不从心了。

Bash 提供了一个名为 getopts 的内置命令，专门用于解决这个问题。它允许脚本以一种标准化的方式来逐个处理短选项（单字符选项）及其关联的参数。

1. 深入理解 getopts 基础

getopts 命令用于解析命令行选项和参数。它会逐一处理传入的选项，非常适合配合循环语句来遍历提供给脚本的所有选项。

getopts 的基本语法如下：

getopts option_string name [arguments]

option_string（选项字符串）: 这是一个由字符组成的字符串，其中每个字符代表一个合法的短选项。

如果 option_string 中的某个字符后面跟着一个冒号 (:)，则表示该选项必须带有一个参数。
如果 option_string 以冒号 (:) 开头，则表示 getopts 运行在“静默错误报告（silent error reporting）”模式。在这种模式下，遇到无效选项时，它不会自动打印错误信息，而是将 name 变量设置为 ?，并将无效选项的字符存入 OPTARG 变量。如果某个选项缺少了必须的参数，name 会被设置为 :。

name: 这是一个 Shell 变量的名称。getopts 每次找到一个选项时，就会把这个选项字符（例如 a、b、c）赋值给这个变量。
[arguments]: 这是一个可选的参数列表。如果省略，getopts 将默认解析当前 Shell 接收到的位置参数（即 $@）。

getopts 在运行时还会自动设置几个极其重要的内部变量：

OPTIND: 在 Shell 脚本启动时，这个变量被初始化为 1。它记录了 getopts 下一个要处理的参数的索引位置。当 getopts 处理完所有选项后，OPTIND 将指向第一个非选项参数（普通的参数）。这对于把“选项”和“普通参数”分离开来至关重要。
OPTARG: 如果某个选项要求带有参数（即在选项字符串中后面有冒号），getopts 会将用户提供的这个参数值存储在 OPTARG 变量中。

2. 基础示例：解析命令行选项

假设我们有一个脚本，需要接受一个详细信息标志 (-v) 和一个输出文件选项 (-o filename)。

#!/bin/bash

# 将 OPTIND 重置为 1，防止脚本被 source 引入或之前调用过 getopts 导致索引混乱
OPTIND=1

# 初始化变量并赋予默认值
VERBOSE=0
OUTPUT_FILE=""

# 解析选项
# 'v' 是一个简单的标志位，'o:' 表示 -o 后面必须跟一个参数
while getopts "vo:" opt; do
  case "$opt" in
    v)
      VERBOSE=1
      echo "已开启详细输出模式 (Verbose mode)。"
      ;;
    o)
      OUTPUT_FILE="$OPTARG"
      echo "输出文件已设置为: $OUTPUT_FILE"
      ;;
    \?) # 匹配无效选项
      echo "错误: 无效的选项 -$OPTARG" >&2
      exit 1
      ;;
    :) # 匹配缺少参数的选项
      echo "错误: 选项 -$OPTARG 需要提供一个参数。" >&2
      exit 1
      ;;
  esac
done

# 将位置参数向左平移，跳过已经解析过的选项
# 执行后，$1, $2 等将指向第一个真正的“非选项参数”
shift $((OPTIND-1))

# 处理剩余的位置参数（如果有的话）
if [ "$#" -gt 0 ]; then
  echo "剩余的位置参数: $@"
else
  echo "没有剩余的位置参数了。"
fi

echo "脚本执行完毕。"
echo "最终的 VERBOSE 状态: $VERBOSE"
echo "最终的 OUTPUT_FILE 状态: '$OUTPUT_FILE'"

如何运行这个脚本：

./myscript.sh -v -o output.log input.txt （正常运行，带剩余参数）
./myscript.sh -o mydata.csv -v （正常运行，选项顺序无关紧要）
./myscript.sh -x（会触发错误：无效选项）
./myscript.sh -o （会触发错误：缺少参数）

代码解析：

OPTIND=1: 确保 getopts 从参数列表的开头开始解析。在复杂的脚本中，这是一个非常好的习惯。
while getopts "vo:" opt; do: 只要 getopts 还能成功找到并处理选项，这个循环就会一直运行。

"vo:": 这是选项字符串。v 表示 -v 是有效选项（无参数）。o: 表示 -o 是有效选项且必须带参数。
opt: 这个变量会保存当前解析到的选项字符（v 或 o）。

case "$opt" in ... esac: 通常使用 case 语句来对不同选项进行分支处理。

v): 如果 opt 是 v，设置 VERBOSE=1。
o): 如果 opt 是 o，自动从 OPTARG 提取参数值并赋给 OUTPUT_FILE。
\?): 如果输入了未定义的选项（如 -x），getopts 会匹配到这里。
:): 如果带参数的选项没有提供参数，getopts 会匹配到这里。

shift $((OPTIND-1)): 循环结束后，OPTIND 指向第一个普通的非选项参数。使用 shift 命令可以将前面那些已经被 getopts 处理过的标志和选项通通“切掉”。这样一来，$1 就会准确地指向用户输入的第一个普通参数文件或字符串。这是处理混合参数的核心技巧。

3. 处理长选项与混合选项

需要注意的是，Bash 内置的 getopts 专门设计用于处理短选项（单字符选项，如 -v）。它原生并不支持处理长选项（例如 --verbose、--output-file）。

如果在实际场景中既需要短选项又需要长选项，开发者通常会结合手动解析，或者使用外部命令工具如 getopt（注意末尾没有 s）。但对于大多数基础和中阶脚本而言，getopts 已经完全够用了。

4. 实战案例：系统备份脚本

让我们继续完善系统管理的实战案例。一个专业的备份脚本通常需要用户指定源目录、目标目录，并提供一个“试运行 (dry-run)”的安全标志。

#!/bin/bash
# system_backup.sh - 一个带命令行选项的系统备份脚本。

# 重置 OPTIND
OPTIND=1

# 默认值
SOURCE_DIR=""
DEST_DIR=""
DRY_RUN=0
VERBOSE=0
BACKUP_NAME="system_backup_$(date +%Y%m%d_%H%M%S)" # 默认备份名称

# 帮助说明函数
usage() {
  echo "用法: $0 [-s 源目录] [-d 目标目录] [-n 备份名称] [-v] [-r]"
  echo "  -s <dir>   : 要备份的源目录 (必填)"
  echo "  -d <dir>   : 备份的存放目标目录 (必填)"
  echo "  -n <name>  : 自定义备份压缩包的名称 (默认值: 带有时间戳的名称)"
  echo "  -v         : 开启详细输出模式。"
  echo "  -r         : 执行试运行 (dry run，仅模拟命令，不真实备份)。"
  exit 1
}

# 解析选项
while getopts "s:d:n:vr" opt; do
  case "$opt" in
    s) SOURCE_DIR="$OPTARG" ;;
    d) DEST_DIR="$OPTARG" ;;
    n) BACKUP_NAME="$OPTARG" ;;
    v) VERBOSE=1 ;;
    r) DRY_RUN=1 ;;
    \?)
      echo "错误: 无效的选项 -$OPTARG." >&2
      usage
      ;;
    :)
      echo "错误: 选项 -$OPTARG 需要一个参数。" >&2
      usage
      ;;
  esac
done

# 剔除已解析的选项
shift $((OPTIND-1))

# 校验必填参数
if [ -z "$SOURCE_DIR" ] || [ -z "$DEST_DIR" ]; then
  echo "错误: 源目录和目标目录是必填项。" >&2
  usage
fi

if [ ! -d "$SOURCE_DIR" ]; then
  echo "错误: 源目录 '$SOURCE_DIR' 不存在或不是一个目录。" >&2
  exit 1
fi

# 确保目标目录存在，不存在则尝试创建
if [ ! -d "$DEST_DIR" ]; then
  echo "目标目录 '$DEST_DIR' 不存在。正在尝试创建..."
  mkdir -p "$DEST_DIR" || { echo "错误: 创建目标目录 '$DEST_DIR' 失败。"; exit 1; }
fi

# 构建备份命令
BACKUP_ARCHIVE="${DEST_DIR}/${BACKUP_NAME}.tar.gz"
BACKUP_CMD="tar -czf ${BACKUP_ARCHIVE} -C ${SOURCE_DIR} ."

if [ "$VERBOSE" -eq 1 ]; then
  echo "已开启详细输出。"
  echo "源目录: $SOURCE_DIR"
  echo "目标目录: $DEST_DIR"
  echo "备份名称: $BACKUP_NAME"
  echo "待执行的命令: $BACKUP_CMD"
fi

if [ "$DRY_RUN" -eq 1 ]; then
  echo "试运行模式已开启。不会执行实际的备份。"
  echo "模拟命令: $BACKUP_CMD"
else
  echo "开始将 '$SOURCE_DIR' 备份到 '$DEST_DIR'..."
  # 执行备份命令
  if eval "$BACKUP_CMD"; then
    echo "备份成功完成，文件位于: $BACKUP_ARCHIVE"
  else
    echo "错误: 备份失败。" >&2
    exit 1
  fi
fi

# 提示用户是否有未识别的多余参数
if [ "$#" -gt 0 ]; then
  echo "警告: 忽略了未识别的位置参数: $@"
fi

如何运行这个脚本：

./system_backup.sh -s /home/user/documents -d /mnt/backups -v -n my_docs_backup （正常带参数执行）
./system_backup.sh -r -s /etc -d /tmp/backup_test （安全试运行）
./system_backup.sh -s /invalid/path -d /tmp/backup （源路径不存在，脚本将报错拦截）

5. 假设场景：应用配置部署脚本

想象一个用于部署应用程序的脚本 configure_app.sh。它可能需要指定配置文件路径 (-c)、部署环境 (-e dev/test/prod)，以及一个强制覆盖部署的标志 (-f)。

#!/bin/bash
# configure_app.sh - 使用指定配置部署应用程序。

OPTIND=1
CONFIG_FILE="default.conf"
ENVIRONMENT="development"
FORCE_DEPLOY=0

print_usage() {
  echo "用法: $0 [-c <配置文件路径>] [-e <部署环境>] [-f]"
  echo "  -c <config_path> : 应用配置文件的路径 (默认: default.conf)"
  echo "  -e <environment> : 部署环境 (dev, test, prod) (默认: development)"
  echo "  -f               : 强制部署，覆盖现有文件。"
  exit 1
}

while getopts "c:e:f" opt; do
  case "$opt" in
    c) CONFIG_FILE="$OPTARG" ;;
    e)
      ENVIRONMENT="$OPTARG"
      # 对环境变量进行基础校验
      if [[ ! "$OPTARG" =~ ^(dev|test|prod)$ ]]; then
        echo "错误: 无效的环境 '$OPTARG'。必须是 'dev', 'test', 或 'prod'。" >&2
        print_usage
      fi
      ;;
    f) FORCE_DEPLOY=1 ;;
    \?) echo "错误: 无效选项 -$OPTARG." >&2; print_usage ;;
    :) echo "错误: 选项 -$OPTARG 需要参数." >&2; print_usage ;;
  esac
done

shift $((OPTIND-1))

echo "--- 部署配置概览 ---"
echo "配置文件: $CONFIG_FILE"
echo "部署环境: $ENVIRONMENT"
echo "强制部署: $( [ "$FORCE_DEPLOY" -eq 1 ] && echo "是" || echo "否" )"
echo "--------------------"

if [ ! -f "$CONFIG_FILE" ]; then
  echo "错误: 找不到配置文件 '$CONFIG_FILE'。" >&2
  exit 1
fi

echo "正在模拟应用部署：使用 '$CONFIG_FILE' 配置发布至 '$ENVIRONMENT' 环境。"

if [ "$FORCE_DEPLOY" -eq 1 ]; then
  echo "警告：正在强制部署，原有的文件将被覆盖。"
fi

# 在这里执行实际的部署逻辑...
echo "部署模拟完成。"

这个例子很好地展示了如何在解析选项的同时，对参数值（如环境必须是特定字符串）进行校验限制。