Shell脚本编写第五季--函数、命令行参数和调试

一、函数，一些稍微复杂的程序可能在几个地方使用了相同的代码，并且如果使用了函数，会方便很多。一个函数是这样的：

　　functionname()
　　{
　　　　# inside the body $1 is the first argument given to the function
　　　　# $2 the second ...
　　　　body
　　}

需要在每个程序的开始对函数进行声明。下面是一个叫做xtitlebar的脚本，使用这个脚本可以改变终端窗口的名称。这里使用了一个叫做help的函数，这个定义的函数被使用了两次。

#!/bin/sh
# vim: set sw=4 ts=4 et:
help()
{
cat <<HELP
xtitlebar -- change the name of an xterm, gnome-terminal or kde
konsole
USAGE: xtitlebar [-h] "string_for_titelbar"
OPTIONS: -h help text
EXAMPLE: xtitlebar "cvs"
HELP
exit 0
}

# in case of error or if -h is given we call the function help:
[ -z "$1" ] && help
[ "$1" = "-h" ] && help
# send the escape sequence to change the xterm titelbar:
echo -e "33]0;$107"
#

在脚本中提供帮助是一种很好的编程习惯，这样方便用户使用和理解脚本。

二、命令行

一些特殊变量，如$* 和 $1, $2 ... $9 等，包含了用户从命令行输入的参数。在编写更复杂的程序时，会需要更多的自定义的选项。通常的惯例是在所有可选的参数之前加一个减号，后面再加上参数值 (比如文件名)。有好多方法可以实现对输入参数的分析，如下面的使用case表达式的例子。

#!/bin/sh
help()
{
cat <<HELP
This is a generic command line parser demo.
USAGE EXAMPLE: cmdparser -l hello -f -- -somefile1 somefile2
HELP
exit 0
}
while [ -n "$1" ]; do
case $1 in
-h) help;shift 1;; # function help is called
-f) opt_f=1;shift 1;; # variable opt_f is set
-l) opt_l=$2;shift 2;; # -l takes an argument -> shift by 2
--) shift;break;; # end of options
-*) echo "error: no such option $1. -h for help";exit 1;;
*) break;;
esac
done
echo "opt_f is $opt_f"
echo "opt_l is $opt_l"
echo "first arg is $1"
echo "2nd arg is $2"

您可以这样运行该脚本：
cmdparser -l hello -f -- -somefile1 somefile2

返回的结果是：
opt_f is 1
opt_l is hello
first arg is -somefile1
2nd arg is somefile2

脚本首先在所有输入命令行参数中进行循环，将输入参数与case表达式进行比较，如果匹配则设置一个变量并且移除该参数。根据unix系统的惯例，首先输入的应该是包含减号的参数。

二、实例--一般编程步骤

任何优秀的脚本都应该具有帮助和输入参数。并且写一个大纲脚本（framework.sh），该脚本包含了大多数脚本都需要的框架结构，是一个非常不错的主意。这时候，在写一个新的脚本时只需要执行一下copy命令：cp framework.sh myscript

然后再插入自己的函数。

现举两个例子：

1.二进制到十进制的转换

脚本 b2h 将二进制数 (比如 1101) 转换为相应的十进制数。这也是一个用expr命令进行数学运算的例子：

