自动化脚本的骨架与日志

脚本写得多了,会发现真正省时间的是骨架:参数、日志、锁、清理、退出码。

自动化现场与效率2025-12-18约 1 分钟299 字

临时脚本和能长期跑的脚本,差别不在功能多少,而在有没有骨架。骨架固定下来,写新脚本只需要填中间那段业务逻辑。

一个可复用的骨架

bash
#!/usr/bin/env bash
set -euo pipefail

NAME="$(basename "$0" .sh)"
LOG="/var/log/${NAME}.log"
log() { printf '%s %s\n' "$(date '+%F %T')" "$*" | tee -a "$LOG"; }

usage() { echo "用法: $0 [-n] <目标>" >&2; exit 2; }
DRY=0
while getopts "n" opt; do
  case $opt in
    n) DRY=1 ;;
    *) usage ;;
  esac
done
shift $((OPTIND-1))
TARGET="${1:?缺少目标参数}"

TMP="$(mktemp -d)"
trap 'rm -rf "$TMP"' EXIT

log "开始: target=$TARGET dry=$DRY"
# ... 业务逻辑 ...
log "完成"

几行代码解决了五件事:参数校验、日志落盘、临时目录、异常清理、失败退出码。

日志要有结构

至少包含时间、阶段、对象、结果。排查时用 grep 能直接筛出一次运行:

bash
grep -F "2026-03-01 03:0" /var/log/backup.log

并发与锁

同一个脚本被定时任务和手动执行同时触发,是最常见的“数据写坏”原因:

bash
exec 9>/var/lock/${NAME}.lock
flock -n 9 || { log "已有实例运行,退出"; exit 0; }

失败要响

bash
if ! do_something; then
  log "失败: do_something"
  exit 1
fi

退出码非 0,调度器或监控才能感知。只打印错误但返回 0,等于告诉系统“一切正常”。

trap 里的清理也会失败

rm -rf 在权限不足时返回非 0,配合 set -e 可能掩盖真正的错误。清理命令写成 rm -rf "$TMP" || true,别让它改变退出码。

小结

骨架的价值是“每次都不用重新想”。参数、日志、锁、清理、退出码五件套固定,脚本质量的下限就被抬高了。

说明:文中的地址、域名、主机名与账号均为脱敏示例;配置片段来自实际环境,但版本与网络条件不同,照搬前请先在测试环境验证。最后校对:2025-12-18。