无法正确读取Bash Shell脚本参数，寻求问题排查与解决方法

问题描述 #

我执行以下命令运行Bash脚本：

sh test.sh -s "xyz" -e staging --files file1 --tags tags

使用的代码如下：

options=$(getopt --long service:,environment:,help::,files::,tags:: -o s:e:h::f::t:: -- "$@")
eval set -- "$options"

for opt; do
    echo "$opt :: $2"
    case "$opt" in
        -h|--help) 
            echo "help"
            exit 0
            ;;
        -s|--service)
            service_name="$2"
            echo "Option chosen - service --> ${service_name}"
            shift
            ;;
        -e|--env)
            environment_name="$2"
            echo "Option chosen - environment --> ${environment_name}"
            shift
            ;;
        -t|--tags)
            tag_names="$2"
            echo "Option chosen - tags -> $tag_names"
            shift
            ;;
        -f|--files)
            filenames="$2"
            echo "Option chosen - files -> ${2}"
            shift
            ;;
        --)
            shift
            break;;
        \?)
            echo "Error: Invalid option"
            exit 0
            ;;
    esac
    shift
done

但得到的执行结果不符合预期：

-s :: xyz
Option chosen - service --> xyz
xyz :: staging
-e :: --files
Option chosen - environment --> --files
staging :: --tags
--files :: 
Option chosen - files -
 :: file1
--tags :: tags
Option chosen - tags -> tags
 :: 
-- :: 

期望的结果是：

-s :: xyz
Option chosen - service --> xyz
-e :: staging
Option chosen - environment --> staging
--files :: file1
Option chosen - files -> file1
--tags :: tags
Option chosen - tags -> tags

可以看到environment和files参数读取不正确，尝试过使用shift 2也无法解决，请问问题出在哪里？

错误原因分析 #

• 长选项与短选项不匹配：短选项-e对应的长选项在getopt里定义的是environment:，但代码case分支里写的是-e|--env，长选项名错误，导致getopt解析后无法正确匹配-e的参数。
• 选项参数类型定义错误：getopt中双冒号::表示可选参数（参数需紧跟选项，如--filesfile1），但你的用法是--files file1这种必填参数形式，应使用单冒号:；同时--help是无参数选项，不需要加冒号。
• 循环内shift逻辑冗余：原代码在case分支内shift一次，循环末尾又shift一次，对于带参数的选项，会导致指针多移动一次，打乱后续参数顺序。

修正后的代码 #

# 修正getopt选项定义：必填参数用单冒号，help无参数
options=$(getopt --long service:,environment:,help,files:,tags: -o s:e:hf:t: -- "$@")
eval set -- "$options"

while true; do
    case "$1" in
        -h|--help) 
            echo "help"
            exit 0
            ;;
        -s|--service)
            service_name="$2"
            echo "Option chosen - service --> ${service_name}"
            shift 2  # 一次性跳过选项和参数
            ;;
        -e|--environment)  # 修正长选项名，与getopt定义一致
            environment_name="$2"
            echo "Option chosen - environment --> ${environment_name}"
            shift 2
            ;;
        -t|--tags)
            tag_names="$2"
            echo "Option chosen - tags -> $tag_names"
            shift 2
            ;;
        -f|--files)
            filenames="$2"
            echo "Option chosen - files -> ${2}"
            shift 2
            ;;
        --)
            shift
            break
            ;;
        \?)
            echo "Error: Invalid option"
            exit 1
            ;;
        *)
            echo "Unexpected option: $1"
            exit 1
            ;;
    esac
done

修正说明 #

1. 调整getopt选项定义：将help::,files::,tags::改为help,files:,tags:，明确help无参数，files和tags为必填参数。
2. 修正case分支中-e对应的长选项为--environment，与getopt定义保持一致。
3. 使用while true循环替代for opt，并在每个带参数的选项分支中用shift 2一次性跳过选项和其参数，避免多次shift导致的指针混乱。
4. 新增*)分支处理意外选项，提升脚本健壮性。

内容的提问来源于stack exchange，提问作者Aritra Nayak