概述
平时在学习大牛的Shell脚本时,我们经常在脚本的开头看到很多set开头的命令,比如
#! /usr/bin/env bash set -e set -u set -x 或者 set -eux
但是,人们经常忽略这几个set命令的含义,我要说的是这个命令的作用其实非常的强大,可以提供脚本的debug效率和安全性。好了,下面我们就一 一分析一下这几个命令的真正含义。
set命令为shell内建命令,通过help set可以看到关于set的帮助信息。其主要作用是改变 shell 选项和位置参数的值,或者显示 shell 变量的名称和值。在终端下,如果执行set命令,就会显示当前shell下所有的环境配置信息。
错误处理
一般情况下,每个Linux shell命令执行完毕后,都会返回一个执行结果,并将其保存到$?中,一般0表示命令执行成功,非零表示命令执行失败。比如,
$ set $ echo $? 0 0表示set命令执行成功
shell脚本中一般会使用到大量的命令,严格意义上,我们应该小心的检查每个关键命令的执行结果,以确定之后的执行逻辑。一般的处理情形如下
#! /usr/bin/env bash PID=`pidof dockers` RET=$? if [ $RET -eq 0 ];then echo "docker's pid is $PID" else echo "docker don't run" fi #这里故意写成dockers,这样pidof就会执行失败。
如果命令较少的话,这种写法可能还能被接受,如果shell脚本的规模比较大时,可想而知,如果都按照这种方式处理,整个脚本的代码结构会变得十分的丑陋,而且,如果我们忘记了检查命令返回值,可能会导致脚本程序执行紊乱,造成系统不安全。 -e选项就是解决这个问题的一种十分优雅的方案,-e表示如果一个命令以非零状态退出,则整个shell脚本程序就会立即退出。比如,
#!/usr/bin/env bash PID=`pidof dockers` echo "pidof return 1" 如果,我们没有添加set -e,该脚本的执行结果为: pidof return 1
加上set -e之后,脚本的执行结果为:
在这里插入代码片
可以看到,shell在检测到pidof返回1之后,就会立即退出,不会继续执行,从而可以保证脚本安全的退出。 可是有的时候,命令返回1并不代表执行失败,这时如果启用了set -e,那么脚本就会立即退出,这不是我们想看到的,解决办法有两种:
#!/usr/bin/env bash set -e ... ... set +e command 1 command 2 set -e ... ...
通过 set +e关闭 -e选项,通过set -e再次打卡-e选项。
#! /usr/bin/env bash set -e ... ... command1 || true 退出
-o errexit等同于-e选项。
变量未定义
shell脚本中,如果遇到未定义的变量,一般会按照空值来处理,比如,
#!/usr/bin/env bash echo $NONE echo "NONE not set"
NONE变量从未定义过,打印NONE时会显示为空,而后继续打印下面的语句。这是不安全的,我们希望在遇到未定义的变量时,shell应该提示,并立即退出,-u选项可以完美的解决这个问题。在上面的脚本中加上set -u,再次执行,结果如下:
#!/usr/bin/env bash set -u echo $NONE echo "NONE not set"
结果如下:
$ /set.sh: 行 18: NONE:未绑定的变量
可以看到,shell在检测到未定义变量NONE之后,立即提示并退出了shell。-o nounset等同于-u选项。
跟踪调试
在编写较大规模的shell脚本时,不可能一次就编写出正确的脚本,当出现bug时,我们可能希望可以看一下脚本的执行流程,-x选项可以打印当前执行的命令,方便调试、跟踪脚本的执行流程。
#! /usr/bin/env bash set -x ls set.sh echo "ABC" + ls set.sh set.sh + echo ABC ABC
+号后面表示当前执行的命令,-o xtrace等同于-x选项。
管道
管道作为shell处理的终极武器,被人们经常用来处理复杂的业务处理,可以在一个管道命令序列中,只要最后的命令执行成功,整体的管道命令序列处理就会返回0,这使得我们不能跟踪管道中间命令的执行结果,这时-e选项就失去了作用,比如,
#! /usr/bin/env bash set -e cmd | echo "abc" echo "efg" 执行结果如下: abc ./set.sh: 行 23: cmd:未找到命令 efg
可以看到,虽然cmd命令执行失败,但是"efg"依然打印了出来。所以,对于管道命令,set -e失去了约束,shell 提供-o pipefail选项来检测管道命令的执行状态,开启这个选项之后,只要管道中存在失败的命令,shell脚本就会立即退出。
#! /usr/bin/env bash set -eo pipefail cmd | echo "abc" echo "efg" 执行结果: abc ./set.sh: 行 23: cmd:未找到命令
总结
经过上面的分析,相信大家已经了解了关于set的几个常用的选项以及它们的具体含义,它们是如此的重要,以至于在任何脚本的开头都要将它们添加上去,这样不但会提供脚本的编写、调试效率还能避免很多安全陷阱。一般的书写方式如下:
#! /usr/bin/env bash set -eux set -o pipefail