getopts命令详解

一、为什么要用 getopts?

假设我们要写一个脚本 backup.sh,需要支持短选项:

  • -v 详细模式
  • -f <文件名> 指定备份文件
  • -d <目录> 指定目标目录

如果手动解析,你可能要写一堆 if 和 shift,还得处理 -f 后面有没有参数、用户是否拼错选项等问题。getopts 能自动处理这些,它遵循 POSIX 规范,帮我们循环读取选项并分离出选项参数。


二、基本语法

getopts optstring name [args]
  • optstring:选项定义字符串,列出脚本接受的所有短选项字母。
  • name:变量名,每次调用 getopts 时,把解析到的选项字母存入这个变量。
  • args:可选,要解析的参数列表。如果省略,默认解析 $@(即所有位置参数)。

每次执行 getopts,它就会从参数列表中取出下一个选项(如 -v),把选项字母放到变量 name 中,并返回真(0);若解析完毕或遇到 --,则返回假(非0)。因此我们通常把它放在 while 循环的条件里。


三、选项字符串(optstring)的奥秘

optstring 由一系列字符组成,每个字符代表一个选项。如果某个选项需要接参数,就在该字符后面加一个冒号 :。

示例:"vf:d:"

  • v —— 无参数选项
  • f —— 带参数选项(后面必须跟一个值)
  • d —— 带参数选项

静默错误处理:如果 optstring 的开头是冒号 :,则 getopts 进入静默模式。这时遇到未定义的选项或缺少参数时,不会自动打印错误信息,而是把错误标记交给脚本自行处理。例如 ":vf:d:"。


四、核心内置变量

getopts 工作时会设置几个关键变量,我们必须熟悉:

变量 含义
$name 即 while 中指定的变量名,每次保存当前解析到的选项字母(不含 -)
$OPTARG 当解析到一个带参数的选项时,此变量保存该选项的参数值
$OPTIND 当前待处理参数的位置索引(从1开始),初始为1。处理完所有选项后,可利用它来 shift 掉已处理的选项,剩下非选项参数。

错误提示相关:

  • 如果遇到无效选项(optstring 未定义),name 会被设为 ?。
  • 如果带参选项缺少参数,name 被设为 ?(非静默模式)或 :(静默模式下,且 optstring 以 : 开头)。
  • 同时 OPTARG 会被赋值为那个出错的选项字符。

五、工作流程与 OPTIND 的变化

假设命令行是:./script -a -b foo -c bar file1 file2

optstring="ab:c" (a无参,b有参,c无参)

初始 OPTIND=1(指向 -a)

  1. 第一次 getopts:解析到 -a,name=a,OPTIND 变为 2(指向 -b)
  2. 第二次:解析到 -b,发现 b 需要参数,于是取下一个参数 foo 赋给 OPTARG,name=b,OPTIND 变为 4(跳过了 foo,指向 -c)
  3. 第三次:解析到 -c,name=c,OPTIND=5(指向 bar)
  4. 第四次:bar 不以 - 开头(且也不是选项的参数),getopts 停止,返回非0,循环结束。此时 OPTIND=5。

如果想获取后面的 file1 file2,我们可以 shift $((OPTIND - 1)),然后 $@ 就是剩余的非选项参数了。


六、经典示例

示例 1:简单选项 -a -b -c

#!/bin/bash
# 文件名: test1.sh
while getopts "abc" opt; do
  case $opt in
    a) echo "选项 -a 被触发";;
    b) echo "选项 -b 被触发";;
    c) echo "选项 -c 被触发";;
    ?) echo "未知选项: -$OPTARG";;
  esac
done

运行:

$ ./test1.sh -a -b -c
选项 -a 被触发
选项 -b 被触发
选项 -c 被触发

$ ./test1.sh -a -x
选项 -a 被触发
./test1.sh: illegal option -- x   # 默认会打印错误
未知选项: -x

示例 2:带参数的选项

