我的书签
添加书签
移除书签脚本除错
本章介绍如何对 Shell 脚本除错。
常见错误
编写 Shell 脚本的时候，一定要考虑到命令失败的情况，否则很容易出错。
1. #! /bin/bash
3. dir_name=/path/not/exist
5. cd $dir_name
6. rm *
上面脚本中，如果目录$dir_name不存在，cd $dir_name命令就会执行失败。这时，就不会改变当前目录，脚本会继续执行下去，导致rm *命令删光当前目录的文件。
如果改成下面的样子，也会有问题。
1. cd $dir_name && rm *
上面脚本中，只有cd $dir_name执行成功，才会执行rm *。但是，如果变量$dir_name为空，cd就会进入用户主目录，从而删光用户主目录的文件。
下面的写法才是正确的。
1. [[ -d $dir_name ]] && cd $dir_name && rm *
上面代码中，先判断目录$dir_name是否存在，然后才执行其他操作。
如果不放心删除什么文件，可以先打印出来看一下。
1. [[ -d $dir_name ]] && cd $dir_name && echo rm *
上面命令中，echo rm *不会删除文件，只会打印出来要删除的文件。
bash的-x参数
bash的-x参数可以在执行每一行命令之前，打印该命令。这样就不用自己输出执行的命令，一旦出错，比较容易追查。
下面是一个脚本script.sh。
1. # script.sh
2. echo hello world
加上-x参数，执行每条命令之前，都会显示该命令。
1. $ bash -x script.sh
2. + echo hello world
3. hello world
上面例子中，行首为+的行，显示该行是所要执行的命令，下一行才是该命令的执行结果。
下面再看一个-x写在脚本内部的例子。
1. #! /bin/bash -x
2. # trouble: script to demonstrate common errors
4. number=1
5. if [ $number = 1 ]; then
6. echo "Number is equal to 1."
7. else
8. echo "Number is not equal to 1."
9. fi
上面的脚本执行之后，会输出每一行命令。
1. $ trouble
2. + number=1
3. + '[' 1 = 1 ']'
4. + echo 'Number is equal to 1.'
5. Number is equal to 1.
输出的命令之前的+号，是由系统变量PS4决定，可以修改这个变量。
1. $ export PS4='$LINENO + '
2. $ trouble
3. 5 + number=1
4. 7 + '[' 1 = 1 ']'
5. 8 + echo 'Number is equal to 1.'
6. Number is equal to 1.
另外，set命令也可以设置 Shell 的行为参数，有利于脚本除错，详见《set 命令》一章。
环境变量
有一些环境变量常用于除错。
LINENO
变量LINENO返回它在脚本里面的行号。
1. #!/bin/bash
3. echo "This is line $LINENO"
执行上面的脚本test.sh，$LINENO会返回3。
1. $ ./test.sh
2. This is line 3
FUNCNAME
变量FUNCNAME返回一个数组，内容是当前的函数调用堆栈。该数组的0号成员是当前调用的函数，1号成员是调用当前函数的函数，以此类推。
1. #!/bin/bash
3. function func1()
4. {
5. echo "func1: FUNCNAME0 is ${FUNCNAME[0]}"
6. echo "func1: FUNCNAME1 is ${FUNCNAME[1]}"
7. echo "func1: FUNCNAME2 is ${FUNCNAME[2]}"
8. func2
9. }
11. function func2()
12. {
13. echo "func2: FUNCNAME0 is ${FUNCNAME[0]}"
14. echo "func2: FUNCNAME1 is ${FUNCNAME[1]}"
15. echo "func2: FUNCNAME2 is ${FUNCNAME[2]}"
16. }
18. func1
执行上面的脚本test.sh，结果如下。
1. $ ./test.sh
2. func1: FUNCNAME0 is func1
3. func1: FUNCNAME1 is main
4. func1: FUNCNAME2 is
5. func2: FUNCNAME0 is func2
6. func2: FUNCNAME1 is func1
7. func2: FUNCNAME2 is main
上面例子中，执行func1时，变量FUNCNAME的0号成员是func1，1号成员是调用func1的主脚本main。执行func2时，变量FUNCNAME的0号成员是func2，1号成员是调用func2的func1。
BASH_SOURCE
变量BASH_SOURCE返回一个数组，内容是当前的脚本调用堆栈。该数组的0号成员是当前执行的脚本，1号成员是调用当前脚本的脚本，以此类推，跟变量FUNCNAME是一一对应关系。
下面有两个子脚本lib1.sh和lib2.sh。
1. # lib1.sh
2. function func1()
3. {
4. echo "func1: BASH_SOURCE0 is ${BASH_SOURCE[0]}"
5. echo "func1: BASH_SOURCE1 is ${BASH_SOURCE[1]}"
6. echo "func1: BASH_SOURCE2 is ${BASH_SOURCE[2]}"
7. func2
8. }
1. # lib2.sh
2. function func2()
3. {
4. echo "func2: BASH_SOURCE0 is ${BASH_SOURCE[0]}"
5. echo "func2: BASH_SOURCE1 is ${BASH_SOURCE[1]}"
6. echo "func2: BASH_SOURCE2 is ${BASH_SOURCE[2]}"
7. }
然后，主脚本main.sh调用上面两个子脚本。
1. #!/bin/bash
2. # main.sh
4. source lib1.sh
5. source lib2.sh
7. func1
执行主脚本main.sh，会得到下面的结果。
1. $ ./main.sh
2. func1: BASH_SOURCE0 is lib1.sh
3. func1: BASH_SOURCE1 is ./main.sh
4. func1: BASH_SOURCE2 is
5. func2: BASH_SOURCE0 is lib2.sh
6. func2: BASH_SOURCE1 is lib1.sh
7. func2: BASH_SOURCE2 is ./main.sh
上面例子中，执行函数func1时，变量BASH_SOURCE的0号成员是func1所在的脚本lib1.sh，1号成员是主脚本main.sh；执行函数func2时，变量BASH_SOURCE的0号成员是func2所在的脚本lib2.sh，1号成员是调用func2的脚本lib1.sh。
BASH_LINENO
变量BASH_LINENO返回一个数组，内容是每一轮调用对应的行号。${BASH_LINENO[$i]}跟${FUNCNAME[$i]}是一一对应关系，表示${FUNCNAME[$i]}在调用它的脚本文件${BASH_SOURCE[$i+1]}里面的行号。
下面有两个子脚本lib1.sh和lib2.sh。
1. # lib1.sh
2. function func1()
3. {
4. echo "func1: BASH_LINENO is ${BASH_LINENO[0]}"
5. echo "func1: FUNCNAME is ${FUNCNAME[0]}"
6. echo "func1: BASH_SOURCE is ${BASH_SOURCE[1]}"
8. func2
9. }
1. # lib2.sh
2. function func2()
3. {
4. echo "func2: BASH_LINENO is ${BASH_LINENO[0]}"
5. echo "func2: FUNCNAME is ${FUNCNAME[0]}"
6. echo "func2: BASH_SOURCE is ${BASH_SOURCE[1]}"
7. }
然后，主脚本main.sh调用上面两个子脚本。
1. #!/bin/bash
2. # main.sh
4. source lib1.sh
5. source lib2.sh
7. func1
执行主脚本main.sh，会得到下面的结果。
1. $ ./main.sh
2. func1: BASH_LINENO is 7
3. func1: FUNCNAME is func1
4. func1: BASH_SOURCE is main.sh
5. func2: BASH_LINENO is 8
6. func2: FUNCNAME is func2
7. func2: BASH_SOURCE is lib1.sh
上面例子中，函数func1是在main.sh的第7行调用，函数func2是在lib1.sh的第8行调用的。
