如何在Bash中获取带有标志的参数


282

我知道我可以在bash中轻松获得像这样的定位参数:

$0 要么 $1

我希望能够使用这样的标志选项来指定每个参数的用途:

mysql -u user -h host

通过标志而不是通过位置获取-u param价值和-h param价值的最佳方法是什么?


2
这可能是一个好主意,问/在检查过unix.stackexchange.com以及
MRR0GERS

8
谷歌的“ bash getopts”-很多教程。
格伦·杰克曼2011年

89
@ glenn-jackman:我一定会在Google上搜索它,因为我知道这个名字了。关于Google的事情是-问一个问题-您应该已经知道答案的50%。
斯坦,

Answers:


290

这是我通常使用的成语:

while test $# -gt 0; do
  case "$1" in
    -h|--help)
      echo "$package - attempt to capture frames"
      echo " "
      echo "$package [options] application [arguments]"
      echo " "
      echo "options:"
      echo "-h, --help                show brief help"
      echo "-a, --action=ACTION       specify an action to use"
      echo "-o, --output-dir=DIR      specify a directory to store output in"
      exit 0
      ;;
    -a)
      shift
      if test $# -gt 0; then
        export PROCESS=$1
      else
        echo "no process specified"
        exit 1
      fi
      shift
      ;;
    --action*)
      export PROCESS=`echo $1 | sed -e 's/^[^=]*=//g'`
      shift
      ;;
    -o)
      shift
      if test $# -gt 0; then
        export OUTPUT=$1
      else
        echo "no output dir specified"
        exit 1
      fi
      shift
      ;;
    --output-dir*)
      export OUTPUT=`echo $1 | sed -e 's/^[^=]*=//g'`
      shift
      ;;
    *)
      break
      ;;
  esac
done

关键点是:

  • $# 是参数的数量
  • while循环查看提供的所有参数,并在case语句中匹配它们的值
  • 移走第一个。您可以在case语句内多次移动以采用多个值。

3
什么是--action*--output-dir*的情况下怎么办?
路西欧2014年

1
他们只是保存进入环境的价值。
Flexo

22
@Lucio超级旧评论,但添加此评论以防其他人访问此页面。*(通配符)适用于某人键入--action=[ACTION]的情况以及某人键入的情况--action [ACTION]
库珀

2
您为什么要*)中断,不退出还是忽略错误的选择?换句话说-bad -o dir-o dir零件永远不会被处理。
newguy

@newguy好问题。我想我试图让他们陷入困境
Flexo

427

此示例使用Bash的内置getopts命令,该命令来自《Google Shell样式指南》

a_flag=''
b_flag=''
files=''
verbose='false'

print_usage() {
  printf "Usage: ..."
}

while getopts 'abf:v' flag; do
  case "${flag}" in
    a) a_flag='true' ;;
    b) b_flag='true' ;;
    f) files="${OPTARG}" ;;
    v) verbose='true' ;;
    *) print_usage
       exit 1 ;;
  esac
done

注意:如果一个字符后跟一个冒号(例如f:),则该选项应带有一个参数。

用法示例: ./script -v -a -b -f filename

与公认的答案相比,使用getopts有几个优点:

  • 而while条件则更具可读性,并显示了接受的选项是什么
  • 清洁代码;不计算参数数量和移位
  • 您可以加入选项(例如-a -b -c-abc

但是,最大的缺点是它不支持长选项,仅支持单字符选项。


48
人们不禁要问,为什么这个答案,用一个bash内置的,不顶一个
威尔巴恩韦尔

13
为了后代:'abf:v'之后的冒号表示-f带有附加参数(在这种情况下为文件名)。
zahbaz

1
我必须将错误行更改为此:?) printf '\nUsage: %s: [-a] aflag [-b] bflag\n' $0; exit 2 ;;
Andy

7
您能添加有关结肠的注释吗?在每个字母之后,没有冒号表示没有arg,一个冒号表示一个arg,两个冒号表示可选的arg?
limasxgoesto0

3
@WillBarnwell应该注意,它是在问了问题三年后才添加的,而最重要的答案是在同一天添加的。
rbennell '18

47

getopt是您的朋友。.一个简单的例子:

function f () {
TEMP=`getopt --long -o "u:h:" "$@"`
eval set -- "$TEMP"
while true ; do
    case "$1" in
        -u )
            user=$2
            shift 2
        ;;
        -h )
            host=$2
            shift 2
        ;;
        *)
            break
        ;;
    esac 
done;

echo "user = $user, host = $host"
}

f -u myself -h some_host

/ usr / bin目录中应该有各种示例。


3
/usr/share/doc/util-linux/examples至少在Ubuntu计算机上,可以在目录中找到更广泛的示例。
Serge Stroobandt,2015年

