Bash脚本中getopts无法为变量赋值的问题

脚本初始化dag='false'，期望传入-d参数时通过getopts将dag设为'true'，但实际执行后dag仍为false。

脚本代码 #

#! /usr/bin/bash

dag='false'
replacement=''

print_usage() {
  echo "Usage: `basename $0` [-h] [-d] [-r]"
  echo "This script find all texts that match the given text pattern in the given repository,"
  echo "then delete these texts or replace them with new text if -r is given, reformat each files."
  echo "Optionally, it can generate DAG which can be used as test plan."
  echo
  echo "Syntax: remove_optin_filters.sh <path to repository> <regex-style match pattern> -r(optional) <replacement> -d(optional, to generate DAG)"
  echo
  echo "positional arguments:"
  echo "path_to_repository          path to the desired directory"
  echo "match_pattern               regex-style pattern to match text"
  echo
  echo "options:"
  echo "-h                          Print this Help"
  echo "-d                          Generate DAG to all files changed and save them to pastry"
  echo "-r                          replace text with provided text"
  exit 0
}

while getopts 'dhr:' flag; do
  case "${flag}" in
    d) dag='true' ;; 
    h) print_usage ;; 
    r) replacement="${OPTARG}" ;; 
    \?) echo "Incorrect usage";;;
  esac
done

echo $dag

# first argument is the repository path
repo=./$1

# second argument is the regex pattern to match text
pattern=$2

# find all files+patterns in given repository that match the given pattern,
# and save to sg file. (sg is temp file and will be removed at the end)
find $repo -type f -name "*.py" -exec grep -iH "$pattern" {} \; > sg

# retrieve all the file pathes. Dedup, sort and remove the trailing colon
# save them to sg_unique file. (sg_unique is temp file and will be removed at the end)
cat sg | awk '{ print $1; }' | uniq | sort > sg_unique
sed -i "s/:$//" sg_unique

# remove or replace the texts from all files
if [ "$replacement" == "" ]
then
  for l in $(cat sg_unique); do sed -i "s/$pattern//ig" $l; done
else
  for l in $(cat sg_unique); do sed -i "s/$pattern/$replacement/ig" $l; done
fi

# format all files
for l in $(cat sg_unique); do arc dsfmt $l; done

# option(flag = -d): generate DAG for all files and save them to pastry
if [ "$dag" == "true" ];
then
  echo "Generate DAG..."
   for l in $(cat sg_unique); do echo "$l"; ./status --tree -q $l; echo ""; done |& pastry
else
  echo "No DAG verified"
fi

# clean out temp files
rm sg
rm sg_unique

执行命令与结果 #

执行命令 #

./remove_optin_filters.sh <repository> "AND COALESCE(privacy_optin_flag, 'ON') = 'ON'\|AND latest_privacy_optin_flag = 'ON'\|AND privacy_optin_flag = 'ON'" -d

执行结果 #

false
No DAG verified

原因分析 #

bash内置的getopts工具仅会解析位于位置参数之前的选项。你的执行命令中，-d放在了两个位置参数（仓库路径、匹配正则）之后，getopts在遍历到位置参数时就停止了解析，完全没读取到-d参数，因此dag变量始终保持初始值false。

修复方案 #

方案1：调整命令参数顺序（最简单） #

将所有选项参数放在位置参数之前执行：

./remove_optin_filters.sh -d <repository> "AND COALESCE(privacy_optin_flag, 'ON') = 'ON'\|AND latest_privacy_optin_flag = 'ON'\|AND privacy_optin_flag = 'ON'"

方案2：修改脚本适配任意位置的选项（更灵活） #

如果需要支持选项在位置参数的任意位置，可以改用getopt（注意是带e的外部工具，非内置getopts），或者在脚本中调整参数处理逻辑。以下是基于getopts的兼容修改：

在getopts循环结束后，添加shift命令跳过已处理的选项，确保后续位置参数正确获取：

while getopts 'dhr:' flag; do
  case "${flag}" in
    d) dag='true' ;; 
    h) print_usage ;; 
    r) replacement="${OPTARG}" ;; 
    \?) echo "Incorrect usage" && exit 1;;;
  esac
done

# 跳过已解析的选项，让后续位置参数索引正确
shift $((OPTIND - 1))

echo $dag

# 现在$1和$2对应正确的位置参数
repo=./$1
pattern=$2

若要完全支持选项在任意位置，可使用getopt工具实现：

# 用getopt解析参数
OPTIONS="dhr:"
LONGOPTIONS="help,dag,replace:"

# 解析参数
PARSED=$(getopt --options=$OPTIONS --longoptions=$LONGOPTIONS --name "$0" -- "$@")
if [[ $? -ne 0 ]]; then
  exit 1
fi

# 应用解析结果
eval set -- "$PARSED"

# 遍历处理参数
while true; do
  case "$1" in
    -d|--dag)
      dag='true'
      shift
      ;;
    -h|--help)
      print_usage
      ;;
    -r|--replace)
      replacement="$2"
      shift 2
      ;;
    --)
      shift
      break
      ;;
    *)
      echo "Incorrect usage"
      exit 1
      ;;
  esac
done

# 处理位置参数
repo=./$1
pattern=$2

验证结果 #

修改后执行对应命令，dag变量会被正确设为true，脚本输出：

true
Generate DAG...

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