对于set命令-o参数的pipefail选项,linux是这样解释的:
“If set, the return value of a pipeline is the value of the last (rightmost) command to exit with a non-zero status,or zero if all commands in the pipeline exit successfully. This option is disabled by default.”
设置了这个选项以后,包含管道命令的语句的返回值,会变成最后一个返回非零的管道命令的返回值。听起来比较绕,其实也很简单:
set命令的-e参数,linux自带的说明如下:
“Exit immediately if a simple command exits with a non-zero status.”
也就是说,在”set -e”之后出现的代码,一旦出现了返回值非零,整个脚本就会立即退出。有的人喜欢使用这个参数,是出于保证代码安全性的考虑。但有的时候,这种美好的初衷,也会导致严重的问题。
set -x 与 set +x命令的作用实际是用于输出详细日志,是Shell脚本中使用echo命令输出的替代方案。更适用于输出大量日志的场景使用
set -x 是开启,set +x是关闭,set -o是查看 (xtrace,追踪一段代码的显示情况)
原文地址:https://www.cnblogs.com/rohens-hbg/p/17075942.html
Shell脚本开发之set命令
寻花之梦~~
于 2021-09-27 11:21:29 发布
1875
收藏 12
分类专栏: AutomationOps 文章标签: linux perl 运维
版权
AutomationOps
专栏收录该内容
41 篇文章2 订阅
订阅专栏
文章目录
描述
set -u
set -x
Bash 的错误处理
set -e
set -o pipefail
总结
描述
在开发Bash脚本的时候,有一个重要的细节大家常常忽视,就是利用set命令来处理一些命令异常和控制脚本的退出。
在自动化运维体系中,发现很多同学在大量脚本内都使用了set命令。
set命令是 Bash 脚本的重要环节,却常常被忽视,导致脚本的安全性和可维护性出问题。本文主要介绍它的基本用法,让你可以更安心地使用 Bash 脚本。
我们知道,Bash 执行脚本的时候,会创建一个新的 Shell。
$ bash script.sh
1
上面代码中,script.sh是在一个新的 Shell 里面执行。这个 Shell 就是脚本的执行环境,Bash 默认给定了这个环境的各种参数。
set命令用来修改 Shell 环境的运行参数,也就是可以定制环境。一共有十几个参数可以定制,官方手册有完整清单,本文介绍其中最常用的四个。
顺便提一下,如果命令行下不带任何参数,直接运行set,会显示所有的环境变量和 Shell 函数。
$ set
1
set -u
执行脚本的时候,如果遇到不存在的变量,Bash 默认忽略它。
#!/usr/bin/env bash
echo $a
echo bar
上面代码中,$a是一个不存在的变量。执行结果如下:
可以看到,echo $a输出了一个空行,Bash 忽略了不存在的$a,然后继续执行echo bar。大多数情况下,这不是开发者想要的效果,遇到变量不存在,脚本应该报错,而不是默默地往下执行。
set -u就用来改变这种行为。在脚本头部加上它,遇到不存在的变量就会报错,并停止执行后面的操作。
#!/usr/bin/env bash
set -u
echo $a
echo bar
运行结果如下:
script.sh: line 5: a: unbound variable #未绑定的变量
1
可以看到,脚本报错了,并且不再执行后面的语句。-u还有另一种写法-o nounset,两者是等价的。
$ set -o nounset
1
set -x
默认情况下,脚本执行后,屏幕只显示运行结果,没有其他内容。如果多个命令连续执行,它们的运行结果就会连续输出。有时会分不清,某一段内容是什么命令产生的。
set -x用来在运行结果之前,先输出执行的那一行命令。
#!/usr/bin/env bash
set -x
echo bar
执行上面的脚本,结果如下:
$ bash script.sh
+ echo bar #会输出详细过程
bar
可以看到,执行echo bar之前,该命令会先打印出来,行首以+表示。这对于调试复杂的脚本是很有用的。
-x还有另一种写法-o xtrace。
set -o xtrace
1
Bash 的错误处理
如果脚本里面有运行失败的命令(返回值非0),Bash 默认会继续执行后面的命令。
#!/usr/bin/env bash
foo
echo bar
上面脚本中,foo是一个不存在的命令,执行时会报错。但是,Bash 会忽略这个错误,继续往下执行。
$ bash script.sh
script.sh:行3: foo: 未找到命令
bar
可以看到,Bash 只是显示有错误,并没有终止执行。
这种行为很不利于脚本安全和除错。实际开发中,如果某个命令失败,往往需要脚本停止执行,防止错误累积。这时,一般采用下面的写法。
$command || exit 1
例如:foo || exit 1
1
2
上面的写法表示只要command有非零返回值,脚本就会停止执行。
如果停止执行之前需要完成多个操作,就要采用下面三种写法。
# 写法一
command || { echo "command failed"; exit 1; }
# 写法二
if ! command; then echo "command failed"; exit 1; fi
# 写法三
command
if [ "$?" -ne 0 ]; then echo "command failed"; exit 1; fi
另外,除了停止执行,还有一种情况。如果两个命令有继承关系,只有第一个命令成功了,才能继续执行第二个命令,那么就要采用下面的写法。
$command1 && $command2
1
set -e
上面这些写法多少有些麻烦,容易疏忽。set -e从根本上解决了这个问题,它使得脚本只要发生错误,就终止执行。
#!/usr/bin/env bash
set -e
foo
echo bar
执行结果如下:
$ bash script.sh
script.sh:行4: foo: 未找到命令
可以看到,第4行执行失败以后,脚本就终止执行了。
set -e根据返回值来判断,一个命令是否运行失败。但是,某些命令的非零返回值可能不表示失败,或者开发者希望在命令失败的情况下,脚本继续执行下去。这时可以暂时关闭set -e,该命令执行结束后,再重新打开set -e。
set +e
command1
command2
set -e
上面代码中,set +e表示关闭-e选项,set -e表示重新打开-e选项。
还有一种方法是使用command || true,使得该命令即使执行失败,脚本也不会终止执行。
#!/bin/bash
set -e
foo || true
echo bar
上面代码中,true使得这一行语句总是会执行成功,后面的echo bar会执行。
-e还有另一种写法-o errexit。
set -o errexit
1
set -o pipefail
set -e有一个例外情况,就是不适用于管道命令。
所谓管道命令,就是多个子命令通过管道运算符(|)组合成为一个大的命令。Bash 会把最后一个子命令的返回值,作为整个命令的返回值。也就是说,只要最后一个子命令不失败,管道命令总是会执行成功,因此它后面命令依然会执行,set -e就失效了。
请看下面例子:
#!/usr/bin/env bash
set -e
foo | echo a
echo bar
执行结果如下:
$ bash script.sh
a
script.sh:行4: foo: 未找到命令
bar
上面代码中,foo是一个不存在的命令,但是foo | echo a这个管道命令会执行成功,导致后面的echo bar会继续执行。
set -o pipefail用来解决这种情况,只要一个子命令失败,整个管道命令就失败,脚本就会终止执行。
#!/usr/bin/env bash
set -eo pipefail
foo | echo a
echo bar
运行后,结果如下:
$ bash script.sh
a
script.sh:行4: foo: 未找到命令
可以看到,echo bar没有执行。
总结
set命令的上面这四个参数,一般都放在一起使用。
# 写法一
set -euxo pipefail
# 写法二
set -eux
set -o pipefail
这两种写法建议放在所有 Bash 脚本的头部。
另一种办法是在执行 Bash 脚本的时候,从命令行传入这些参数。
$ bash -euxo pipefail script.sh
原文链接:https://blog.csdn.net/chengyinwu/article/details/120504385