10

我认为这将是您要实现的目标的简单示例。无需使用外部工具。内置的Bash工具可以为您完成这项工作。

function DOSOMETHING {

   while test $# -gt 0; do
           case "$1" in
                -first)
                    shift
                    first_argument=$1
                    shift
                    ;;
                -last)
                    shift
                    last_argument=$1
                    shift
                    ;;
                *)
                   echo "$1 is not a recognized flag!"
                   return 1;
                   ;;
          esac
  done  

  echo "First argument : $first_argument";
  echo "Last argument : $last_argument";
 }

这将允许您使用标志,因此无论您以什么顺序传递参数,都将获得正确的行为。

范例:

 DOSOMETHING -last "Adios" -first "Hola"

输出:

 First argument : Hola
 Last argument : Adios

您可以将此功能添加到您的配置文件中或将其放在脚本中。

谢谢!

编辑:将其另存为一个文件,然后执行为 yourfile.sh -last "Adios" -first "Hola"

#!/bin/bash
while test $# -gt 0; do
           case "$1" in
                -first)
                    shift
                    first_argument=$1
                    shift
                    ;;
                -last)
                    shift
                    last_argument=$1
                    shift
                    ;;
                *)
                   echo "$1 is not a recognized flag!"
                   return 1;
                   ;;
          esac
  done  

  echo "First argument : $first_argument";
  echo "Last argument : $last_argument";

我使用上面的代码,运行时不打印任何内容。./hello.sh DOSOMETHING -last "Adios" -first "Hola"
dinu0101 '17

@ dinu0101这是一个功能。不是脚本。您应该将其用作DOSOMETHING-最后的“ Adios”-第一个“ Hola”
Matias Barrios

谢谢@Matias。明白了 如何在脚本中运行。
dinu0101 '17

1
非常感谢@Matias
dinu0101 '17

2
使用return 1;与上一个例子输出can only 'return' from a function or sourced script在MacOS。切换到exit 1;预期的效果。
Mattias

5

另一种选择是使用类似于以下示例的方法,该方法允许您使用long --image或short -i标记,还允许使用已编译的-i =“ example.jpg”或单独的-i example.jpg方法来传递参数。

# declaring a couple of associative arrays
declare -A arguments=();  
declare -A variables=();

# declaring an index integer
declare -i index=1;

# any variables you want to use here
# on the left left side is argument label or key (entered at the command line along with it's value) 
# on the right side is the variable name the value of these arguments should be mapped to.
# (the examples above show how these are being passed into this script)
variables["-gu"]="git_user";  
variables["--git-user"]="git_user";  
variables["-gb"]="git_branch";  
variables["--git-branch"]="git_branch";  
variables["-dbr"]="db_fqdn";  
variables["--db-redirect"]="db_fqdn";  
variables["-e"]="environment";  
variables["--environment"]="environment";