#!/bin/bash
# 文件名: backup.sh
while getopts "f:d:v" opt; do
  case $opt in
    f) file="$OPTARG"; echo "指定文件: $file";;
    d) dir="$OPTARG";  echo "指定目录: $dir";;
    v) verbose=1;      echo "详细模式开启";;
    ?) echo "用法: $0 [-v] [-f 文件] [-d 目录]"; exit 1;;
  esac
done

shift $((OPTIND - 1))
echo "剩余非选项参数: $@"

运行:

$ ./backup.sh -v -f data.txt -d /backup
详细模式开启
指定文件: data.txt
指定目录: /backup
剩余非选项参数:

$ ./backup.sh -f log.txt extra1 extra2
指定文件: log.txt
剩余非选项参数: extra1 extra2

注意:如果选项的参数本身以 - 开头(比如 -f -special),getopts 会认为 -special 是 -f 的参数,而不是新选项。因为 -f 要求带参数,所以下一个参数不管是不是以 - 开头,都会被当成它的参数。

示例 3:静默错误处理(自行定制错误信息)

#!/bin/bash
# 文件名: silent.sh
while getopts ":f:d:v" opt; do
  case $opt in
    f) file="$OPTARG";;
    d) dir="$OPTARG";;
    v) verbose=1;;
    :) echo "错误: -$OPTARG 需要一个参数"; exit 1;;   # 缺少参数
    ?) echo "错误: 无效选项 -$OPTARG"; exit 1;;       # 未知选项
  esac
done

关键点:optstring 以 : 开头,告诉 getopts 不要自动报错。当缺少参数时,opt 被设为 :,OPTARG 存放出错的选项字母;当选项无效时,opt 为 ?,OPTARG 存放那个无效字符。这样我们可以输出更友好的提示,而不是默认的英文错误。

运行:

$ ./silent.sh -f
错误: -f 需要一个参数

$ ./silent.sh -x
错误: 无效选项 -x

示例 4:结合非选项参数和 OPTIND

假设脚本既要处理选项,还要在选项之后接受文件名列表。

#!/bin/bash
# 文件名: process.sh
output_dir="."
verbose=0
while getopts "o:v" opt; do
  case $opt in
    o) output_dir=$OPTARG;;
    v) verbose=1;;
    *) echo "用法: $0 [-o output_dir] [-v] file..."; exit 1;;
  esac
done

