命令行与文本处理 / 知识点
Shell 脚本工程实践手册
脚本骨架与执行边界
给脚本建立统一入口、严格模式、main 函数和显式退出。
生产脚本标准骨架
给脚本建立统一入口、严格模式、main 函数和显式退出。
推荐实现
#!/usr/bin/env bash
set -Eeuo pipefail
main() {
printf 'start\n'
}
main "$@"预期结果
输出 `start`,脚本以退出码 0 结束。关键边界
main "$@" 让入口清晰;严格模式适合大多数新脚本,但仍需理解 set -e 的例外语义。
根据部署环境选择解释器路径。
选择 Shebang
根据部署环境选择解释器路径。
推荐实现
#!/usr/bin/env bash
printf '%s\n' "$BASH_VERSION"预期结果
使用当前 `PATH` 中的 Bash 执行并输出版本。关键边界
/usr/bin/env bash 便于跨发行版;/bin/bash 路径更固定,适合受控服务器。不要把 Bash 脚本写成 #!/bin/sh。
避免脚本顶层散落业务逻辑,便于测试和阅读。
用 main 作为唯一入口
避免脚本顶层散落业务逻辑,便于测试和阅读。
推荐实现
#!/usr/bin/env bash
main() {
printf 'args=%s\n' "$#"
}
main "$@"预期结果
传入 2 个参数时输出 `args=2`。关键边界
顶层只保留常量、函数定义和 main "$@"。
避免因为调用目录不同导致相对路径失效。
明确脚本工作目录
避免因为调用目录不同导致相对路径失效。
推荐实现
SCRIPT_DIR="$(
cd -- "$(dirname -- "${BASH_SOURCE[0]}")" >/dev/null 2>&1
pwd -P
)"
printf '%s\n' "$SCRIPT_DIR"预期结果
输出脚本自身所在目录的绝对路径。关键边界
不要默认当前目录就是脚本目录;配置、模板和资源文件应基于 SCRIPT_DIR 定位。
让新建文件默认不对其他用户开放。
限制脚本默认权限
让新建文件默认不对其他用户开放。
推荐实现
umask 077
tmp_file="$(mktemp)"
stat -c '%a' "$tmp_file"
rm -f -- "$tmp_file"预期结果
临时文件权限通常显示为 `600`。关键边界
涉及凭据、备份、导出数据时建议设置更严格的 umask。
参数、配置与输入
脚本启动时尽早检查必需输入。
校验必填参数
脚本启动时尽早检查必需输入。
推荐实现
#!/usr/bin/env bash
set -u
input="${1:-}"
if [[ -z "$input" ]]; then
printf 'usage: %s <input>\n' "$0" >&2
exit 64
fi
printf 'input=%s\n' "$input"预期结果
未传参数时输出 usage 并返回非 0;传入值时正常输出。关键边界
不要直接读取 $1 再等 set -u 报错;用户输入错误应给明确提示。
用参数展开表达默认配置。
为可选参数提供默认值
用参数展开表达默认配置。
推荐实现
PORT="${PORT:-8080}"
printf 'port=%s\n' "$PORT"预期结果
未设置 `PORT` 时输出 `port=8080`。关键边界
默认值要集中定义,避免散落在业务逻辑中。
让命令行参数覆盖环境变量,形成明确优先级。
区分环境变量与命令行参数
让命令行参数覆盖环境变量,形成明确优先级。
推荐实现
PORT="${PORT:-8080}"
if [[ ${1:-} != "" ]]; then
PORT="$1"
fi
printf 'port=%s\n' "$PORT"预期结果
若同时设置环境变量和位置参数,则位置参数生效。关键边界
推荐优先级:命令行 > 环境变量 > 默认值。
对 -f/-v/-p 等短选项使用 Bash 内建解析。
使用 getopts 解析短参数
对 -f/-v/-p 等短选项使用 Bash 内建解析。
推荐实现
verbose=0
file=""
while getopts ":vf:" opt; do
case "$opt" in
v) verbose=1 ;;
f) file="$OPTARG" ;;
:) printf 'missing value: -%s\n' "$OPTARG" >&2; exit 64 ;;
\?) printf 'unknown option: -%s\n' "$OPTARG" >&2; exit 64 ;;
esac
done
printf 'verbose=%s file=%s\n' "$verbose" "$file"预期结果
例如 `-v -f demo.txt` 输出 `verbose=1 file=demo.txt`。关键边界
getopts 适合短参数;复杂长参数建议保持简单,或使用成熟命令行解析方案。
加载配置前确认文件存在、可读和来源可信。
读取配置文件前先校验
加载配置前确认文件存在、可读和来源可信。
推荐实现
config="./app.env"
if [[ ! -f "$config" || ! -r "$config" ]]; then
printf 'invalid config: %s\n' "$config" >&2
exit 66
fi
printf 'config ok\n'预期结果
配置文件存在且可读时输出 `config ok`。关键边界
不要对不可信文件直接 source;Shell 配置文件本质上可以执行任意代码。
读取文本时保留前导空格和反斜杠。
安全读取逐行文本
读取文本时保留前导空格和反斜杠。
推荐实现
while IFS= read -r line || [[ -n "$line" ]]; do
printf '<%s>\n' "$line"
done < input.txt预期结果
每一行按原内容读取,包括最后一行没有换行符的情况。关键边界
常规文本遍历优先 IFS= read -r。
保留每个参数自身边界。
安全遍历脚本参数
保留每个参数自身边界。
推荐实现
for arg in "$@"; do
printf '<%s>\n' "$arg"
done预期结果
参数中含空格时仍作为一个整体输出。关键边界
不要用 for arg in $@ 或 for arg in $*。
错误处理与退出码
让管道中间命令失败时整体可感知。
启用 pipefail
让管道中间命令失败时整体可感知。
推荐实现
set -o pipefail
false | cat
printf 'status=%s\n' "$?"预期结果
输出非 0 的 `status`。关键边界
没有 pipefail 时,管道通常只看最后一条命令退出码。
把 set -e 当作辅助保护,不当作完整异常系统。
谨慎使用 set -e
把 set -e 当作辅助保护,不当作完整异常系统。
推荐实现
set -e
if grep -q 'needle' missing.txt 2>/dev/null; then
printf 'found\n'
else
printf 'not found\n'
fi
printf 'still running\n'预期结果
grep 失败出现在 if 条件中时,脚本不会因为 `set -e` 自动退出。关键边界
set -e 在 if、while、&&、||、部分管道等上下文有例外;关键失败应显式判断。
对不可恢复步骤直接判断并给出明确错误。
显式检查关键命令
对不可恢复步骤直接判断并给出明确错误。
推荐实现
if ! cp -- source.txt backup.txt; then
printf 'backup failed\n' >&2
exit 1
fi
printf 'backup ok\n'预期结果
复制失败时打印 `backup failed` 并退出;成功时输出 `backup ok`。关键边界
关键变更不要只依赖 set -e。
让错误格式和退出行为保持一致。
统一错误函数
让错误格式和退出行为保持一致。
推荐实现
die() {
printf 'ERROR: %s\n' "$*" >&2
exit 1
}
[[ -f config.yml ]] || die "config.yml not found"预期结果
配置不存在时 stderr 输出统一 `ERROR:` 前缀并退出。关键边界
错误信息应说明对象和原因,不写只有 failed 的模糊文案。
区分参数错误、输入缺失和运行失败。
使用有意义的退出码
区分参数错误、输入缺失和运行失败。
推荐实现
EX_USAGE=64
EX_NOINPUT=66
[[ $# -ge 1 ]] || exit "$EX_USAGE"
[[ -f "$1" ]] || exit "$EX_NOINPUT"预期结果
参数缺失返回 64;文件不存在返回 66。关键边界
不必追求过多退出码,但外部调用方需要能区分用户错误和系统错误。
为意外失败输出命令和行号。
捕获 ERR 获取失败位置
为意外失败输出命令和行号。
推荐实现
set -E
on_error() {
local status=$?
printf 'failed: line=%s status=%s command=%s\n' \
"$1" "$status" "$BASH_COMMAND" >&2
return "$status"
}
trap 'on_error "$LINENO"' ERR
false预期结果
输出失败行号、状态码和命令。关键边界
ERR trap 受 Bash 错误传播规则影响;用于补充诊断,不替代显式错误处理。
避免用无条件 || true 把真实故障隐藏掉。
不要吞掉失败
避免用无条件 || true 把真实故障隐藏掉。
推荐实现
if ! output="$(some_command 2>&1)"; then
printf 'command failed: %s\n' "$output" >&2
exit 1
fi预期结果
命令失败时保留原始错误并返回非 0。关键边界
|| true 只用于“失败就是允许结果”的明确场景,并应加注释说明。
日志与可观测性
用固定级别和时间格式输出日志。
统一日志函数
用固定级别和时间格式输出日志。
推荐实现
log() {
local level="$1"
shift
printf '%s [%s] %s\n' "$(date '+%Y-%m-%dT%H:%M:%S%z')" "$level" "$*" >&2
}
log INFO "service started"预期结果
stderr 输出带时间和 `INFO` 级别的日志。关键边界
业务结果写 stdout,诊断日志写 stderr,便于管道和自动化调用。