# $@ here represents all arguments passed in
for i in "$@"  
do  
  arguments[$index]=$i;
  prev_index="$(expr $index - 1)";

  # this if block does something akin to "where $i contains ="
  # "%=*" here strips out everything from the = to the end of the argument leaving only the label
  if [[ $i == *"="* ]]
    then argument_label=${i%=*} 
    else argument_label=${arguments[$prev_index]}
  fi

  # this if block only evaluates to true if the argument label exists in the variables array
  if [[ -n ${variables[$argument_label]} ]]
    then
        # dynamically creating variables names using declare
        # "#$argument_label=" here strips out the label leaving only the value
        if [[ $i == *"="* ]]
            then declare ${variables[$argument_label]}=${i#$argument_label=} 
            else declare ${variables[$argument_label]}=${arguments[$index]}
        fi
  fi

  index=index+1;
done;

# then you could simply use the variables like so:
echo "$git_user";

3

我喜欢Robert McMahan的最佳答案,因为它似乎最容易制作成可共享的包含文件,以供您使用的任何脚本。但是,在行中if [[ -n ${variables[$argument_label]} ]]抛出“变量:错误的数组下标”消息似乎有一个缺陷。我没有代表对此发表评论,并且我怀疑这是否是正确的“解决方案”,但将其包装起来即可if进行if [[ -n $argument_label ]] ; then清理。

这是我最终得到的代码,如果您知道更好的方法,请在Robert的答案中添加注释。

包含文件“ flags-declares.sh”

# declaring a couple of associative arrays
declare -A arguments=();
declare -A variables=();

# declaring an index integer
declare -i index=1;

包含文件“ flags-arguments.sh”

# $@ here represents all arguments passed in
for i in "$@"
do
  arguments[$index]=$i;
  prev_index="$(expr $index - 1)";

  # this if block does something akin to "where $i contains ="
  # "%=*" here strips out everything from the = to the end of the argument leaving only the label
  if [[ $i == *"="* ]]
    then argument_label=${i%=*}
    else argument_label=${arguments[$prev_index]}
  fi

  if [[ -n $argument_label ]] ; then
    # this if block only evaluates to true if the argument label exists in the variables array
    if [[ -n ${variables[$argument_label]} ]] ; then
      # dynamically creating variables names using declare
      # "#$argument_label=" here strips out the label leaving only the value
      if [[ $i == *"="* ]]
        then declare ${variables[$argument_label]}=${i#$argument_label=} 
        else declare ${variables[$argument_label]}=${arguments[$index]}
      fi
    fi
  fi

  index=index+1;
done;

您的“ script.sh”

. bin/includes/flags-declares.sh

# any variables you want to use here
# on the left left side is argument label or key (entered at the command line along with it's value) 
# on the right side is the variable name the value of these arguments should be mapped to.
# (the examples above show how these are being passed into this script)
variables["-gu"]="git_user";
variables["--git-user"]="git_user";
variables["-gb"]="git_branch";
variables["--git-branch"]="git_branch";
variables["-dbr"]="db_fqdn";
variables["--db-redirect"]="db_fqdn";
variables["-e"]="environment";
variables["--environment"]="environment";

. bin/includes/flags-arguments.sh

# then you could simply use the variables like so:
echo "$git_user";
echo "$git_branch";
echo "$db_fqdn";
echo "$environment";

3

如果您熟悉Python argparse,并且不介意调用python来解析bash参数,那么我发现有一段代码非常有用且非常易于使用,称为argparse-bash https://github.com/nhoffman/ argparse-bash

示例取自他们的example.sh脚本:

#!/bin/bash

source $(dirname $0)/argparse.bash || exit 1
argparse "$@" <<EOF || exit 1
parser.add_argument('infile')
parser.add_argument('outfile')
parser.add_argument('-a', '--the-answer', default=42, type=int,
                    help='Pick a number [default %(default)s]')
parser.add_argument('-d', '--do-the-thing', action='store_true',
                    default=False, help='store a boolean [default %(default)s]')
parser.add_argument('-m', '--multiple', nargs='+',
                    help='multiple values allowed')
EOF

echo required infile: "$INFILE"
echo required outfile: "$OUTFILE"
echo the answer: "$THE_ANSWER"
echo -n do the thing?
if [[ $DO_THE_THING ]]; then
    echo " yes, do it"
else
    echo " no, do not do it"
fi
echo -n "arg with multiple values: "
for a in "${MULTIPLE[@]}"; do
    echo -n "[$a] "
done
echo

2

我提出了一个简单的TLDR:未启动的示例。

创建一个名为helloworld.sh的bash脚本

#!/bin/bash

while getopts "n:" arg; do
  case $arg in
    n) Name=$OPTARG;;
  esac
done

echo "Hello $Name!"

然后,您可以-n在执行脚本时传递可选参数。

这样执行脚本:

$ bash helloworld.sh -n 'World'

输出量

$ Hello World!

笔记

如果您想使用多个参数:

  1. 扩展while getops "n:" arg: do更多的参数,例如 while getops "n:o:p:" arg: do
  2. 通过额外的变量分配扩展大小写开关。如o) Option=$OPTARGp) Parameter=$OPTARG

1
#!/bin/bash

if getopts "n:" arg; then
  echo "Welcome $OPTARG"
fi

将其另存为sample.sh并尝试运行

sh sample.sh -n John

在您的终端中。


0

我在将getopts与多个标志一起使用时遇到了麻烦,因此我编写了这段代码。它使用模式变量来检测标志,并使用这些标志为变量分配参数。

请注意,如果一个标志不应该带有参数,则可以进行除设置CURRENTFLAG之外的其他操作。

    for MYFIELD in "$@"; do

        CHECKFIRST=`echo $MYFIELD | cut -c1`

        if [ "$CHECKFIRST" == "-" ]; then
            mode="flag"
        else
            mode="arg"
        fi

        if [ "$mode" == "flag" ]; then
            case $MYFIELD in
                -a)
                    CURRENTFLAG="VARIABLE_A"
                    ;;
                -b)
                    CURRENTFLAG="VARIABLE_B"
                    ;;
                -c)
                    CURRENTFLAG="VARIABLE_C"
                    ;;
            esac
        elif [ "$mode" == "arg" ]; then
            case $CURRENTFLAG in
                VARIABLE_A)
                    VARIABLE_A="$MYFIELD"
                    ;;
                VARIABLE_B)
                    VARIABLE_B="$MYFIELD"
                    ;;
                VARIABLE_C)
                    VARIABLE_C="$MYFIELD"
                    ;;
            esac
        fi
    done

