shell脚本高级命令--getopt 与 getopts 对比分析

invokerzhang 2019-11-10

概述

我们经常使用脚本 后面跟参数这种用法,这个时候使用getopt/getopts再合适不过了;今天主要详细说明 getopt (系统外部用法,后来增加的)与 getopts(内部,不支持长选项 只能是单个字符的短选项)的区别和用法。


一、帮助

shell脚本高级命令--getopt 与 getopts 对比分析


二、区别

getopt 与 getopts 都是 Bash 中用来获取与分析命令行参数的工具,常用在 Shell 脚本中被用来分析脚本参数。

两者的比较

(1)getopts 是 Shell 内建命令,getopt 是一个独立外部工具

(2)getopts 使用语法简单,getopt 使用语法较复杂

(3)getopts 不支持长参数(如:--option ),getopt 支持

(4)getopts 不会重排所有参数的顺序,getopt 会重排参数顺序(这里的区别下面会说明)

(5)getopts 出现的目的是为了代替 getopt 较快捷的执行参数分析工作


三、getopts实例

shell脚本高级命令--getopt 与 getopts 对比分析

getopts后面的字符串就是可以使用的选项列表,每个字母代表一个选项,后面带:的意味着选项除了定义本身之外,还会带上一个参数作为选项的值,比如d:在实际的使用中就会对应-d 30,选项的值就是30;getopts字符串中没有跟随:的是开关型选项,不需要再指定值,相当于true/false,只要带了这个参数就是true。如果命令行中包含了没有在getopts列表中的选项,会有警告信息,如果在整个getopts字符串前面也加上个:,就能消除警告信息了。

使用getopts识别出各个选项之后,就可以配合case来进行相应的操作了。操作中有两个相对固定的“常量”,一个是OPTARG,用来取当前选项的值,另外一个是OPTIND,代表当前选项在参数列表中的位移。注意case中的最后一个选择──?,代表这如果出现了不认识的选项,所进行的操作。
选项参数识别完成之后,如果要取剩余的其它命令行参数,可以使用shift把选项参数抹去,就像例子里面的那样,对整个参数列表进行左移操作,最左边的参数就丢失了(已经用case判断并进行了处理,不再需要了),位移的长度正好是刚才case循环完毕之后的OPTIND - 1,因为参数从1开始编号,选项处理完毕之后,正好指向剩余其它参数的第一个。在这里还要知道,getopts在处理参数的时候,处理一个开关型选项,OPTIND加1,处理一个带值的选项参数,OPTIND则会加2。
最后,真正需要处理的参数就是1 1 #了,可以用for循环依次处理。

使用getopts处理参数虽然是方便,但仍然有两个小小的局限:
1)选项参数的格式必须是-d val,而不能是中间没有空格的-dval。
2)所有选项参数必须写在其它参数的前面,因为getopts是从命令行前面开始处理,遇到非-开头的参数,或者选项参数结束标记--就中止了,如果中间遇到非选项的命令行参数,后面的选项参数就都取不到了。
3)不支持长选项, 也就是--debug之类的选项

测试结果:

 

shell脚本高级命令--getopt 与 getopts 对比分析


四、getopt实例

#!/bin/bash 
# 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

shell脚本高级命令--getopt 与 getopts 对比分析

测试:

shell脚本高级命令--getopt 与 getopts 对比分析


五、综合实例

shell脚本高级命令--getopt 与 getopts 对比分析

shell脚本高级命令--getopt 与 getopts 对比分析

这个脚本整体思路是:

先判断是否有getopt命令,如果有就用这个命令 没有的话 采用getopts命令;

getopt 判断体中 首先判断 第一个参数如果是 -a|–appid,则shift 后移一位 也是就是-a 参数后面的值(如果有的话)保存起来; shift 执行一次,然后1( 1(1({1}写法也可以)就变成第三个参数了, 如果 -f|–fusion是第一个参数,操作效果和上面一样;如果第一个参数是 -h|–help 的话调用Usage方法并执行exit 0 退出;

如果第一个参数是 – 则shift 一下,break 跳出整个循环,(continue一般是 跳出当前循环,然后开始新的循环); 如果第一个参数是为其他(?通配其他内容)调用Usage方法并执行exit 1退出

ps:

basename $0值显示当前脚本或命令的名字
shift 命令每执行一次,变量的个数($#)减一,而变量值提前一位
比如shift 3表示原来的$4现在变成$1,原来的$5现在变成$2等等,原来的$1、$2、$3丢弃,$0不移动。不带参数的shift命令相当于shift 1
$#: 参数的个数
$*: 参数列表 所有的参数 作为一个整体 如 ./xx.sh 1 2 3, $*值为“1 2 3”
$@: 参数列表 所有参数 逐个输出 如 ./xx.sh 1 2 3 $@ 值为"1" “2” “3”
set -- "${ARGS}" 相当于重置了 执行脚本 后跟参数,把执行脚本后跟参数‘$@’ 变成了 ${ARGS}

这个还是有点难度的,大家有空可以自己测试研究一下,大概半个小时就可以掌握了。

觉得有用的朋友多帮忙转发哦!后面会分享更多devops和DBA方面的内容,感兴趣的朋友可以关注下~

shell脚本高级命令--getopt 与 getopts 对比分析

相关推荐