写 shell 脚本的五个习惯:从「在我机器上能跑」到「在哪都能跑」
写过一段时间 shell 脚本的人,大概都经历过这样的循环:脚本在自己的机器上跑得好好的,拷到同事的 Mac 上就报「bad interpreter」,扔到 CI 上又提示某个环境变量不存在。问题往往不在逻辑,而在脚本开头那几行没人细看的设置。
下面五个习惯,都是踩过坑之后才补齐的。
一、用 set 把失败当失败
shell 最反直觉的地方是:命令失败了,脚本还会继续往下跑。
cp package.json dist/
npm publish # 上面 cp 失败了,这里照样执行开头加上这三行,行为立刻变得像一个正常的程序:
set -euo pipefail- `-e`:任何命令返回非零就退出
- `-u`:引用未定义变量时报错,而不是当成空字符串
- `-o pipefail`:管道中任一环失败都算失败
注意 `set -e` 有例外:出现在 `if`、`while`、`&&`、`||` 中的命令失败不会触发退出。这是设计上的好处,让错误处理可以写成显式的分支。
二、路径一律加引号,一律从变量取
# 危险
rm -rf $BUILD_DIR/build
# 安全
rm -rf "${BUILD_DIR}/build"如果 `BUILD_DIR` 是空的,第一行就变成 `rm -rf /build`;如果路径里有空格,第二行仍然能正确工作。
再加一条:变量展开默认加花括号 `${VAR}`,后面紧跟其他字符时不会歧义。
三、脚本开头自己定位目录
依赖相对路径的脚本,从别的目录调用就会挂。开头加一句自定位:
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cd "${SCRIPT_DIR}"这样无论从哪里调用,脚本都在自己所在的目录执行,配置文件和资源路径都不用改。
四、临时文件用 mktemp,退出时清掉
TMP_DIR="$(mktemp -d)"
trap 'rm -rf "${TMP_DIR}"' EXIT`trap ... EXIT` 保证脚本正常结束、报错退出、被 Ctrl+C 打断时都会清理。这比在末尾写一行 `rm -rf` 可靠得多——中途失败时那一行根本不会执行。
用 `$$` 或 `date +%s` 拼临时文件名则在并发时会撞车。
五、别用 ls 解析输出
# 文件名带空格就崩
for f in $(ls *.log); do
# 正确
for f in *.log; do需要处理任意文件名(含换行)时,用 `find -print0` 配 `while IFS= read -r -d ''` :
find . -name '*.log' -print0 | while IFS= read -r -d '' f; do
gzip "${f}"
done`ls` 的输出是给人看的,不是给程序解析的。
一个可以直接抄的模板
把这些拼起来,就是脚本开头该有的样子:
#!/usr/bin/env bash
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
cd "${SCRIPT_DIR}"
TMP_DIR="$(mktemp -d)"
trap 'rm -rf "${TMP_DIR}"' EXIT
readonly BUILD_DIR="${1:-dist}"
mkdir -p "${BUILD_DIR}"排查工具
写完先用 `shellcheck script.sh` 过一遍。它能把上面这些问题中的大部分直接指出来,包括未加引号的变量、无用的 `ls`、危险的 `rm -rf` 通配。把它接进 CI,比事后调试省时间。
小结
shell 的默认行为偏向「宽松」,它假定你清楚自己在做什么。这五个习惯做的其实是同一件事:把宽松的默认值收紧成严格模式——失败就停、路径加引号、位置自定位、临时文件有始有终、输出不靠解析。改成这样之后,脚本从「在我机器上能跑」变成「在哪都能跑」。
- 点赞
- 收藏
- 关注作者
评论(0)