优秀的编程知识分享平台

网站首页 > 技术文章 正文

linux bash中使用set -exu写出更健壮的脚本

nanyue 2024-08-02 17:37:22 技术文章 6 ℃

0x00 bash语言有些缺陷

现在主流的linux发行版都使用bash作为默认shell. bash不仅可以作为一个登陆shell使用,还可以作为一个一门编程语言,将重复命令放到一起来执行. 但是bash的主要功能还是在交互性上,默认情况下很多地方不像一门现代编程语言,通过如下的几个选项,可以让bash更加好用,写出的代码更健壮.

0x01 set -x

set -x开启bash调试模式,就是在每条命令执行之前,都打印出已经展开的要执行命令.如下脚本

#cat setx.sh
#!/bin/bash
echo 'aaaa'
echo 'bbbb'

直接执行输出如下

#bash setx.sh
aaaa
bbbb

通过加入set -x

#!/bin/bash
set -x
echo 'aaaa'
echo 'bbbb'

会发现每条命令执行之前,+号后面的表示会被执行的命令.

#bash setx.sh
+ echo aaaa
aaaa
+ echo bbbb
bbbb

实际上,调试行的样式由PS4内置变量决定,默认情况下PS4为+号,可以对其进行定制,我比较喜欢如下定制,能输出代码所在的文件,行号,函数名.

#cat setx.sh
#!/bin/bash
export PS4='+${BASH_SOURCE}@${LINENO}(${FUNCNAME[0]}): '
set -x
echo 'aaaa'
echo 'bbbb'

此时输出如下,很好定位代码执行到哪儿了.

#bash setx.sh
+setx.sh@5(main): echo aaaa
aaaa
+setx.sh@7(main): echo bbbb
bbbb

0x02 set -e

一般的编程语言,当发生语法错误时,脚本会直接报错退出,但是bash默认情况下不是.

如下脚本,not_exists_command命令不存在

#cat sete.sh
#!/bin/bash
echo '1111'
not_exists_command
echo '2222'

脚本执行的时候也报错了,但是后面的命令还是执行了.

#bash sete.sh
1111
sete.sh: line 4: not_exists_command: command not found
2222

良好脚本应该出错了第一时间就退出,这样马上就能知道发生错误的地方,如果跳过错误,那么后续脚本功能也可能有问题了,而且会让问题排查偏离问题根源.

通过在脚本的开头加入set -e

#cat sete.sh
#!/bin/bash
set -e
echo '1111'
not_exists_command
echo '2222'

bash会在命令的发返回码非0的时候直接退出,而不是继续执行后面的命令

#bash sete.sh
1111
sete.sh: line 4: not_exists_command: command not found

0x03 set -u

很多编程语言都有规定变量使用之前必须定义,或者是变量使用之前必须赋值. 但是默认情况下,bash没有这个要求,比如下面的脚本

#cat setu.sh
#!/bin/bash
echo "var is [${var}]"

其输出如下,可以看到var这个变量没有赋值,在后面被使用的时候没有报错,只是值为空. 这个很多时候就会引起奇怪的BUG.

#bash setu.sh
var is []

加上set -u选项,

#cat setu.sh
#!/bin/bash
set -u
echo "var is [${var}]"

可以看到直接报错var这个变量没有绑定.

#bash setu.sh
setu.sh: line 4: var: unbound variable

0xfe 更多选项

set -E

bash里面有个自带的trap命令对可以对脚本运行期间收到的各种signal进行处理. 有几个特殊的signal是bash自己定义的.其中一个是ERR,表示脚本在set -e的情况下,如果有命令执行返回码非0,那么trap ERR配置的命令被执行. 但是默认情况下,只有代码顶层调用的命令返回码非0才触发,当命令在bash函数中非0退出时,trap ERR的命令不会执行,此时需要加上set -E选项,让函数中执行的命令非0退出时也可以触发trap命令执行.

0xff 总结

推荐大家写bash脚本的时候,把set -xeu放到最前面,让shell有更多高级语言的特征. 如果使用了trap ERR特性,可以把set -E 加上.

大家在写bash脚本的时候有什么其他有用的小技巧,欢迎留言讨论.

Tags:

最近发表
标签列表