shift $((OPTIND - 1))   # 移除所有已处理的选项及参数
if [ $# -eq 0 ]; then
    echo "错误: 必须指定至少一个文件"
    exit 1
fi

echo "输出目录: $output_dir"
echo "详细模式: $verbose"
echo "待处理文件: $@"

测试:

$ ./process.sh -o /tmp -v a.txt b.txt
输出目录: /tmp
详细模式: 1
待处理文件: a.txt b.txt

$ ./process.sh -v -o /out c.txt d.txt   # 选项顺序可以互换
输出目录: /out
详细模式: 1
待处理文件: c.txt d.txt

注意 -o 必须紧跟参数(或之间无空格也可以,-o/tmp 也合法),因为它是带参选项。


七、进阶特性与陷阱

1. 选项和参数之间可以没有空格

对于带参选项,-fdata.txt 等价于 -f data.txt。getopts 会自动把 f 后面的内容作为 OPTARG。

2. 如何表示“可选参数”的选项?

标准 getopts 不支持选项带可选参数。要么带,要么不带。如果你需要像 -o[filename] 这样(即 -o 后面参数可选的),bash 内置 getopts 无法直接做到,但可以通过一些技巧模拟,或考虑使用外部命令 getopt(注意它有个 :: 双冒号表示可选参数,但比较复杂且存在平台差异)。通常建议设计成要么必带参数,要么拆分为两个选项(如 -o 无参使用默认值,-O file 指定文件)。

3. -- 的约定

如果用户在命令行中放入 --,getopts 会在看到 -- 时停止处理选项,并将 -- 后的内容视为非选项参数。OPTIND 会指向 -- 后面的第一个参数。

例如:./script -a -- -b

  • -a 被正常解析。
  • 遇到 --,停止选项解析。
  • 后面 -b 成为普通参数,不会被当作选项。

4. 重置 OPTIND

如果你在同一个脚本中多次调用 getopts 处理不同部分的参数(比如先解析全局选项,再解析子命令选项),需要手动将 OPTIND 重置为 1。

5. 长选项?

Bash 的 getopts 只支持单字母短选项,不支持 --verbose 这样的长选项。如需长选项,可以考虑:

  • 用 getopt 外部命令(能同时支持长短选项,但语法较复杂,且需注意跨平台兼容性)
  • 自己写循环解析 -- 参数
  • 仅使用短选项,或提供长短选项的映射(但在解析时仍需自行处理)

八、常见错误与调试建议

  • 忘记加 shift $((OPTIND - 1)),导致后续文件参数中包含选项。
  • 在 case 里漏掉对 ? 或 : 的处理,导致错误时脚本行为怪异。
  • 将 optstring 写成 "vf:d:" 但误把 : 放到带参选项的前面(如 "v:fd" 会让 v 带参数),需要小心。
  • 调试时,可以在循环内 echo "opt=$opt, OPTARG=$OPTARG, OPTIND=$OPTIND",观察变量变化。

九、与 getopt 的简单对比

特性 getopts (bash内置) getopt (外部命令)
来源 bash 内置 util-linux 包(Linux)
语法简洁性 简单 相对复杂,需要处理 -- 和 set
长选项支持 无 有
可选参数选项 无 有(用 ::)
选项重排 不进行 可进行(混合选项参数位置)
可移植性 好(只要bash) 注意 BSD 和 GNU 版本差异

日常脚本如果仅需短选项,我会首选 getopts,因为它内置于 shell,零依赖且足够强大。


十、综合实战:一个实用的日志分析脚本框架

让我们写一个完整的脚本,包含选项解析、验证和默认值设置:

#!/bin/bash
set -euo pipefail

# 默认值
log_file="/var/log/syslog"
filter_keyword=""
verbose=0
output_format="text"

usage() {
    echo "用法: $0 [-f logfile] [-k keyword] [-v] [-o format]"
    echo "  -f  指定日志文件 (默认: /var/log/syslog)"
    echo "  -k  过滤关键字"
    echo "  -v  详细输出"
    echo "  -o  输出格式 (text|json), 默认 text"
    exit 1
}

while getopts ":f:k:vo:" opt; do
    case $opt in
        f) log_file="$OPTARG" ;;
        k) filter_keyword="$OPTARG" ;;
        v) verbose=1 ;;
        o)
            case "$OPTARG" in
                text|json) output_format="$OPTARG" ;;
                *) echo "错误: -o 只支持 text 或 json"; usage ;;
            esac
            ;;
        :) echo "错误: -$OPTARG 需要一个参数"; usage ;;
        ?) echo "错误: 未知选项 -$OPTARG"; usage ;;
    esac
done

shift $((OPTIND - 1))

# 可选的额外文件参数(比如直接列出要分析的文件)
if [ $# -gt 0 ]; then
    echo "额外参数将被忽略: $@"
fi

echo "========== 配置 =========="
echo "日志文件: $log_file"
echo "关键字:   ${filter_keyword:-无}"
echo "详细模式: $verbose"
echo "输出格式: $output_format"
echo "=========================="

# 后续处理逻辑...

测试:

$ ./analyze.sh -f app.log -k ERROR -v -o json
========== 配置 ==========
日志文件: app.log
关键字:   ERROR
详细模式: 1
输出格式: json
==========================
$ ./analyze.sh -o xml
错误: -o 只支持 text 或 json
...

总结

  • getopts 是 Bash 中解析短选项的标准方法,利用 while + case 结构。
  • 通过 optstring 定义选项,冒号 : 表示需要参数;前置 : 可以静默错误。
  • OPTARG 保存选项参数,OPTIND 跟踪解析位置,方便后续 shift。
  • 缺乏长选项支持是其主要局限,但绝大多数脚本用短选项已足够清晰。
  • 善用静默模式和错误处理,能构建非常健壮的用户界面。
THE END