sed 原地替换配置前的备份与回滚方案

在 GNU/Linux 上修改配置，最小可用且可回滚的写法是 sed --in-place='.bak'：原文件内容会保存在同目录的 .bak 文件中，替换后的内容写回原路径。真正用于运维时，还应先预览差异、使用唯一备份名、执行服务自身的语法检查，并在检查失败时自动恢复。

本文示例明确针对 GNU sed。BSD/macOS sed 对 -i 参数的处理不同，不应把 GNU 写法原样复制到其他系统。先执行 sed --version 确认实现，再决定采用内置后缀备份还是独立 cp 备份。

前置条件：先理解 -i 实际改了什么

GNU sed 手册说明，-i[SUFFIX] 或 --in-place[=SUFFIX] 会把处理结果写入临时文件，处理结束后再将临时文件重命名为原路径。提供 SUFFIX 时，旧文件会按后缀生成备份；没有后缀时，原内容不会留下备份。

因此下面两条命令并不等价：

# 推荐：明确给出备份后缀，原内容保存在 app.conf.bak。
sed --in-place='.bak' 's/^port=.*/port=8080/' app.conf

# 谨慎使用：没有备份后缀，错误替换后无法依靠 sed 自身恢复。
sed --in-place 's/^port=.*/port=8080/' app.conf

长选项更适合脚本，因为 GNU sed 的 -i 接受可选参数。比如 sed -Ei 表示启用扩展正则并且不生成备份，而 sed -iE 会把 E 解释成备份后缀。把后缀写成 --in-place='.bak'，意图更明确。

图1：GNU sed 原地替换中原配置、临时文件、现行配置与后缀备份的静态关系。

初始化：准备配置并确认目标行唯一

假设要把服务监听端口从 7000 改成 8080。修改前先确认文件存在、是普通文件，并检查目标键出现次数。示例中的路径只是实验目录，生产环境应替换为真实配置路径。

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

# 使用实验文件，避免直接碰触系统配置。
config='./app.conf'
printf '%s\n' 'host=127.0.0.1' 'port=7000' 'mode=production' > "$config"

# 要求 port 配置只出现一次，避免宽泛替换多个段落。
count=$(grep -Ec '^port=' "$config" || true)
if [[ "$count" -ne 1 ]]; then
  printf 'port 配置数量异常：%s\n' "$count" >&2
  exit 1
fi

如果配置允许同名键出现在多个作用域，仅凭 ^port= 就不够，应把地址范围收紧到具体段落，或者改用该配置格式的专用工具。备份只能帮助恢复，不能让错误匹配变正确。

修改前预览：先看差异，再决定写入

在调用 -i 前，让普通 sed 把候选结果输出到标准输出，再用 diff 与原文件比较。这样不会修改文件，却能看到替换范围。

# Bash 进程替换把 sed 的候选结果交给 diff，不落盘也不改原文件。
diff -u -- "$config" 

diff 发现差异时会返回非零状态，所以在启用 set -e 的实验脚本中加了 || true。这不是忽略修改错误，而是允许“存在预期差异”继续展示。生产脚本可把差异保存为变更记录，由人工或发布系统确认后再进入写入阶段。

最小方案：用后缀备份完成替换与手动回滚

# GNU sed 会把修改前的内容保存为 app.conf.bak。
sed --in-place='.bak' 's/^port=.*/port=8080/' -- "$config"

# 核对新值，同时确认备份文件存在。
grep -n '^port=' "$config"
test -f "${config}.bak"

# 需要回滚时，用备份覆盖现行配置；-- 保证后续参数按路径处理。
cp --preserve=all -- "${config}.bak" "$config"

cp --preserve=all 尝试保留权限、所有权、时间戳、扩展属性和安全上下文。普通用户可能没有恢复所有权或某些安全属性的权限，因此生产配置通常应由具有相应权限的部署账户执行，并把复制失败视为真实失败。

这个最小方案适合单次人工操作，但固定的 .bak 会被下一次修改覆盖。连续发布、自动化变更或需要审计时，应使用带时间戳或发布编号的唯一备份名。

自动方案：唯一备份、语法检查与 ERR 回滚

下面的脚本把备份、替换、检查和失败恢复放在同一个执行单元中。配置检查用一个简单的键值规则演示；部署 Nginx、SSH、数据库等服务时，应替换成服务官方提供的配置检查命令。

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

config=${1:?用法: safe-edit.sh /path/to/app.conf}
stamp=$(date '+%Y%m%d-%H%M%S')
backup="${config}.bak.${stamp}"

# 只处理现有普通文件；符号链接交给后文的显式策略处理。
if [[ ! -f "$config" || -L "$config" ]]; then
  printf '目标必须是普通文件且不能是符号链接：%s\n' "$config" >&2
  exit 1
fi

# 修改前创建独立备份，并尽量保留全部文件属性。
cp --preserve=all -- "$config" "$backup"

