命令行与文本处理 / 知识点
Shell 脚本工程实践手册
安全与高风险操作
敏感值优先通过受控文件、stdin 或进程专用环境注入。
凭据不写进命令行
敏感值优先通过受控文件、stdin 或进程专用环境注入。
推荐实现
TOKEN_FILE="/run/secrets/api_token"
[[ -r "$TOKEN_FILE" ]] || {
printf 'token unavailable\n' >&2
exit 1
}
IFS= read -r token <"$TOKEN_FILE"
printf 'token loaded, length=%s\n' "${#token}"预期结果
只输出 Token 长度,不输出 Token 本身。关键边界
环境变量也可能被子进程继承;凭据传递方式应按平台威胁模型选择。
日志只记录必要元数据。
不要把密码写入日志
日志只记录必要元数据。
推荐实现
user="alice"
password="<PASSWORD>"
printf 'login user=%s\n' "$user"
# 不输出 password预期结果
日志只包含用户名,不包含密码。关键边界
Token、Cookie、Authorization、私钥、数据库密码都应默认视为敏感。
高权限脚本不要完全信任调用方的 PATH。
固定安全 PATH
高权限脚本不要完全信任调用方的 PATH。
推荐实现
PATH='/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin'
export PATH
command -v rm预期结果
输出受控 PATH 中解析到的 `rm` 路径。关键边界
sudo/root 脚本尤其需要防止 PATH 劫持。
删除、同步、批量修改前提供只预览模式。
高风险操作增加 dry-run
删除、同步、批量修改前提供只预览模式。
推荐实现
DRY_RUN="${DRY_RUN:-1}"
target="/srv/app/tmp/demo"
if [[ "$DRY_RUN" == "1" ]]; then
printf '[dry-run] rm -rf -- %q\n' "$target"
else
rm -rf -- "$target"
fi预期结果
默认只打印将执行的命令,不真正删除。关键边界
高风险工具默认 dry-run 比默认执行更安全。
破坏性动作使用明确开关,而不是模糊交互。
高风险操作要求显式确认参数
破坏性动作使用明确开关,而不是模糊交互。
推荐实现
CONFIRM="${CONFIRM:-}"
if [[ "$CONFIRM" != "DELETE" ]]; then
printf 'set CONFIRM=DELETE to continue\n' >&2
exit 1
fi
printf 'confirmed\n'预期结果
未显式设置确认值时拒绝执行。关键边界
自动化环境不适合依赖 read -p 'Are you sure?';显式参数更可审计。
质量、测试与可维护性
用静态分析发现引用、数组、条件和兼容性问题。
先运行 ShellCheck
用静态分析发现引用、数组、条件和兼容性问题。
推荐实现
shellcheck script.sh预期结果
无问题时通常不输出并返回 0;有问题时给出规则编号和位置。关键边界
CI 中建议把 ShellCheck 作为必跑检查。
自动统一缩进、换行和 Shell 代码风格。
用 shfmt 统一格式
自动统一缩进、换行和 Shell 代码风格。
推荐实现
shfmt -d script.sh预期结果
格式一致时无 diff;不一致时输出建议修改。关键边界
CI 可用 -d 检查,开发阶段再决定是否自动写回。
把可测试逻辑放函数,不把所有代码写在顶层。
函数化以便单元测试
把可测试逻辑放函数,不把所有代码写在顶层。
推荐实现
is_even() {
(( $1 % 2 == 0 ))
}
is_even 4预期结果
`is_even 4` 返回 0,`is_even 3` 返回非 0。关键边界
函数只通过参数和返回码沟通时最容易测试。
对关键函数和命令行为编写自动化测试。
用 Bats 测试 Shell 行为
对关键函数和命令行为编写自动化测试。
推荐实现
@test "is_even accepts even number" {
run bash -c '(( 4 % 2 == 0 ))'
[ "$status" -eq 0 ]
}预期结果
测试通过时 Bats 报告成功。关键边界
适合部署脚本、安装脚本和运维工具的回归测试。
不仅测试 happy path,还要验证输入缺失和依赖失败。
测试失败路径
不仅测试 happy path,还要验证输入缺失和依赖失败。
推荐实现
if ./script.sh >/tmp/out 2>/tmp/err; then
printf 'expected failure but succeeded\n' >&2
exit 1
fi
grep -q 'usage:' /tmp/err预期结果
脚本无参数失败,且 stderr 包含 usage 时测试通过。关键边界
错误路径往往比成功路径更容易在生产中出事故。
一个函数只做一件事,避免隐式修改全局状态。
保持函数短小单一
一个函数只做一件事,避免隐式修改全局状态。
推荐实现
load_config() {
local file="$1"
[[ -r "$file" ]] || return 1
cat -- "$file"
}预期结果
函数只负责读取配置并通过 stdout 返回内容。关键边界
函数越纯,越容易测试、复用和重构。
让使用方式可自解释。
为复杂脚本提供 --help
让使用方式可自解释。
推荐实现
usage() {
cat <<'EOF'
Usage:
script.sh -f <FILE> [-v]
EOF
}
usage预期结果
输出稳定的 Usage 文本。关键边界
帮助文本应包含必填参数、可选参数和至少一个最小示例。
兼容性与运行环境
用了数组、[[ ]]、进程替换等 Bash 能力,就明确声明 Bash。
明确 Bash 与 POSIX sh 边界
用了数组、[[ ]]、进程替换等 Bash 能力,就明确声明 Bash。
推荐实现
#!/usr/bin/env bash
arr=(a b)
[[ ${#arr[@]} -eq 2 ]]
printf 'bash required\n'预期结果
在 Bash 下正常执行。关键边界
不要一边使用 Bash 专属语法,一边声称脚本兼容 /bin/sh。
依赖关联数组、较新内建能力时尽早拒绝旧版本。
检查 Bash 最低版本
依赖关联数组、较新内建能力时尽早拒绝旧版本。
推荐实现
required_major=4
if (( BASH_VERSINFO[0] < required_major )); then
printf 'Bash 4+ required\n' >&2
exit 69
fi
printf 'version ok\n'预期结果
Bash 4+ 输出 `version ok`。关键边界
macOS 老系统 Bash 3.2 是常见兼容风险。
脚本启动时一次性确认必要工具存在。
检查外部依赖
脚本启动时一次性确认必要工具存在。
推荐实现
require_cmd() {
command -v "$1" >/dev/null 2>&1 || {
printf 'missing command: %s\n' "$1" >&2
exit 69
}
}
require_cmd curl
require_cmd jq预期结果
依赖存在时无输出;缺失时给出明确工具名并退出。关键边界
不要运行到中途才发现关键依赖缺失。
脚本应调用真实命令,不依赖交互 Shell alias。
避免依赖命令别名
脚本应调用真实命令,不依赖交互 Shell alias。
推荐实现
command rm --help >/dev/null 2>&1 || true
type -a rm预期结果
显示真实命令解析位置。关键边界
脚本通常不展开 alias,但函数、PATH 和环境仍可能改变命令解析。
文本排序、正则和字符类依赖稳定时显式设置 locale。
设置可预测 Locale
文本排序、正则和字符类依赖稳定时显式设置 locale。
推荐实现
LC_ALL=C
export LC_ALL
printf '%s\n' b A a | sort预期结果
按 C locale 的确定性规则排序。关键边界
如果脚本需要 Unicode/本地化语义,则不要强行使用 C locale。
脚本默认不依赖 tty、交互密码和人工确认。
在 CI 使用非交互模式
脚本默认不依赖 tty、交互密码和人工确认。
推荐实现
if [[ -t 0 ]]; then
printf 'interactive stdin\n'
else
printf 'non-interactive stdin\n'
fi预期结果
CI/管道中通常输出 `non-interactive stdin`。关键边界
自动化脚本应通过参数和环境变量表达输入,而不是等待交互。