文档章节

bash/shell 解析命令行参数工具:getopts/getopt

大数据之路
 大数据之路
发布于 2014/02/23 02:53
字数 2148
阅读 13135
收藏 24
点赞 2
评论 1

bash 脚本中,简单点的参数选项,我们可以直接用位置参数 $1 $2 这样来获取处理了,例如下面这段代码片段:

optionParam=$1
baseHdfsPath=$2
echo $optionParam|grep -qE '^(-d|-l)$' || usage
echo $baseHdfsPath|grep -qE '^/' || usage

if [[ $optionParam == "-l" ]]
then
	echo --------------------$startTime----------------------
	listDir "$baseHdfsPath"
	echo --------------------`date +'%F %T'`----------------------
else
	echo --------------------$startTime----------------------
	downLoadFiles "$baseHdfsPath"
	echo --------------------`date +'%F %T'`----------------------
fi

但是如果你的参数选项很多,比如 rsync、wget 等动辄几十上百的参数选项,那就必须用专业的工具来处理了,在 bash/shell 中我们一般用:getopts/getopt 

1、bash 内置的 getopts:

先看简单的例子:

#!/bin/bash
while getopts 'd:Dm:f:t:' OPT; do
    case $OPT in
        d)
            DEL_DAYS="$OPTARG";;
        D)
            DEL_ORIGINAL='yes';;
        f)
            DIR_FROM="$OPTARG";;
        m)
            MAILDIR_NAME="$OPTARG";;
        t)
            DIR_TO="$OPTARG";;
        ?)
            echo "Usage: `basename $0` [options] filename"
    esac
done

shift $(($OPTIND - 1))

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~$#了,可以用for循环依次处理。

使用getopts处理参数虽然是方便,但仍然有两个小小的局限:

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

再看个实例:

#!/bin/bash
echo 初始 OPTIND: $OPTIND

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

echo 处理完参数后的 OPTIND:$OPTIND
echo 移除已处理参数个数:$((OPTIND-1))
shift $((OPTIND-1))
echo 参数索引位置:$OPTIND
echo 准备处理余下的参数:
echo "Other Params: $@"
结果:
june@Win7 192.168.1.111 02:32:45 ~ >
bash b.sh -a 1 -b 2 -c 3  test -oo xx -test
初始 OPTIND: 1
a's arg:1
b's arg:2
c's arg:
处理完参数后的 OPTIND:6
移除已处理参数个数:5
参数索引位置:6
准备处理余下的参数:
Other Params: 3 test -oo xx -test
june@Win7 192.168.1.111 02:32:49 ~ >
bash b.sh -a 1 -c 3 -b 2 test -oo xx -test   # 非参数选项注意顺序与值,不要多传
初始 OPTIND: 1
a's arg:1
c's arg:
处理完参数后的 OPTIND:4
移除已处理参数个数:3
参数索引位置:4
准备处理余下的参数:
Other Params: 3 -b 2 test -oo xx -test
june@Win7 192.168.1.111 02:33:14 ~ >
bash b.sh -a 1 -c -b 2 test -oo xx -test
初始 OPTIND: 1
a's arg:1
c's arg:
b's arg:2
处理完参数后的 OPTIND:6
移除已处理参数个数:5
参数索引位置:6
准备处理余下的参数:
Other Params: test -oo xx -test
june@Win7 192.168.1.111 02:33:22 ~ >

2、外部强大的参数解析工具:getopt

先来看下getopt/getopts的区别
1. getopts是bash内建命令的, 而getopt是外部命令
2. getopts不支持长选项, 比如: --date
3. 在使用getopt的时候, 每处理完一个位置参数后都需要自己shift来跳到下一个位置, getopts只需要在最后使用shift $(($OPTIND - 1))来跳到parameter的位置。
4. 使用getopt时, 在命令行输入的位置参数是什么, 在getopt中需要保持原样, 比如 -t , 在getopt的case语句中也要使用-t,  而getopts中不要前面的-。
5. getopt往往需要跟set配合使用
6. getopt -o的选项注意一下

7. getopts 使用语法简单,getopt 使用语法较复杂

8. getopts 不会重排所有参数的顺序,getopt 会重排参数顺序

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

下面是getopt自带的一个例子:

