Shell 脚本里的 set -euo pipefail:让脚本出错就停下的三个开关
写 Shell 脚本的人,几乎都踩过同一个坑:脚本中间某一步明明已经失败了,后面的命令却照常执行,最后输出一个“成功”的假象。等到发现问题时,数据可能已经被写坏一半,故障定位也变得异常困难。本文就聊聊解决这个问题的三个开关:set -euo pipefail。
一、默认行为:出错也继续跑
先看一个最常见的备份脚本:
#!/bin/bash
tar -czf /backup/data.tar.gz /data
scp /backup/data.tar.gz backup-server:/backup/
rm -rf /data/tmp/*
如果第一步 tar 因为磁盘满了而失败,脚本不会停下来:第二步 scp 会去传一个不存在或不完整的文件,第三步还会继续清理临时文件。更糟的是,脚本最后的退出码是最后一条命令的退出码,调用方根本不知道中间出过错。
Shell 的默认策略是“每条命令独立成败,互不干涉”。这对交互式使用很友好,但对自动化脚本来说就是隐患。
二、-e:遇到错误立即退出
set -e(等价于 set -o errexit)让脚本在任何一条命令返回非零退出码时立刻退出,并把那个非零码作为脚本的退出码:
#!/bin/bash
set -e
tar -czf /backup/data.tar.gz /data
scp /backup/data.tar.gz backup-server:/backup/
rm -rf /data/tmp/*
现在只要 tar 失败,脚本马上停止,scp 和 rm 都不会执行,调用方也能通过退出码发现失败。
需要注意的是,-e 并不是在所有位置都生效,以下几种情况它不会触发退出:
- 写在
if条件里的命令,例如if grep -q foo file; then ...,即使grep没找到也会继续; while、until循环的条件部分;- 用
&&、||连接的命令中,除最后一个以外的部分; - 在命令后显式加了
|| true的地方。
这些例外其实是合理的:条件判断本身就是在“预期失败”的场景下使用。
三、-u:把未定义变量当作错误
set -u(等价于 set -o nounset)会让脚本在使用未定义变量时立即报错退出:
#!/bin/bash
set -u
backup_dir="/backup"
rm -rf "$BACKUP_DIR/tmp/*"
上面这段代码里,变量名手误写成了大写的 BACKUP_DIR,没有 -u 时它会被展开成空字符串,rm -rf 就会变成 rm -rf /tmp/*,后果不堪设想。有了 -u,脚本会在展开未定义变量的那一刻直接报错退出。
如果某个变量确实可能为空,可以用默认值语法显式声明意图:
log_file="${LOG_FILE:-/var/log/app.log}"
这样既保留了灵活性,又不会因为拼写错误而静默出错。
四、-o pipefail:管道里任何一段失败都算失败
这是最容易被忽视的一个。默认情况下,管道的退出码只取决于最后一段命令:
grep "ERROR" /var/log/app.log | wc -l
echo $?
如果 /var/log/app.log 根本不存在,grep 会报错,但 wc -l 仍然正常输出 0,整个管道的退出码是 0。在 set -e 下这段代码也不会触发退出,错误就这样被“吞掉”了。
set -o pipefail 改变了这个规则:管道中任何一段命令失败,整个管道的退出码就是最后一个失败命令的退出码。配合 -e 使用,管道里的错误同样会让脚本立即停止。
五、三个开关合起来用
实际写脚本时,推荐在脚本开头统一写上这一行:
#!/bin/bash
set -euo pipefail
它相当于同时打开了“遇错即停”“未定义变量即错”“管道错误不隐藏”三重保护。对于运维脚本、部署脚本、CI 流水线里调用的脚本,这一行几乎是标配。
一个更完整的模板还可以加上出错时的定位信息:
#!/bin/bash
set -euo pipefail
trap 'echo "脚本在第 $LINENO 行失败,退出码 $?" >&2' ERR
这样脚本失败时,日志里会直接记录出错的行号,排查起来快得多。
六、使用时的三个提醒
第一,-e 不适合交互式调试场景,调试时可以临时去掉,确认无误后再加回来。
第二,有些命令“失败”是预期内的,比如 grep 找不到内容返回 1。这种情况下要显式处理:grep -q foo file || true,或者用 if 包起来,让意图一目了然。
第三,set -euo pipefail 要写在脚本最开头、所有业务命令之前,否则前面的命令享受不到保护。
小结
set -e:任何命令失败就立即退出,不再“带病运行”;set -u:引用未定义变量就报错,杜绝拼写错误导致误删;set -o pipefail:管道中任何一段失败都如实反映到退出码上。
一行 set -euo pipefail,成本几乎为零,却能挡住 Shell 脚本里最常见的三类静默失败。下次写自动化脚本时,不妨先把它写在第二行。
- 点赞
- 收藏
- 关注作者
评论(0)