Linux 与服务器运维 / 系统课时
用 ShellCheck 提前发现问题
用 ShellCheck 提前发现问题
Shell 脚本最危险的缺陷往往不是语法错误,而是“能运行但在特殊输入下出错”。本节用 ShellCheck 检查变量引用、目录切换和 Shell 兼容性问题,并把检查加入发布前流程,让常见缺陷尽量在开发阶段暴露。
学习目标
- 能运行 ShellCheck 并读懂常见诊断信息
- 能修复未引用变量、危险目录切换与兼容性问题
- 能利用退出码把 ShellCheck 接入发布前检查
先确认 ShellCheck 可用
先检查本机是否已经安装 ShellCheck。不同系统的安装方式可能不同,只要下面命令能返回版本信息,就可以继续本节操作。
shellcheck --version预期输出
ShellCheck - shell script analysis tool
version: <VERSION><VERSION> 会随本机安装版本变化。如果出现 command not found,应先通过系统包管理器或 ShellCheck 官方发行包完成安装,再重新执行版本检查。
用有缺陷的脚本观察诊断
下面的脚本表面上能够执行,但存在两个典型隐患:目录切换失败后仍继续运行,以及未引用变量在包含空格或通配符时发生单词拆分和路径名展开。
cat > deploy.sh <<'EOF'
#!/usr/bin/env bash
target_dir=$1
package=$2
cd $target_dir
cp $package ./app.tar.gz
echo "deployed to $target_dir"
EOF
shellcheck deploy.sh预期结果
ShellCheck 会报告与 cd 失败处理和未引用变量有关的诊断;具体行号、提示措辞和附加诊断可能随 ShellCheck 版本变化。ShellCheck 的价值不在于看到警告后机械修改,而是利用诊断定位风险类型。这里需要重点确认变量是否应加双引号,以及 cd 失败时脚本是否应该立即停止。
修复引用和执行链问题
修复后的脚本先验证参数,再使用 cd -- "$target_dir" 并显式处理失败;复制文件时同样引用路径变量。-- 用于结束选项解析,避免以短横线开头的路径被命令误认为选项。
cat > deploy.sh <<'EOF'
#!/usr/bin/env bash
set -u
if [[ $# -ne 2 ]]; then
echo "usage: $0 <target-dir> <package>" >&2
exit 64
fi
target_dir=$1
package=$2
cd -- "$target_dir" || {
echo "cannot enter target directory: $target_dir" >&2
exit 1
}
cp -- "$package" ./app.tar.gz
echo "deployed to $target_dir"
EOF
shellcheck deploy.sh预期输出
`text
ShellCheck 没有发现问题时通常不输出内容,并以退出码 `0` 结束。可以直接读取退出码验证本次检查结果。
`bash
shellcheck deploy.sh
printf 'exit=%s\n' "$?"预期输出
exit=0明确脚本使用的 Shell 方言
ShellCheck 会根据 shebang 推断脚本方言。若脚本声明为 #!/bin/sh,就不应随意使用 [[ ... ]]、数组等 Bash 专有语法;如果脚本明确依赖 Bash,则应该直接声明 Bash。
cat > check-shell.sh <<'EOF'
#!/bin/sh
name=${1:-ops}
if [[ $name == ops ]]; then
echo "matched"
fi
EOF
shellcheck check-shell.sh预期结果
ShellCheck 会指出 [[ ... ]] 不属于标准 sh 语法;具体诊断编号和提示文字可能随版本变化。修复方向只有两类:要么把条件改成 POSIX sh 支持的 [ ... ],要么把 shebang 改成 Bash,并确保目标机器确实安装了 Bash。不要仅仅关闭诊断来掩盖运行环境与脚本语法不匹配的问题。
把检查变成发布门禁
ShellCheck 的退出码可以直接参与 &&、if 或 CI 流程。当检查失败时,不再执行后续发布动作,比依赖人工查看输出更可靠。
shellcheck deploy.sh && echo "lint passed"预期输出
lint passed真实项目可以把同样的检查放到提交钩子、构建流水线或部署脚本中。对于确实属于误报的规则,应只在最小范围内禁用,并写清原因;大范围关闭规则会让静态检查失去意义。
ShellCheck 适合承担“开发阶段提前发现高概率缺陷”的角色,但不能替代真实环境测试。静态检查通过后,关键脚本仍应在目标 Shell、真实路径、实际权限和失败场景下验证。