Code highlighting produced by Actipro CodeHighlighter (freeware)http://www.CodeHighlighter.com/-->
#!/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
关于 getopt 选项重排的解释:

比如我们使用
./test -a  -b arg arg1 -c 
你可以看到,命令行中多了个arg1参数,在经过getopt和set之后,命令行会变为:
-a -b arg -c -- arg1
$1指向-a,$2指向-b,$3指向arg,$4指向-c,$5指向--,而多出的arg1则被放到了最后。

getopt 对参数顺序进行重排的意义:这样可以将带 "-" 或 "–" 的参数写在其他参数的前面,也可以写在后面,而 getopts 是没有这样的能力的,具体没有的原因就是因为 getopts 直接进入了 while 循环处理参数,而 getopt 游一个 set — ${ARGS} 的过程。另外还要注意到的是,在使用 getopt 处理完参数之后,"${@}" 变量 “被清洗干净了” ,里面包含了所有不带 "-" 或 "–" 的参数,所以你可以继续使用 ${1},${2} 等来调用他们。

3、Refer:

1、Bash Shell中命令行选项/参数处理

http://www.cnblogs.com/FrankTan/archive/2010/03/01/1634516.html

2、bash处理命令行参数:getopts/getopt 

http://blog.chinaunix.net/uid-21651880-id-3392466.html

3、getopt 使用教程并与 getopts 比较

http://hiaero.net/getopts-versus-getopt/

4、bash getopts, short options only, all require values, own validation

http://unix.stackexchange.com/questions/75219/bash-getopts-short-options-only-all-require-values-own-validation

© 著作权归作者所有

共有 人打赏支持
大数据之路
粉丝 1476
博文 501
码字总数 343984
作品 0
武汉
架构师
加载中

评论(1)

olutyo
olutyo
搜索了这么多篇文章 还是这一篇写的让我全懂了。
getopts简易教程(Small getopts tutorial)译文

getopts简易教程 当你想用一种专业的方式解析命令行参数时,getopts就是要选择的工具。和它的旧版本兄弟命令getopt不同(注意没有s!),getopts是shell内置命令。高级地方表现在 你不需要通过一...

Feng_Yu ⋅ 2015/01/31 ⋅ 0

Shell脚本的输入参数处理

参数处理-Shell传入参数的处理 1、参数说明 1. $# 传递到脚本的参数个数2. $* 以一个单字符串显示所有向脚本传递的参数。与位置变量不同,此选项参数可超过9个3.脚本运行的当前进程ID号 4. $...

openthings ⋅ 2015/07/24 ⋅ 2

shell中getopt/getopts的使用

getopts配合case来进行操作时有两个隐含变量:一个是OPTARG,用来取当前选项的值,另外一个是OPTIND,代表当前选项在参数列表中的位移。OPTIND是一个特殊的变量,它的初始值是1,每次getopts...

拜仁慕尼黑 ⋅ 2013/03/22 ⋅ 0

getopt/getopts:Bash中命令行选项/参数处理

0.引言 写程序的时候经常要处理命令行参数,本文描述在Bash下的命令行处理方式。 选项与参数: 如下一个命令行: ./test.sh -f config.conf -v --prefix=/home 我们称-f为选项,它需要一个参...

独钓渔 ⋅ 2015/05/04 ⋅ 0

shell脚本之getopts的使用方法

遇到shell脚本需要收集参数场景,用getopts非常的方便 getopts optstring name [arg...] 例如:getopts "a:fs" OPTION 命令描述: optstring列出了对应的Shell Script可以识别的所有参数。比如...

会说话的鱼 ⋅ 2017/10/19 ⋅ 0

shell script 交互式脚本,可以读取命令行参数、选项,用户输入数据

1.命令行参数 1.1一般参数 1.1.1读取参数 位置参数是标准的数字:$0是程序名,$1~$9是9个参数,如果脚本需要多于9个参数,需要在变量数字周围加花括号,比如${10}、${11}、、、、可以实现向脚...

Caishu ⋅ 2016/05/13 ⋅ 0

shell 中getopts 的应用

该语句的格式为: getopts一般格式为: getopts optionstring variable 其中optionstring中包含一个有效的单字符选项。若getopts命令在命令行中发现了连字符,那么它将用连字符后面的字符同 ...

疯狂的单纯酱 ⋅ 2015/08/04 ⋅ 0

