【5.1】bash-传参数

方法一: 手动传参

在手工处理方式中,首先要知道几个变量,还是以上面的命令行为例:

  • $0 : ./test.sh,即命令本身,相当于C/C++中的argv[0]
  • $1 : -f,第一个参数. $2 : config.conf
  • $3, $4 … :类推。
  • $# 参数的个数,不包括命令本身,上例中$#为4.
  • $@ :参数本身的列表,也不包括命令本身,如上例为 -f config.conf -v –prefix=/home
  • $* :和$@相同,但”$*” 和 “$@”(加引号)并不同,”$** “将所有的参数解释成一个字符串,而”$@“是一个参数数组。

如下例所示:

#!/bin/bash

 for arg in "$*"
 do
    echo $arg
 done

 for arg in "$@"
 do
    echo $arg
 done

执行./test.sh -f config.conf -n 10 会打印:

-f config.conf -n 10 #这是”$*“的输出

#以下为$@的输出

-f 

config.conf
-n
10

所以,手工处理的方式即对这些变量的处理。因为手工处理高度依赖于你在命令行上所传参数的位置,所以一般都只用来处理较简单的参数。如

“./test.sh 10”,而很少使用“./test -n 10”这种带选项的方式。 典型用法为:

#!/bin/bash

#if [ -n "$1" ],参数不为空
if [ "$1" != "" ]
then
    #...有参数
else
then
    #...没有参数
fi

手工处理方式能满足大多数的简单需求,配合shift使用也能构造出强大的功能,但在要处理复杂选项的时候建议用下面的两种方法。

二、getopts/getopt

处理命令行参数是一个相似而又复杂的事情,为此,C提供了getopt/getopt_long等函数,C++的boost提供了Options库,在shell中,处理此事的是getopts和getopt.getopts和getopt功能相似但又不完全相同,其中getopt是独立的可执行文件,而getopts是由Bash内置的。先来看看参数传递的典型用法:

  • ./test.sh -a -b -c : 短选项,各选项不需参数
  • ./test.sh -abc : 短选项,和上一种方法的效果一样,只是将所有的选项写在一起。
  • ./test.sh -a args -b -c :短选项,其中-a需要参数,而-b -c不需参数。
  • ./test.sh –a-long=args –b-long :长选项

我们先来看getopts,它不支持长选项。使用getopts非常简单:–test.sh

#!/bin/bash
#选项后面的冒号表示该选项需要参数
while getopts "a:bc" arg
do
        case $arg in
             a)
                #参数存在$OPTARG中
                echo "a's arg:$OPTARG" ;;
             b)
                echo "b" ;;
             c)
                echo "c" ;; 
             ?)
                #当有不认识的选项的时候arg为?
                echo "unkonw argument" exit 1 ;;
         esac
done

现在就可以使用:./test.sh -a arg -b -c 或./test.sh -a arg -bc 来加载了。

应该说绝大多数脚本使用该函数就可以了,如果需要支持长选项以及可选参数,那么就需要使用getopt.下面是getopt自带的一个例子:

#!/bin/bash

# A small example program for using the new getopt(1) program.
# This program will only work with bash(1)
# An similar program using the tcsh(1) script language can be found
# as parse.tcsh

# Example input and output (from the bash prompt):
# ./parse.bash -a par1 'another arg' --c-long 'wow!*\?' -cmore -b " very long "
# Option a
# Option c, no argument
# Option c, argument `more'
# Option b, argument ` very long '
# Remaining arguments:
# --> `par1'
# --> `another arg'
# --> `wow!*\?'

# Note that we use `"$@"' to let each command-line parameter expand to a
# separate word. The quotes around `$@' are essential!
# We need TEMP as the `eval set --' would nuke the return value of getopt.

#-o表示短选项,两个冒号表示该选项有一个可选参数,可选参数必须紧贴选项
#如-carg 而不能是-c arg
#--long表示长选项
#"$@"在上面解释过
# -n:出错时的信息
# -- :举一个例子比较好理解:
#我们要创建一个名字为 "-f"的目录你会怎么办?
# mkdir -f #不成功,因为-f会被mkdir当作选项来解析,这时就可以使用
# mkdir -- -f 这样-f就不会被作为选项。

TEMP=`getopt -o ab:c:: --long a-long,b-long:,c-long:: \
     -n 'example.bash' -- "$@"`

if [ $? != 0 ] ; then echo "Terminating..." >&2 ; exit 1 ; fi

# Note the quotes around `$TEMP': they are essential!
#set 会重新排列参数的顺序,也就是改变$1,$2...$n的值,这些值在getopt中重新排列过了
eval set -- "$TEMP"

#经过getopt的处理,下面处理具体选项。

while true ; do
        case "$1" in
                -a|--a-long) echo "Option a" ; shift ;;
                -b|--b-long) echo "Option b, argument \`$2'" ; shift 2 ;;
                -c|--c-long)
                        # c has an optional argument. As we are in quoted mode,
                        # an empty parameter will be generated if its optional
                        # argument is not found.
                        case "$2" in
                                "") echo "Option c, no argument"; shift 2 ;;
                                *)  echo "Option c, argument \`$2'" ; shift 2 ;;
                        esac ;;
                --) shift ; break ;;
                *) echo "Internal error!" ; exit 1 ;;
        esac
done
echo "Remaining arguments:"
for arg do
   echo '--> '"\`$arg'" ;
done

比如我们使用

./test -a  -b arg arg1 -c 

你可以看到,命令行中多了个arg1参数,在经过getopt和set之后,命令行会变为:

-a -b arg -c – arg1

$1指向-a,$2指向-b,$3指向arg,$4指向-c,$5指向–,而多出的arg1则被放到了最后。

案例

#!/bin/bash
# Example: args parse



usage() {
    local prog="`basename $1`"
    echo "Usage: $prog -n name1 [name2...] [-c count] [-D DestDir]"
    echo "       $prog -h for help."
    exit 1
}

showhelp() {
    echo "Usage: `basename $1`: -n name1 [name2...] [-c count] [-D OutputDir]" 
    echo "  -n target name (\"None\" for no tag)"
    echo "  -c count for each name (\"None\"=1)"
    echo "  -D output directory"
    echo "  -h show this help"
    exit 1
}


name=
count=
outputdir=
file="${!#}"
filename="`basename $file`"
run=false       # once for "None"


while getopts "n:c:D:h" arg
do
    case $arg in
        n)  name=$OPTARG;;
        c)  count=$OPTARG;;
        D)  outputdir=$OPTARG;;
        h)  showhelp $0;;
        ?)  usage $0;;
    esac
done


#[ ! -f $file ] && usage $0 
[ -z "$name" ] && usage $0
[ -z "$count" ] && count=1
[ -z "$outputdir" ] && outputdir="`dirname $file`"


for n in $name
do
    for((c=0; c<count; c++))
    do
        if [ "None" == "$n" ];then
            if [ "false" == "$run" ];then
                run=true
                c=""
            else
                break
            fi
        fi
        suffix="${n}${c}"
        echo $filename | sed "s/.iso$/-${suffix}.iso/"
    done
done

exit 0

参考资料

个人公众号,比较懒,很少更新,可以在上面提问题,如果回复不及时,可发邮件给我: tiehan@sina.cn

Sam avatar
About Sam
专注生物信息 专注转化医学