Node.js / 系统课时
写入与追加文件
写入与追加文件
文件写入不只是“把字符串存下来”:覆盖写、追加写和安全替换解决的是三种不同问题。本课用 fs/promises 跑通这三种方式,并明确默认文件标志、同一文件的写入顺序,以及用临时文件加重命名降低配置文件被写坏的风险。
学习目标
- 能正确选择
writeFile、appendFile和flag: 'wx'。 - 能用
await保证同一文件的写入顺序,避免并发覆盖。 - 能实现“临时文件写完后再替换目标文件”的基础安全保存流程。
覆盖、追加和只创建一次
writeFile 默认使用写入标志 'w':文件不存在就创建,存在就先截断再写入。appendFile 默认使用 'a':文件不存在就创建,存在就把内容追加到末尾。需要防止误覆盖时,可以给 writeFile 指定 'wx',目标已存在会以 EEXIST 失败。
| 需求 | 推荐 API 或标志 | 结果 |
|---|---|---|
| 每次保存完整配置 | writeFile,默认 'w' |
旧内容被新内容替换 |
| 逐条增加日志 | appendFile,默认 'a' |
新内容写到文件末尾 |
| 文件只能首次创建 | writeFile + flag: 'wx' |
已存在时拒绝覆盖 |
例如配置文件原来有 30 行,新版本只有 18 行时,应使用覆盖写而不是追加;日志则相反,每条事件都应保留历史内容,通常采用追加或专门的日志系统。
跑通覆盖、追加和安全替换
下面示例按 Node.js 18+ 的 ESM 写法编写,保存为 write-files.mjs 后运行。日志文件先覆盖为一行,再追加一行;配置文件则先写入同目录临时文件,写完后再通过 rename 替换目标。
import { randomUUID } from 'node:crypto';
import { appendFile, readFile, rename, rm, writeFile } from 'node:fs/promises';
const logFile = new URL('./app.log', import.meta.url);
const configFile = new URL('./config.json', import.meta.url);
async function safeSave(target, text) {
// 临时文件放在目标旁边,避免 rename 跨文件系统。
const temp = new URL(`./.${randomUUID()}.tmp`, target);
try {
// wx 避免意外复用已经存在的临时文件。
await writeFile(temp, text, { encoding: 'utf8', flag: 'wx' });
await rename(temp, target);
} catch (error) {
await rm(temp, { force: true }).catch(() => {});
throw error;
}
}
await writeFile(logFile, 'start\n', 'utf8');
await appendFile(logFile, 'ready\n', 'utf8');
console.log('日志:\n' + (await readFile(logFile, 'utf8')).trim());
await safeSave(configFile, '{\n "port": 3000\n}\n');
console.log('配置:\n' + (await readFile(configFile, 'utf8')).trim());预期输出
日志:
start
ready
配置:
{
"port": 3000
}连续运行两次,app.log 仍应只有 start 和 ready 两行,因为第一步会覆盖旧日志再追加;config.json 每次都应是完整 JSON,而不是新旧内容拼在一起。
同一文件的写入必须排好顺序
不要同时对同一个文件发起多个 writeFile 再等它们自己完成。正确做法是前一次 await writeFile(...) 完成后再开始下一次;Node.js 的文件写入便利 API 本身不替你定义并发覆盖顺序。需要高频连续写日志时,用单个写入队列或 createWriteStream 更合适。
追加也要区分“物理追加”和“业务顺序”。两个异步任务同时调用 appendFile 时,最终都可能成功,但记录先后取决于实际完成顺序,不一定等于事件产生顺序。若日志必须严格按序号 1、2、3 落盘,应先在应用层排队,再逐项追加。
对“存在就不能覆盖”的文件,不要先检查是否存在再写。直接使用 flag: 'wx',并捕获 EEXIST,可以把检查与创建交给文件系统一次完成,减少竞争条件。
安全保存解决什么,不能解决什么
直接覆盖重要配置时,如果进程在写到一半时异常退出,目标文件可能只剩部分内容。基础安全保存会先把完整内容写进同目录临时文件,成功后再 rename 到正式文件;读者通常只会看到旧完整版本或新完整版本,而不是半截 JSON。
这个方案仍不是“任何故障都不丢数据”的事务。突然断电、网络文件系统语义、目标文件权限与多进程同时保存,都需要更严格的持久化设计;临时文件替换也可能改变原文件权限。重要配置至少要做到:临时文件与目标在同一目录、每次写入都 await、失败时清理临时文件、替换后重新读取并做一次 JSON.parse 或业务校验。
验收时可连续运行脚本两次,确认 app.log 始终是 2 行、config.json 始终能解析且 port 等于 3000。普通设置保存选覆盖写,事件日志选追加,不能容忍半写目标文件时再升级为临时文件加重命名。