Shell脚本基础知识

一.eq 和 = 的区别:eq用于比较整数,=用于比较字符串。 二.通常用 [ ] 来表示条件测试。注意这里的空格很重要。要确保方括号的空格。 [ -f somefile ] :判断是否是一个文件 [ -x /bin/ls ]...

AlphaJay ⋅ 2011/11/10 ⋅ 0

第一章:The Missing Code Library--4.优雅的表示大数

程序员经常犯的一个错误是:在向用户显示计算的结果时,并没有在第一时间格式化好它们。如果用户没有从右向左手动计数,然后在心里每三个数字就插入一个逗号的话,是很难界定43245435这个数字...

十舍七匹狼 ⋅ 2013/01/08 ⋅ 0

getopts 处理shell脚本参数

intruduction   shell 脚本有二种方法定位脚本参数,一种是使用位置变量,二是使用getopts。使用位置参数有两个限制,他需要编程者自己测试错误并建立相应的消息。若使用shift处理参数,s...

adelphos ⋅ 2014/11/07 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

180621-一个简单的时间窗口设计与实现

如何设计一个计数的时间窗口 时间窗口,通常对于一些实时信息展示中用得比较多,比如维持一个五分钟的交易明细时间窗口,就需要记录当前时间,到五分钟之前的所有交易明细,而五分钟之前的数...

小灰灰Blog ⋅ 34分钟前 ⋅ 0

Android之Dalvik、ART、JIT、AOT

Android之Dalvik、ART、JIT、AOT 本文内容:Dalvik、ART、JIT、AOT之间关系 本文定位:知识记录 学习过程记录,加深理解,提升文字组合表达能力。也希望能给学习的同学一些灵感 本文整理于[...

lichuangnk ⋅ 38分钟前 ⋅ 0

Thrift RPC实战(五) thrift连接池

Thrift本身没有提供连接池,我们可以用Apache Commons Pool2来实现一个 一、定义对象工厂 BasePooledObjectFactory<T> extends BaseObject implements PooledObjectFactory<T> public class......

lemonLove ⋅ 38分钟前 ⋅ 0

git 命令简写

简写 命令 g git gst git status gd git diff gdc git diff --cached gdv git diff -w "$@" | view - gl git pull gup git pull --rebase gp git push gc git commit -v gc! git commit -v ......

charley158 ⋅ 46分钟前 ⋅ 0

Java中的锁使用与实现

1.Lock接口 锁是用来控制多个线程访问共享资源的方式,一般来说,一个锁能够防止多个线程同时访问共享资源。 在Lock出现之前,java程序是靠synchronized关键字实现锁功能的,而Java SE5之后,...

ZH-JSON ⋅ 47分钟前 ⋅ 0

Intellij IDEA神器常用技巧四-类和方法注释模板设置

IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事。 这里设置的注释模...

Mkeeper ⋅ 50分钟前 ⋅ 0

Jira接入钉钉机器人

https://open-doc.dingtalk.com/docs/doc.htm?spm=a219a.7629140.0.0.9Z9czj&treeId=257&articleId=106075&docType=1...

谢思华 ⋅ 52分钟前 ⋅ 0

微信公众号开发

一、开通微信服务号,填写URL,微信将想你发送验证信息。接收并处理微信发来的GET请求 二、处理客户向公众号发送的各种消息: 如文本、图片、乐音、视频、音乐 : 消息分为:1 请求消息(文本...

无敌小学僧 ⋅ 58分钟前 ⋅ 0

广州三本找Java实习经历

前言 只有光头才能变强 这阵子跑去面试Java实习生啦~~~我来简单介绍一下背景吧。 广州三本大三在读,在广州找实习。大学开始接触编程,一个非常平庸的人。 在学习编程时,跟我类似的人应该会...

Java3y ⋅ 今天 ⋅ 0

php json_encode()不转义中文字符 和 斜杠"/"

php格式化json的函数 json_encode($value,$options) 其中有2个比较常用到的参数 JSON_UNESCAPED_UNICODE (中文不转为unicode ,对应的数字 256) JSON_UNESCAPED_SLASHES (不转义斜杠,对应的...

一只大橘子 ⋅ 今天 ⋅ 0

没有更多内容

加载失败,请刷新页面

加载更多

下一页

返回顶部
顶部