设计shell脚本选项：getopt
man 1 getopt翻译：http://www.javashuo.com/article/p-majexvln-ca.htmlhtml
写shell脚本的时候，经过while、case、shift来设计脚本的命令行选项是一件比较麻烦的事，由于Unix命令行的选项和参数自由度很高，支持短选项和长选项，参数多是可选的，选项顺序多是无所谓的，等等。mysql
bash下的getopt命令能够解析命令行的选项和参数，将散乱、自由的命令行选项和参数进行改造，获得一个完整的、规范化的参数列表，这样再使用while、case和shift进行处理就简单的太多了。sql
getopt有不一样的版本，本文介绍的是它的加强版(enhanced)，相比传统的getopt(也称为兼容版本的getopt)，它提供了引号保护的能力。另外，除了不一样版本的getopt，bash还有一个内置命令getopts(注意，有个尾随的字符s)，也用来解析命令行选项，但只能解析短选项。shell
要验证安装的getopt是加强版的仍是传统版的，使用getopt -T判断便可。若是它什么都不输出，则是加强版，此时它的退出状态码为4。若是输出"--"，则是传统版的getopt，此时它的退出状态码为0。若是想在脚本中进行版本检查，能够参考以下代码：bash
getopt -T &>/dev/null;[ $? -ne 4 ] && { echo "not enhanced version";exit 1; }
1.命令行选项的那些事
在学习getopt如何使用以前，必须先知道命令行的一些常识。这些，均可以经过getopt来实现，但有些实现起来可能会比较复杂。app
1.区分option、parameter、argument、option argument和non-option parameter模块化
parameter和argument都表示参数，前者一般表示独立性的参数，后者一般表示依赖于其它实体的参数。parameter的含义更广，argument能够看做parameter的一种。函数
例如，定义函数时function foo(x,y){CODE}，函数的参数x和y称为parameter。调用函数并传递参数时，foo(arg1,arg2)中的arg1和arg2都是依赖于函数的，称为argument更合适，固然也能够称为更普遍的parameter。学习
再例如，一个命令行：命令行
tar -zcf a.tar.gz /etc/pki
粗分的话，-z、-c、-f、a.tar.gz、/etc/pki均可以称为parameter。细分的话：
- "-z -c -f"称为选项，即option
- a.tar.gz是选项"-f"的选项参数(传递给选项的参数)，依赖于选项，称为argument更合适，更严格的称呼是option argument
- /etc/pki既不属于选项，也不属于某个选项的参数，它称为非选项类型的参数，对应的名称为non-option parameter
本文要介绍的是getopt，因此只考虑命令行参数的状况。
2.短选项和长选项以及它们的"潜规则"
Linux中绝大多数命令都提供了短选项和长选项。通常来讲，短选项是只使用一个"-"开头，选项部分只使用一个字符，长选项是使用两个短横线(即"--")开头的。
例如"-a"是短选项，"--append"是长选项。
通常来讲，选项的顺序是无所谓的，但并不是绝对如此，有时候某些选项必须放在前面，必须放在某些选项的前面、后面。
通常来讲，短选项：
能够经过一个短横线"-"将多个短选项链接在一块儿，但若是连在一块儿的短选项有参数的话，则必须做为串联的最后一个字符。
例如"-avz"其实会被解析为"-a -v -z"，
tar -zcf a.tar.gz串联了多个短选项，但"-f"选项有参数a.tar.gz，因此它必须做为串联选项的最后一个字符。- 短选项的参数能够和选项名称连在一块儿，也能够是用空白分隔。例如
-n 3和-n3是等价的，数值3都是"-n"选项的参数值。
若是某个短选项的参数是可选的，那么它的参数必须紧跟在选项名后面，不能使用空格分开。至于为何，见下面的第3项。
通常来讲，长选项：
- 可使用等号或空白链接两种方式提供选项参数。例如
--file=FILE或--file FILE。
- 若是某个长选项的参数是可选的，那么它的参数必须使用"="链接。至于为何，见下面的第3项。
- 长选项通常能够缩写，只要不产生歧义便可。
例如，ls命令，以"a"开头的长选项有3个。
$ ls --help | grep -- '--a'
-a, --all do not ignore entries starting with .
-A, --almost-all do not list implied . and ..
--author with -l, print the author of each file
若是想要指定--almost-all，能够缩写为--alm；若是想要指定--author，能够缩写为--au。若是只缩写为"--a"，bash将给出错误提示，长选项出现歧义：
$ ls --a ls: option '--a' is ambiguous; possibilities: '--all' '--author' '--almost-all' Try 'ls --help' for more information.
3.不带参数的选项、可选参数的选项和带参数的选项
有不一样类型的命令行选项，这些选项可能不须要参数，也可能参数是可选的，也多是强制要求参数的。
前面说了，若是某个选项的参数是可选的，那么它的参数必须不能使用空格将参数和选项分开。若是使用空格分隔，则没法判断它的下一个元素是该选项的参数仍是非选项类型的参数。
例如，-c和--config选项的参数是可选的，要向这两个选项提供参数，必须写成-cFILE、--config=FILE，若是写成-c FILE、--config FILE，那么命令行将没法判断这个FILE是提供给选项的参数，仍是非选项类型的参数。
通常来讲，使用可选参数的状况很是少，至少我目前回忆不起来这样的命令(mysql -p选项是一个)。
4.使用"--"将选项(及它们的选项参数)与非选项类型参数进行分隔
unix的命令行中，老是能够在非选项类型的参数以前加上"--"，表示选项和选项参数到此为止，后面的都是非选项类型的参数。
例如：
seq -w -- 3 seq -w -- 1 3
分别表示3和"1 3"是seq的非选项类型参数，而"--"前面的必定是选项或选项参数。
5.命令行参数中的短横线开头的并不必定老是短选项，也多是负数参数
例如seq命令：
seq -w -5 -1 5
其中-5和-1都是负数非选项类型的参数。
6.选项的依赖性和互斥性
有些命令的选项是有依赖性和互斥性的。好比某个选项要和另外一个选项一块儿使用，某个选项不能和另外一个选项一块儿使用。
例如--manage --remove，只有在使用了--manage的前提下才能使用--remove，不然就应该报错。
7.模式化(模块化)类型的选项
不少unix命令都将选项进行模块化设计。例如ip命令，address模式、route模式、link模式等等。
ip addr OPTIONS ip route OPTIONS ip link OPTIONS ip neigh OPTIONS
8.其余特性的选项
有些命令还有比较个性化的选项。
好比head命令，-n NUM选项，便可以指定为-3，也能够指定为-n 3或-n3。
再好比有的命令支持逻辑运算，例如find命令的-a、-o选项。
2.getopt解析选项的工做机制
bash的getopt命令常常用在shell脚本内部或函数内部，用来解析脚本执行或函数执行时传递的选项、参数。
下面都以命令行为例解释getopt是如何解析参数的，但用来解析函数参数是同样的。
2.1 getopt选项
下面这个是最经常使用的getopt解析方式(有这个命令就够了)。若是要了解getopt更完整的语法，见man getopt。
getopt -o SHORT_OPTIONS -l LONG_OPTIONS -n "$0" -- "$@"
其中：
-o SHORT_OPTIONS
--options SHORT_OPTIONS
getopt经过"-o"选项收集命令行传递的短选项和它们对应的参数。关于SHORT_OPTIONS的格式见下一小节。
-l LONG_OPTIONS
--longoptions LONG_OPTIONS
getopt经过"-l"选项收集命令行传递的长选项和它们对应的参数。可能从别人的脚本中常常看到"--long"，是等价的，前文已经解释过，长选项只要不产生歧义，是能够进行缩写的。关于LONG_OPTIONS的格式见下一小节。
-n NAME
getopt在解析命令行时，若是解析出错(例如要求给参数的选项没带参数，使用了没法解析的选项等)将会报告错误信息，getopt将使用该NAME做为报错的脚本名称。
-- "$@"
其中--表示getopt命令自身的选项到此结束，后面的元素都是要被getopt解析的命令行参数。这里使用"$@"，表示全部的命令行参数。注意，不能省略双引号。
2.2 getopt如何解析选项和参数
getopt使用"-o"或"-l"解析短、长选项和参数时，将会对每一个解析到的选项、参数进行输出，而后不断放进一个字符串中。这个字符串的内容就是完整的、规范化的选项和参数。
getopt使用"-o"选项解析短选项时：
- 多个短选项能够连在一块儿
- 若是某个要解析的选项须要一个参数，则在选项名后面跟一个冒号
- 若是某个要解析的选项的参数可选，则在选项名后面跟两个冒号
- 例如，
getopt -o ab:c::中，将解析为-a -b arg_b -c [arg_c]，arg_b是-b选项必须的，arg_c是-c选项可选的参数，"-a"选项无需参数
getopt使用"-l"选项解析长选项时：
- 能够一次性指定多个选项名称，须要使用逗号分隔它们
- 能够屡次使用-l选项，屡次解析长选项
- 若是某个要解析的选项须要一个参数，则在选项名后面跟一个冒号
- 若是某个要解析的选项的参数可选，则在选项名后面跟两个冒号
- 例如，
getopt -l add:,remove::,show中，将解析为--add arg_add --remove [arg_rem] --show，其中arg_add是--add选项必须的，--remove选项的参数arg_rem是可选的，--show无需参数
若是解析的是带参数的选项，则getopt生成的字符串中，会将选项的参数值做为该选项的下一个参数。若是解析的是可选参数的选项，若是为该选项设置了参数，则会将这个参数放在选项的下一个参数位置，若是没有为该选项设置参数，则会生成一个用引号包围的空字符串做为选项的下一个参数。
getopt解析完选项和选项的参数后，将解析非选项类型的参数(non-option parameter)。getopt为了让非选项类型的参数和选项、选项参数区分开，将在解析第一个非选项类型参数时加上一个"--"到字符串中，表示选项和选项参数到此结束，而后将全部的非选项类型参数放在这个"--"参数以后。
默认状况下，该增强版本的getopt会将全部参数值(包括选项参数、非选项类型的参数)使用引号进行包围，以便保护空白字符和特殊字符。若是是兼容版本的getopt，则不会用引号保护，因此会破坏参数解析。
看后面的示例就很容易理解了。
2.3 示例分析getopt的解析方式
例如在脚本test.sh中，下面的getopt的结果保存到变量parameters中，而后输出getopt解析完成后获得的完整参数列表。
#!/usr/bin/env bash parameters=`getopt -o ab:c:: --long add:,remove::,show -n "$0" -- "$@"` echo "$parameters"
若是还不知道这里的-o和--long解析了什么东西，请回头仔细再看一遍。
执行这个脚本，并给这个脚本传递一些选项和参数，这些脚本参数将被收集到$@，而后被getopt解析。
$ ./test.sh -a non-op_arg1 -b b_short_arg non-op_arg2 --rem --add /path --show -c non-op_arg3 -a -b 'b_short_arg' --remove '' --add '/path' --show -c '' -- 'non-op_arg1' 'non-op_arg2' 'non-op_arg3'
首先能够看出，传递给脚本的参数都是无序的：
- 长选项有：
--rem：是--remove的缩写形式，它的参数是可选的，但没有为它传递参数
--add：并设置了该选项的参数/path
--show：没有任何参数
- 短选项有：
-a：它是无需参数的选项，因此它后面的non-op_arg1是一个非选项类型的参数
-b：它是必须带参数的选项，因此b_short_arg是它的参数
-c：它的参数是可选的，这里没有给它提供参数(前面解释过，要给参数可选的选项提供参数，短选项时，参数和选项名称必须连在一块儿)。
- 非选项类型的参数有：
- non-op_arg1
- non-op_arg2
- non-op_arg3
- non-op_arg1
从getopt的输出结果中，能够看出：
- 先解析选项和选项参数
- 选项和选项参数是按照从左向右的方式进行解析的
- 参数都使用引号包围
- 那些参数可选的选项，当没有为它们提供参数时，将生成一个引号包围的空字符串参数
- 解析完全部的选项和选项参数后，开始解析非选项类型的参数
- 非选项类型的参数前面，会生成一个"--"字符串，它将选项(以及选项参数)与非选项类型的参数隔开了
3.处理getopt解析的结果
getopt解析获得了完整、规范化的结果，固然要拿来应用。例如直接传递个函数，或者根据while、case、shift将选项、参数进行分割单独保存。
若是要进行分割，因为getopt的解析结果一般保存在一个变量中，要解析这个结果字符串，须要使用eval函数将变量的内容进行还原，通常来讲会将其设置为一个位置参数(由于shift只能操做位置变量)。
通常来讲，整个处理流程是这样的：
parameters=$(getopt -o SHORT_OPTIONS -l LONG_OPTIONS -n "$0" -- "$@")
[ $? != 0 ] && exit 1
eval set -- "$parameters" # 将$parameters设置为位置参数
while true ; do # 循环解析位置参数
case "$1" in
-a|--longa) ...;shift ;; # 不带参数的选项-a或--longa
-b|--longb) ...;shift 2;; # 带参数的选项-b或--longb
-c|--longc) # 参数可选的选项-c或--longc
case "$2" in
"")...;shift 2;; # 没有给可选参数
*) ...;shift 2;; # 给了可选参数
esac;;
--) ...; break ;; # 开始解析非选项类型的参数，break后，它们都保留在$@中
*) echo "wrong";exit 1;;
esac
done
须要注意，getopt解析既能够放在脚本中解析命令行参数，也能够放在某个函数中解析函数参数。
4.getopt的两种扫描模式
getopt提供了两种扫描模式，只要在getopt的短选项前加上加号或负号，就能指定两种扫描模式，即getopt -o [+-]SHORT_OPTS。
+扫描模式：只要解析完选项、选项参数，解析到第一个非选项类型的参数后，就会中止解析，它会将全部没有解析的内容都看成非选项类型参数。因此这种状况下，非选项类型的参数都必须放在尾部，而不能放在某个待解析选项的前面。这种模式在区别负数和短选项时，很是有用。
-扫描模式：会按照原始位置参数解析，并保留原始位置。这种模式通常用不上，由于破坏了getopt的优点：让选项完整、规范化。
例如，对于命令行参数-w -s -5 3 -2，要将-5识别为-s的参数，3和-2为非选项类型的参数，则：
$ set -- -w -s -5 3 -2 # 设置位置参数 $ getopt -o +s:w -n "$0" -- "$@" -w -s '-5' -- '3' '-2' # 解析结果
注意，上面的-5是被解析成了-s的参数，而不是选项或非选项类型的参数，由于-s选项必需要指定一个参数。
上面的3必须不能是负数，由于getopt必须先扫描到一个正常的非选项型参数，才能将它后面的全部负数都看成非选项型参数。至于如何将-w -s -5 -3 -2中的-3和-2都解析为非选项型参数，目前我也不知道。
使用-扫描模式：
$ set -- 3 -w 4 -s -5 a 3 $ getopt -o -s:w -n "$0" -- "$@" '3' -w '4' -s '-5' 'a' '3' -- # 解析结果
能够看到，上面的全部参数位置都是保持原样的，且将分隔符号"--"补在了最尾部。
5.如何实现命令行选项的各类个性功能
在前面命令行选项的那些事中介绍了几种有"个性"的选项功能，包括：
- 选项依赖：例如"-a"或"--add"要依赖于"-m"或"--manage"选项
- 选项互斥：例如"-a"或"--add"与"-r"或"--remove"是互斥的
- 识别负数参数：例如
-w -5 -3 5，其中-5和-3不是短选项，而是负数参数 - 模式化选项：例如
script_name MODE OPTIONS的MODE部分，能够是manage模式(--manage,-m)，也可使用add模式(--add,-a)
- 选项参数替代选项：例如
head -n 3能够替换为head -3
这里介绍下用getopt解析参数后实现它们的思路。
在getopt解析完成后，假设返回结果保存到了$parameters变量中。
1.选项依赖性
这个其实很好实现，只需使用grep对$parameters变量进行筛选一下便可。
例如实现依赖性，只需：
{ echo "$parameters" | grep -E '\-\-add|\-a ' | grep -E '\-\-manage|\-m '; } &>/dev/null
[ $? -ne 0 ] && exit
2.选项互斥性
要实现互斥性，只需：
or_op=`echo "$parameters" | grep -Eo '\-\-add|\-a | \-\-remove|\-r ' | wc -l` [ "$or_op" = "2" ] && exit
3.识别负数参数
前面解释过，getopt提供了两种扫描模式，只要使用+扫描模式，就能轻松区别负数参数和短选项。
4.模式化选项
通常来讲，模式化选项都是命令行的第一个参数。因此，只需将$parameter中"--"后面的第一个非选项类型的参数提取出来，就是所谓的模式了。固然，还得对这个参数进行一些判断，避免它不是模式参数。
例如，要提供addr、show、route三种模式，那么其它的非选项类型参数值都不该该是模式参数。
eval set -- "$parameters"
while true ; do
case "$1" in
...
--)
shift
[ "$x" = "addr" -o "$x" = "route" -o "$x" = "show" ] && MODE=$1
shift
break ;;
*) echo "wrong";exit 1;;
esac
done
5.选项参数替代选项
就以-n3和-3为例，它的通用格式是-n NUM和-NUM。这个并很差实现，我能想到的方法是将这个-NUM先从$@中筛选出来，而后赋值。
NUM=`echo "$@" | grep -Eo "\-[0-9]+"` ARGS=`echo "$@" | sed -nr 's!(.*)-[0-9]+(.*)!\1\2!'p` eval set -- "$ARGS"
6.使用getopt设计shell脚本选项示例
这里提供一个和seq命令功能相同的脚本seq.sh，而后设计这个脚本的选项。
先看一下seq命令的各个选项说明：
seq [OPTION]... LAST # 语法1 seq [OPTION]... FIRST LAST # 语法2 seq [OPTION]... FIRST INCREMENT LAST # 语法3 选项： -s, --separator=STRING 使用指定的STRING分隔各数值，默认值为"\n"u -w, --equal-width 使用0填充在前缀使全部数值长度相同 --help 显示帮助信息并退出 --version 输出版本信息并退出
如下是脚本内容：和seq相比，只有两个问题：第一个起点数值FIRST不能为负数；不支持小数功能。其它功能彻底相同
#!/usr/bin/env bash
###########################################################
# author : 骏马金龙 #
# blog : http://www.cnblogs.com/f-ck-need-u/ #
###########################################################
usage(){
cat <<'EOF'
Usage: $0 [OPTION]... LAST
or: $0 [OPTION]... FIRST LAST
or: $0 [OPTION]... FIRST INCREMENT LAST
EOF
}
# getopt的版本是加强版吗
getopt -T &>/dev/null;[ $? -ne 4 ] && { echo "not enhanced version";exit 1; }
# 参数解析
parameters=`getopt -o +s:w --long separator:,equal-width,help,version -n "$0" -- "$@"`
[ $? -ne 0 ] && { echo "Try '$0 --help' for more information."; exit 1; }
eval set -- "$parameters"
while true;do
case "$1" in
-w|--equal-width) ZERO_PAD="true"; shift ;;
-s|--separator) SEPARATOR=$2; shift 2 ;;
--version) echo "$0 version V1.0"; exit ;;
--help) usage;exit ;;
--)
shift
FIRST=$1
INCREMENT=$2
LAST=$3
break ;;
*) usage;exit 1;;
esac
done
# 用于生成序列数
function seq_func(){
# 是否要使用printf填充0位？
[ "x$1" = "xtrue" ] && zero_pad="true" && shift
# 设置first、step、last
if [ $# -eq 1 ];then
first=1
step=1
last=$1
elif [ $# -eq 2 ];then
first=$1
step=1
last=$2
elif [ $# -eq 3 ]; then
first=$1
step=$2
last=$3
else
echo "$FUNCNAME: ARGS wrong..."
exit 1
fi
# 最后一个要输出的元素及其长度，决定要填充多少个0
last_output=$[ last - ( last-first ) % step ]
zero_pad_len=`[ ${#last_output} -gt ${#first} ] && echo ${#last_output} || echo ${#first}`
# 生成序列数
if [ "x$zero_pad" = "xtrue" ];then
# 填充0
if [ $step -gt 0 ];then
# 递增，填充0
for((i=$first;i<=$last;i+=$step)){
[ $last_output -eq $i ] && { printf "%0${zero_pad_len}i\n" "$i";return; }
printf "%0${zero_pad_len}i " $i
}
else
# 递减，填充0
for((i=$first;i>=$last;i+=$step)){
[ $last_output -eq $i ] && { printf "%0${zero_pad_len}i\n" "$i";return; }
printf "%0${zero_pad_len}i " $i
}
fi
else
# 不填充0
if [ $step -gt 0 ];then
# 递增，不填充0
for((i=$first;i<=$last;i+=$step)){
[ $last_output -eq $i ] && { printf "%i\n" "$i";return; }
printf "%i " $i
}
else
# 递减，不填充0
for((i=$first;i>=$last;i+=$step)){
[ $last_output -eq $i ] && { printf "%i\n" "$i";return; }
printf "%i " $i
}
fi
fi
}
# 指定输出分隔符
: ${SEPARATOR="\n"}
# 输出结果
seq_func $ZERO_PAD $FIRST $INCREMENT $LAST | tr " " "$SEPARATOR"
上面解析选项的脚本缺陷在于没法解析FIRST为负数的状况，例如./seq.sh -w -5 3将报错。但能够写为标准的./seq.sh -w -- -5 -3语法。
- 1. shell脚本选项设置及解析
- 2. Linux shell脚本007（select菜单选项）
- 3. 命令行短选项getopt
- 4. shell脚本小计
- 5. shell脚本 SpringBoot项目启动脚本
- 6. 《shell》-shell脚本
- 7. shell 简单计算脚本
- 8. shell脚本--数值计算
- 9. shell和shell脚本
- 10. shell脚本-循环选择语句
- 更多相关文章...
- • Web 创建设计 - 网站建设指南
- • Scala Option(选项) - Scala教程
- • IntelliJ IDEA代码格式化设置
- • 使用Rxjava计算圆周率
-
每一个你不满意的现在，都有一个你没有努力的曾经。
- 1. Appium入门
- 2. Spring WebFlux 源码分析(2)-Netty 服务器启动服务流程 --TBD
- 3. wxpython入门第六步（高级组件）
- 4. CentOS7.5安装SVN和可视化管理工具iF.SVNAdmin
- 5. jedis 3.0.1中JedisPoolConfig对象缺少setMaxIdle、setMaxWaitMillis等方法，问题记录
- 6. 一步一图一代码，一定要让你真正彻底明白红黑树
- 7. 2018-04-12—（重点）源码角度分析Handler运行原理
- 8. Spring AOP源码详细解析
- 9. Spring Cloud（1）
- 10. python简单爬去油价信息发送到公众号
- 1. shell脚本选项设置及解析
- 2. Linux shell脚本007（select菜单选项）
- 3. 命令行短选项getopt
- 4. shell脚本小计
- 5. shell脚本 SpringBoot项目启动脚本
- 6. 《shell》-shell脚本
- 7. shell 简单计算脚本
- 8. shell脚本--数值计算
- 9. shell和shell脚本
- 10. shell脚本-循环选择语句