getopts命令行选项与参数处理教程
在shell/ target=_blank class=infotextkey>shell脚本编程中,处理命令行参数是个大问题,正确接收与处理命令行选项,可以写出功能强大的shell脚本程序,此时就需要getopts或getopt处理命令行参数,这里通过实例介绍了getopts命令的用法,希望对大家有帮助。
在写shell脚本时经常会用到命令行选项、参数处理方式,例如:
-f 为短选项,它需要一个参数,即config.conf, -v也是一个选项,但它不需要参数
–prefix 是一个长选项,即选项本身多于一个字符,它也需要一个参数,用等号连接,当然等号不是必须的,/home可以直接写在–prefix后面,即–prefix=/home。
在shell中,可以用以下三种方式来处理命令行参数,每种方式都有自己的应用场景。
1、手工处理方式
2、getopts
3、getopt
这里依次讨论这三种处理方式,并重点学习下getopts命令处理参数选项的方法。
1、手工处理方式
在手工处理方式中,首先要知道几个变量,还是以上面的命令行为例:
例子:
#!/bin/bash
#
for arg in "$*"
do
echo $arg
done
echo
for arg in "$@"
do
echo $arg
done
$ bash test.sh -f config.conf -v --prefix=/home
-f config.conf -v --prefix=/home #这是"$*"的输出
-f #以下为$@的输出
config.conf
-v
--prefix=/home
所以,手工处理的方式即对这些变量的处理。因为手工处理高度依赖于你在命令行上所传参数的位置,所以一般都只用来处理较简单的参数。如./test.sh 10。而很少使用./test -n 10这种带选项的方式。
手工处理方式能满足大多数的简单需求,配合shift使用也能构造出强大的功能,但在要处理复杂选项的时候建议用下面的两种方法。
2、getopts/getopt
处理命令行参数是一个相似而又复杂的事情,在shell中,处理此事的是getopts和getopt
getopts和getopt功能相似但又不完全相同,其中getopt是独立的可执行文件,而getopts是由bash内置的
参数传递的典型用法:
先来看getopts,它不支持长选项。
使用getopts非常简单:
应该说绝大多数脚本使用该函数就可以了,如果需要支持长选项以及可选参数,那么就需要使用getopt。
例子:
#!/bin/bash
#-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
$ bash test.sh -a -b arg arg1 -c
Option a
Option b, argument `arg'
Option c, no argument
Remaining arguments:
--> `arg1'
可以看到,命令行中多了个arg1参数,在经过getopt和set之后,命令行会变为:
-a -b arg -c — arg1
$1指向-a,$2指向-b,$3指向arg,$4指向-c,$5指向–,而多出的arg1则被放到了最后
3,举例
将前面的ssh.exp、scp.exp封装起来,代码:
#!/bin/bash
######## proc defination #######
# ignore rule
ignore_init()
{
# ignore password
array_ignore_pwd_length=0
if [ -f ./ignore_pwd ]; then
while read IGNORE_PWD
do
array_ignore_pwd[$array_ignore_pwd_length]=$IGNORE_PWD
let array_ignore_pwd_length=$array_ignore_pwd_length+1
done < ./ignore_pwd
fi
# ignore ip address
array_ignore_ip_length=0
if [ -f ./ignore_ip ]; then
while read IGNORE_IP
do
array_ignore_ip[$array_ignore_ip_length]=$IGNORE_IP
let array_ignore_ip_length=$array_ignore_ip_length+1
done < ./ignore_ip
fi
}
show_version()
{
echo "version: 1.0"
echo "updated date: 2014-01-09"
}
show_usage()
{
echo -e "`printf %-16s "Usage: $0"` [-h|--help]"
echo -e "`printf %-16s ` [-v|-V|--version]"
echo -e "`printf %-16s ` [-l|--iplist ... ]"
echo -e "`printf %-16s ` [-c|--config ... ]"
echo -e "`printf %-16s ` [-t|--sshtimeout ... ]"
echo -e "`printf %-16s ` [-T|--fttimeout ... ]"
echo -e "`printf %-16s ` [-L|--bwlimit ... ]"
echo -e "`printf %-16s ` [-n|--ignore]"
#echo "ignr_flag: 'ignr'-some ip will be ignored; otherwise-all ip will be handled"
}
# Default Parameters
myIFS=":::" # 配置文件中的分隔符
TOOLDIR=/root/scripts
cd $TOOLDIR
IPLIST="iplist.txt" # IP列表,格式为IP 端口 用户名 密码
CONFIG_FILE="config.txt" # 命令列表和文件传送配置列表,关键字为com:::和file:::
IGNRFLAG="noignr" # 如果置为ignr,则脚本会进行忽略条件的判断
SSHTIMEOUT=100 # 远程命令执行相关操作的超时设定,单位为秒
SCPTIMEOUT=2000 # 文件传送相关操作的超时设定,单位为秒
BWLIMIT=1024000 # 文件传送的带宽限速,单位为kbit/s
# 入口参数分析
TEMP=`getopt -o hvVl:c:t:T:L:n --long help,version,iplist:,config:,sshtimeout:,fttimeout:,bwlimit:,ignore -- "$@" 2>/dev/null`
[ $? != 0 ] && echo -e "