0

所以这是我的解决方案。我希望能够处理不带连字符,带有一个连字符和带有两个连字符的布尔标志,以及带有一个和两个连字符的参数/值分配。

# Handle multiple types of arguments and prints some variables
#
# Boolean flags
# 1) No hyphen
#    create   Assigns `true` to the variable `CREATE`.
#             Default is `CREATE_DEFAULT`.
#    delete   Assigns true to the variable `DELETE`.
#             Default is `DELETE_DEFAULT`.
# 2) One hyphen
#      a      Assigns `true` to a. Default is `false`.
#      b      Assigns `true` to b. Default is `false`.
# 3) Two hyphens
#    cats     Assigns `true` to `cats`. By default is not set.
#    dogs     Assigns `true` to `cats`. By default is not set.
#
# Parameter - Value
# 1) One hyphen
#      c      Assign any value you want
#      d      Assign any value you want
#
# 2) Two hyphens
#   ... Anything really, whatever two-hyphen argument is given that is not
#       defined as flag, will be defined with the next argument after it.
#
# Example:
# ./parser_example.sh delete -a -c VA_1 --cats --dir /path/to/dir
parser() {
    # Define arguments with one hyphen that are boolean flags
    HYPHEN_FLAGS="a b"
    # Define arguments with two hyphens that are boolean flags
    DHYPHEN_FLAGS="cats dogs"

    # Iterate over all the arguments
    while [ $# -gt 0 ]; do
        # Handle the arguments with no hyphen
        if [[ $1 != "-"* ]]; then
            echo "Argument with no hyphen!"
            echo $1
            # Assign true to argument $1
            declare $1=true
            # Shift arguments by one to the left
            shift
        # Handle the arguments with one hyphen
        elif [[ $1 == "-"[A-Za-z0-9]* ]]; then
            # Handle the flags
            if [[ $HYPHEN_FLAGS == *"${1/-/}"* ]]; then
                echo "Argument with one hyphen flag!"
                echo $1
                # Remove the hyphen from $1
                local param="${1/-/}"
                # Assign true to $param
                declare $param=true
                # Shift by one
                shift
            # Handle the parameter-value cases
            else
                echo "Argument with one hyphen value!"
                echo $1 $2
                # Remove the hyphen from $1
                local param="${1/-/}"
                # Assign argument $2 to $param
                declare $param="$2"
                # Shift by two
                shift 2
            fi
        # Handle the arguments with two hyphens
        elif [[ $1 == "--"[A-Za-z0-9]* ]]; then
            # NOTE: For double hyphen I am using `declare -g $param`.
            #   This is the case because I am assuming that's going to be
            #   the final name of the variable
            echo "Argument with two hypens!"
            # Handle the flags
            if [[ $DHYPHEN_FLAGS == *"${1/--/}"* ]]; then
                echo $1 true
                # Remove the hyphens from $1
                local param="${1/--/}"
                # Assign argument $2 to $param
                declare -g $param=true
                # Shift by two
                shift
            # Handle the parameter-value cases
            else
                echo $1 $2
                # Remove the hyphens from $1
                local param="${1/--/}"
                # Assign argument $2 to $param
                declare -g $param="$2"
                # Shift by two
                shift 2
            fi
        fi

    done
    # Default value for arguments with no hypheb
    CREATE=${create:-'CREATE_DEFAULT'}
    DELETE=${delete:-'DELETE_DEFAULT'}
    # Default value for arguments with one hypen flag
    VAR1=${a:-false}
    VAR2=${b:-false}
    # Default value for arguments with value
    # NOTE1: This is just for illustration in one line. We can well create
    #   another function to handle this. Here I am handling the cases where
    #   we have a full named argument and a contraction of it.
    #   For example `--arg1` can be also set with `-c`.
    # NOTE2: What we are doing here is to check if $arg is defined. If not,
    #   check if $c was defined. If not, assign the default value "VD_"
    VAR3=$(if [[ $arg1 ]]; then echo $arg1; else echo ${c:-"VD_1"}; fi)
    VAR4=$(if [[ $arg2 ]]; then echo $arg2; else echo ${d:-"VD_2"}; fi)
}


# Pass all the arguments given to the script to the parser function
parser "$@"


echo $CREATE $DELETE $VAR1 $VAR2 $VAR3 $VAR4 $cats $dir

一些参考

  • 主要过程在这里找到
  • 有关在此处将所有参数传递给函数的更多信息
  • 有关默认值的更多信息,请点击此处
  • 有关declaredo的更多信息$ bash -c "help declare"
  • 有关shiftdo的更多信息$ bash -c "help shift"
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.