rollback() {
  # 先关闭 ERR trap，避免恢复失败时递归触发自身。
  trap - ERR
  cp --preserve=all -- "$backup" "$config"
  printf '检查失败，已从备份恢复：%s\n' "$backup" >&2
}
trap rollback ERR

# 使用 GNU sed 原地写入；独立备份已经完成，因此这里不再创建固定后缀。
sed --in-place 's/^port=.*/port=8080/' -- "$config"

# 示例校验：实际部署应替换为服务自身的配置检查命令。
grep -Eq '^port=([1-9][0-9]{0,4})$' "$config"

# 确认修改确实发生；cmp 状态 0 表示相同，1 表示不同，2 表示出错。
if cmp --silent -- "$backup" "$config"; then
  printf '配置没有发生变化，拒绝提交。\n' >&2
  false
fi

# 所有检查通过后移除回滚 trap，备份继续保留供人工回退。
trap - ERR
printf '修改完成，备份位置：%s\n' "$backup"

这里把“文件是否不同”和“配置是否有效”分开检查。cmp 只能证明字节发生变化，不能证明服务会接受新配置；服务语法检查也不一定证明依赖端口、证书或目录可用。安全发布通常还要在重载后检查服务状态，但那属于服务部署流程，不应塞进一个通用 sed 脚本里。

图2：独立备份、sed 修改、配置检查、cmp 判断与 ERR 回滚之间的静态模块关系。

运行检查：内容、语法和属性分三层验收

# 查看现行文件和备份的权限、所有者、组与时间，确认属性符合预期。
stat --format='%A %U:%G %y %n' -- "$config" "$backup"

# 显示最终差异；没有输出表示内容相同，有输出则应与计划修改一致。
diff -u -- "$backup" "$config" || true

若系统启用了 SELinux、ACL 或文件 capabilities，只比较传统权限位并不充分。GNU cp --preserve=all 会尝试保留这些属性，但跨文件系统或权限不足时仍可能失败，脚本必须检查退出状态。

扩展实验：符号链接与批量文件要单独设计

符号链接

GNU sed 默认对符号链接执行原地编辑时会断开链接，替换为新的普通文件；使用 --follow-symlinks 才会修改链接最终指向的文件。这两种行为影响备份对象和回滚位置，所以脚本不应悄悄猜测。上面的自动方案直接拒绝符号链接，要求操作者先解析并确认真实目标。

# 只读取并显示最终目标，确认后再把 resolved 交给安全修改脚本。
resolved=$(readlink -f -- "$config")
printf '实际目标：%s\n' "$resolved"

# 若明确要修改链接目标，GNU sed 才使用 --follow-symlinks。
sed --follow-symlinks --in-place='.bak' 's/^port=.*/port=8080/' -- "$config"

批量文件

批量替换不能只生成同名固定备份后就立即删除。每个文件应有自己的备份和检查结果，任一文件失败时，要么全部恢复，要么明确记录部分成功状态。不要把通配符直接拼到未经检查的路径上；可以先用 find -print0 生成 NUL 分隔的文件列表，再逐个调用经过测试的安全函数。

不要组合 sed -n 与 -i 做试探

GNU sed 手册特别提醒，-n 会关闭自动输出，而 -i 会把输出写回文件。如果脚本没有显式 p 命令，文件可能被写成空文件。预览时不使用 -i，写入时不随意加入 -n，能直接避开这类事故。

清理与总结

备份不要在 sed 命令成功后立刻删除。更合理的清理点是：配置语法检查通过、服务重载成功、健康检查稳定，并且回滚窗口已经结束。清理时按明确目录、文件前缀和保留数量筛选，避免使用过宽的通配符。

安全使用 sed 原地修改配置，可以记住四句话：先预览差异；备份名必须可定位且不被下一次覆盖；检查失败自动恢复；符号链接和文件属性必须显式处理。sed -i 只是写入工具，真正的可回滚能力来自备份策略、校验命令和清晰的失败边界。

相关问题

sed -i.bak 和 sed -i .bak 有什么区别？

不同 sed 实现的参数规则不同。GNU/Linux 脚本建议使用含义明确的 --in-place='.bak'，并在运行前确认是 GNU sed；不要依赖容易产生歧义的短选项空格写法。

只有 .bak 文件就能保证完整回滚吗？

不能。它主要保留修改前内容；是否完整保留所有者、ACL、安全上下文以及符号链接语义，还取决于具体工具、文件系统和权限。关键配置应另用 cp --preserve=all 备份并检查执行结果。

为什么替换成功后还要运行服务配置检查？

sed 只处理文本，不理解 Nginx、SSH、数据库或业务程序的配置语义。文本替换成功不代表服务能够解析或安全加载新配置。

参考资料

• GNU sed 官方手册
• GNU Coreutils：cp invocation
• GNU Diffutils：Invoking cmp