#!/bin/sh
# vim: set sw=4 ts=4 et:
help()
{
cat <<HELP
b2h -- convert binary to decimal
USAGE: b2h [-h] binarynum
OPTIONS: -h help text
EXAMPLE: b2h 111010
will return 58
HELP
exit 0
}
error()
{
# print an error and exit
echo "$1"
exit 1
}
lastchar()
{
# return the last character of a string in $rval
if [ -z "$1" ]; then
# empty string
rval=""
return
fi
# wc puts some space behind the output this is why we need sed:
numofchar=\echo -n "$1" | wc -c | sed 's/ //g' \
# now cut out the last char
rval=\echo -n "$1" | cut -b $numofchar\
}
chop()
{
# remove the last character in string and return it in $rval
if [ -z "$1" ]; then
# empty string
rval=""
return
fi
# wc puts some space behind the output this is why we need sed:
numofchar=\echo -n "$1" | wc -c | sed 's/ //g' \
if [ "$numofchar" = "1" ]; then
# only one char in string
rval=""
return
fi
numofcharminus1=\expr $numofchar "-" 1\
# now cut all but the last char:
rval=\echo -n "$1" | cut -b 0-${numofcharminus1}\
}
while [ -n "$1" ]; do
case $1 in
-h) help;shift 1;; # function help is called
--) shift;break;; # end of options
-*) error "error: no such option $1. -h for help";;
*) break;;
esac
done
# The main program
sum=0
weight=1
# one arg must be given:
[ -z "$1" ] && help
binnum="$1"
binnumorig="$1"
while [ -n "$binnum" ]; do
lastchar "$binnum"
if [ "$rval" = "1" ]; then
sum=\expr "$weight""+""$sum"\
fi
# remove the last position in $binnum
chop "$binnum"
binnum="$rval"
weight=\expr "$weight""*" 2\
done
echo "binary $binnumorig is decimal $sum"
#该脚本使用的算法是利用十进制和二进制数权值 (1,2,4,8,16,..)，比如二进制"10"可以这样转换成十进制：0 * 1 + 1 * 2 = 2

为了得到单个的二进制数我们是用了lastchar 函数。该函数使用wc -c计算字符个数，然后使用cut命令取出末尾一个字符。Chop函数的功能则是移除最后一个字符。

2.文件循环程序

将所有发出的邮件保存到一个文件中的人们中的一员，但这个文件会变得越来越大，使文件的访问速度变慢。脚本rotatefile 可以解决这个问题。这个脚本可以重命名邮件保存文件（假设为outmail）为outmail.1，而对于outmail.1就变成了outmail.2 等...

#!/bin/sh
# vim: set sw=4 ts=4 et:
ver="0.1"
help()
　{
cat <<HELP
rotatefile -- rotate the file name
USAGE: rotatefile [-h] filename
OPTIONS: -h help text
EXAMPLE: rotatefile out
This will e.g rename out.2 to out.3, out.1 to out.2, out to out.1
and create an empty out-file
The max number is 10
version $ver
HELP
exit 0
}
error()
{
echo "$1"
exit 1
}
while [ -n "$1" ]; do
case $1 in
-h) help;shift 1;;
--) break;;
-*) echo "error: no such option $1. -h for help";exit 1;;
*) break;;
esac
done
# input check:
if [ -z "$1" ]then
error "ERROR: you must specify a file, use -h for help"
fi
filen="$1"
# rename any .1 , .2 etc file&:
for n in 9 8 7 6 5 4 3 2 1; do
if [ -f "$filen.$n" ]; then
p=`expr $n + 1`
echo "mv $filen.$n $filen.$p"
mv $filen.$n $filen.$p
fi
done
# rename the original file&:
if [ -f "$filen" ]; then
echo "mv $filen $filen.1"
mv $filen $filen.1
fi
echo touch $filen
touch $filen

在检测用户提供了一个文件名以后，先进行一个9到1的循环。文件9被命名为10，文件8重命名为9等等。循环完成之后，将原始文件命名为文件1同时建立一个与原始文件同名的空文件。

三、调试

最简单的调试命令当然是使用echo命令。使用echo在任何怀疑出错的地方打印任何变量值。这也是绝大多数的shell程序员要花费80%的时间来调试程序的原因。Shell程序的好处在于不需要重新编译，插入一个echo命令也不需要多少时间。shell也有一个真实的调试模式。如果在脚本"strangescript" 中有错误，可以这样来进行调试：

sh -x strangescript

这将执行该脚本并显示所有变量的值。shell还有一个不需要执行脚本只是检查语法的模式。可以这样使用：

sh -n your_script

这将返回所有语法错误