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

kenson · 发表于 2017-2-21 23:15

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

0.引言

写程序的时候经常要处理命令行参数，本文描述在Bash下的命令行处理方式。

选项与参数：

如下一个命令行：

[vb]
./test.sh -f config.conf -v --prefix=/home

我们称-f为选项，它需要一个参数，即config.conf, -v 也是一个选项，但它不需要参数。

--prefix我们称之为一个长选项，即选项本身多于一个字符，它也需要一个参数，用等号连接，当然等号不是必须的，/home可以直接写在--prefix后面，即--prefix/home,更多的限制后面具体会讲到。

在bash中，可以用以下三种方式来处理命令行参数，每种方式都有自己的应用场景。

手工处理方式

getopts

getopt

下面我们依次讨论这三种处理方式。

1. 手工处理方式

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

$0 ： ./test.sh,即命令本身，相当于C/C++中的argv[0]
$1 ： -f,第一个参数.

$2 ： config.conf

$3, $4 ... ：类推。

$# 参数的个数，不包括命令本身，上例中$#为4.

$@ ：参数本身的列表，也不包括命令本身，如上例为 -f config.conf -v --prefix=/home

$* ：和$@相同，但"$*" 和 "$@"(加引号)并不同，"$*"将所有的参数解释成一个字符串，而"$@"是一个参数数组。如下例所示：

[vb]
#!/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”这种带选项的方式。典型用法为：

[vb]
#!/bin/bash

#if [ -n "$1" ]，参数不为空
if [ "$1" != "" ]
then

#...有参数

else

then

#...没有参数

fi

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

2. 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

[vb]
#!/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自带的一个例子：

[vb]
#!/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则被放到了最后。

3. 总结

豹尾。

本文系统（linux）相关术语:linux系统鸟哥的linux私房菜 linux命令大全 linux操作系统

efan · 发表于 2017-2-22 21:33

记得getopt常与shift结合使用，while循环一下就好了。

kenson · 发表于 2017-2-22 22:39

efan 发表于 2017-2-22 21:33
6 W5 ?% e! ?* b7 i, _记得getopt常与shift结合使用，while循环一下就好了。

请教一个问题
有一句：set -- `getopt -q ab:c "$@"`
请问这个如何解呢？？

kenson · 发表于 2017-2-22 22:43

这是全部的语句
set -- `getopt -q ab:c "$@"`
while [ -n "$1" ]
do
  case "$1" in
  -a) echo "Fount the -a option";;

  -b) param="$2"
   echo "Found the -b option. with parameter value $param"
   shift ;;

  -c) echo "Found the -c option";;

  --) shift
   break;;

  *) echo "$1 is not an option";;
  esac
  shift
  done

  count=1
  for param in "$@"
  do
echo "Parameter #$count: $param"
count=$[$count+1]
  done

efan · 发表于 2017-2-23 00:12

kenson 发表于 2017-2-22 22:39" t0 s M& A. h6 x
请教一个问题3 {! |- v2 ]" f1 f" p3 W
有一句：set -- `getopt -q ab:c "$@"`
* u3 E) D" B8 S8 x请问这个如何解呢？？

请教绝不敢当啊，当时也只是学了个皮毛，只会非常简单的应用，很惭愧现在都已经忘了

kenson · 发表于 2017-2-23 08:44

efan 发表于 2017-2-23 00:12
3 \6 t/ T$ W8 U; W0 s$ g( c请教绝不敢当啊，当时也只是学了个皮毛，只会非常简单的应用，很惭愧现在都已经忘了

呵呵没关系，大家一起学习呗。
经过一晚的思考，我发现了之前我看到的一个语句：set -- -F
一查在shell 上用echo $0 $1 会显示bash -F,也就是说这个是设置位置参数的，
所以set -- `getopt -q ab:c "$@"` 其实是getopt返回参数给set 作为位置参数用的。
如：getopt.sh为文件名，./getopt.sh -ac 它会在位置参数里显示$1:-a $1:-c $2:--
$2上会跟着一个“--” ，想不明白，但也没关系知道怎么用就可以了。
补上昨天调试的代码

#!/bin/bash
set --  `getopt -q ab:c "$@"`
tt=`getopt -q ab:c "$@"`
echo "\$tt:  $tt"
echo "\$0: $0"
echo "\$1: $1"
echo "\$2: $2"
echo "\$3: $3"
echo "\$4: $4"
echo "\$5: $5"
echo "\$6: $6"
echo "************"

while [ -n "$1" ]
do
  case "$1" in
  -a) echo "Fount the -a option";;

  -b) param="$2"
   echo "Found the -b option. with parameter value $param"
   shift ;;

  -c) echo "Found the -c option";;

  --) shift
   break;;

  *) echo "$1 is not an option";;
  esac
  shift
  done

  count=1
  for param in "$@"
  do
echo "Parameter #$count: $param"
count=$[$count+1]
  done

kenson · 发表于 2017-2-23 08:46

这样子你可以这样用法 ./getopt.sh -ac -b test
$tt: -a -c -b ''\''test'\''' --
$0: ./getopt.sh
$1: -a
$2: -c
$3: -b
$4: 'test'
$5: --
$6:
************
Fount the -a option
Found the -c option
Found the -b option. with parameter value 'test'

kenson · 发表于 2017-2-24 14:00

getopts 的用法
getopts跟getopt 差不多但有一些区别，区别在于比getopt简单一些。
代码：
while getopts :ab:cd opt
do
case "$opt" in
  a) echo "Found the -a option";;
  b) echo "Found the -b option. with value $OPTARG";;
  c) echo "Found the -c option.";;
  d) echo "Found the -d option.";;
  *) echo "Unkown option: $opt";;
  esac
done
shift $[$OPTIND -1]

count=1
for param in "$@"
do
echo "Parameter $count: $param"
  count=$[$count+1]
done

kenson · 发表于 2017-2-24 14:05

其中OPTARG是一个环境变量，如果选项有一个参数值，就会保存OPTARG之中，OPTIND环境变量用来保存getopts正在处理的参数位置。
其后就可以这样用
./getopts.sh -a -b test1 -d test2 test3 test4
./getopts.sh -acd -b test
./getopts.sh -a -b test -c -d test1 test2 test3
等等

kenson · 发表于 2017-2-24 14:27

我将代码改了一下#!/bin/bash

while getopts :ab:cd opt
do
  case "$opt" in
  a)echo "Found the -a option";;
  b)echo "Found the -b option. with value $OPTARG";;
  c)echo "Found the -c option";;
  d)echo "Found the -d option";;
  *)echo "Unkow option: $opt";;
  esac
done

echo "**************"
echo "OPTIND: $OPTIND"
echo "\$@ $@"
shift $[$OPTIND - 1]
echo \$@: $@
echo "**************"

count=1
for param  in "$@"
do
  echo "Parameter $count: $param"
  count=$[$count+1]
done

其中有一句  shift $[$OPTIND - 1]  这个是用来改变$@中的参数的排序，不然之前的 -a -b 之类将没办法跳过

		自动登录	找回密码
密码			请使用微信账号登录和注册会员

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

浏览过的版块