我所理解的 JavaScript 最佳实践(14):用队列串行处理偏好更新,避免修改互相覆盖
- 使用现代化工具
- 尽量去掉只用一次的中间变量
- 遍历的起点决定按 ID 取数的顺序
- 不用 reduce
- 按遍历任务选择循环和数组方法
- 异步遍历按任务依赖选择并发或串行
- 卫语句让主流程保持平直
- 用函数给可复用的业务规则命名
- 让顺序无关的代码按名称排列
- 正确写注释
- 一行代码只做一件事
- 给函数起合适的名字
- 用空值合并运算符更好地控制默认值生效逻辑
- 用队列串行处理偏好更新,避免修改互相覆盖(当前)
- 确认弹窗关闭时,让等待中的 Promise 得到结果
- 用独立的预期值捕获实现错误
- 控制文件行数
- 控制函数圈复杂度和认知复杂度
- 使用工具函数进行类型判断
- 会演进的函数用对象参数
- 使用改进的原生 API
- 使用模板字符串优化多行文字展示
- 用查表取值,用 switch 分派动作
- 正确使用纯函数和副作用
- 避免数组空位
- 把条件写在可选元素和字段旁边
- 让独立条件各自表达
在 Markdown 审阅工具 Marker 里,保存阅读位置和给文件加书签都要更新同一份工作区偏好。假设这两个动作几乎同时发生。如果它们都先读旧配置,再各自写回整份 JSON,第二次保存就可能把第一次的修改盖掉。
先让每次修改读到最新状态
假设初始状态的阅读位置是 0,书签列表是空的。A 要把阅读位置改到 420,B 要添加 notes.md。两次操作都从同一份初始状态开始,写回的内容就会是下面这样。
| 操作 | 读取的状态 | 写回的状态 |
|---|---|---|
| A 保存阅读位置 | 位置 0,没有书签 |
位置 420,没有书签 |
| B 添加书签 | 位置 0,没有书签 |
位置 0,书签含 notes.md |
即使文件保证只在 A 写完后才由 B 写入,最后的位置仍会回到 0。因为 B 的新配置已经在队列外算好了。要把读当前值、生成下一份状态、写文件放进同一个队列。
Marker 为工作区偏好维护一条 Promise 链。不同工作区都存进同一份 JSON,所以这条链按文件共享。下面保留实现里决定先后顺序的部分。getPreferences 取当前已提交状态,replacePreferencesFile 负责替换文件。
let stateWrites = Promise.resolve();
function changePreferences(root, update) {
const operation = stateWrites
.catch(() => undefined)
.then(async () => {
const previous = await getPreferences(root);
const next = structuredClone(previous);
update(next);
const nextState = new Map(preferences).set(root, next);
await replacePreferencesFile(preferencesFile, nextState);
preferences.set(root, next);
return next;
});
stateWrites = operation;
return operation;
}
A 替换文件成功后才更新内存。轮到 B 时,getPreferences 读到的位置已经是 420,添加书签时会把它一起保留。
如果 A 保存失败,返回给 A 调用方的 operation 会拒绝。B 接上队列时通过 catch 越过这次失败,再从最近一次成功保存的状态继续。把 catch 放在下一项的入口,可以继续处理队列,同时保留每次保存自己的成功或失败结果。
再让完整的新文件接替旧文件
如果直接写目标 JSON,写到一半发生 I/O 错误时,目标路径可能已经只剩半份内容。Marker 会先在同一个目录写一份独立的临时文件,等它写完再替换目标文件。下面的函数对应上一段的 replacePreferencesFile,省略了调用方与文件路径的构造。
import { randomUUID } from 'node:crypto';
import { mkdir, rename, unlink, writeFile } from 'node:fs/promises';
import { dirname } from 'node:path';
async function replacePreferencesFile(file, nextState) {
const temporary = `${file}.${randomUUID()}.tmp`;
await mkdir(dirname(file), { recursive: true });
try {
await writeFile(temporary, JSON.stringify(Object.fromEntries(nextState)), { encoding: 'utf8', flag: 'wx' });
await rename(temporary, file);
} finally {
await unlink(temporary).catch(() => undefined);
}
}
wx 以排他方式创建临时文件。rename 成功后临时路径已经不存在,失败时则尝试清掉留下的临时文件。文件替换的行为依赖宿主。以支持原子替换的 Linux 同文件系统操作为例,读取方通过目标路径看到的是旧文件或完整的新文件,见 Linux 的 rename(2) 手册。
突然断电后的持久性还需要考虑文件和目录的同步。这里处理的是应用写入途中失败时,怎样保留上一次完整状态。
用两次修改和一次写入失败核对结果
可以先让保存位置的写入停在一个可控的 Promise 上,发出添加书签的操作,再放行第一笔写入。两次都完成后,重新读文件,应同时看到位置 420 和新书签。再让第一笔写入失败,确认它报告失败,第二笔仍能写入,而未保存的位置没有进入内存或下一份文件。
队列的范围是当前进程。两个独立进程如果都能编辑同一文件,就还需要跨进程的协调或版本冲突检测。判断一段代码是否会丢更新,先找出谁可能同时写同一份状态,再沿着读、改、写三个步骤看它们在哪儿会交错。