跳到正文

我所理解的 JavaScript 最佳实践(2):尽量去掉只用一次的中间变量

我所理解的 JavaScript 最佳实践

  1. 使用现代化工具
  2. 尽量去掉只用一次的中间变量(当前)
  3. 遍历的起点决定按 ID 取数的顺序
  4. 不用 reduce
  5. 按遍历任务选择循环和数组方法
  6. 异步遍历按任务依赖选择并发或串行
  7. 卫语句让主流程保持平直
  8. 用函数给可复用的业务规则命名
  9. 让顺序无关的代码按名称排列
  10. 正确写注释
  11. 一行代码只做一件事
  12. 给函数起合适的名字
  13. 用空值合并运算符更好地控制默认值生效逻辑
  14. 用队列串行处理偏好更新,避免修改互相覆盖
  15. 确认弹窗关闭时,让等待中的 Promise 得到结果
  16. 用独立的预期值捕获实现错误
  17. 控制文件行数
  18. 控制函数圈复杂度和认知复杂度
  19. 使用工具函数进行类型判断
  20. 会演进的函数用对象参数
  21. 使用改进的原生 API
  22. 使用模板字符串优化多行文字展示
  23. 用查表取值,用 switch 分派动作
  24. 正确使用纯函数和副作用
  25. 避免数组空位
  26. 把条件写在可选元素和字段旁边
  27. 让独立条件各自表达

中间变量会拉长阅读路径

读到 new Map(entries),我得先找到 entries 的定义,才能知道这张表按什么查。定义就在上一行时只需要扫一眼。它和使用处隔着几段逻辑时,读者还要记住它的来源,顺便检查中途有没有修改过它。只用一次、也说不出独立含义的中间变量,我通常会先试着去掉。

const entries = records.map(record => [record.id, record]);
const byId = new Map(entries);

byId 仍值得命名,因为后续会通过它按 ID 取记录。entries 在这个例子里只是 Map 构造器所需的键值对格式。

把简单表达式移到使用处

从使用处往回看。如果把原表达式放进去仍然一眼能懂,执行条件和时机也相同,就可以直接写在这里。这就是 Martin Fowler 所说的 Inline Variable。

const byId = new Map(records.map(record => [record.id, record]));

资料库页面用 Nuxt 的 useFetch 读取列表,还需要错误状态和刷新函数。原来的调用分三行写。

const source = useFetch('/api/library');
const { data: items, error, refresh } = source;
await source;

Nuxt 的 AsyncData 既直接提供响应式引用和方法,也可以等待。示例的三行之间没有别的操作,也没有读取引用的当前值,因此可以在等待后一次解构。

const { data: items, error, refresh } = await useFetch('/api/library');

移表达式之前要确认 API 的返回契约。普通 Promise 上的 promise.data 和完成值上的 (await promise).data 是两次不同的属性访问。把带函数调用的表达式移进条件分支,还可能改变它会不会执行。

变量名解释业务含义或承载独立职责

一段计算对应稳定的业务概念时,可以用 Extract Variable 给结果起名。比对公开资料时,identityChanged 就概括了昵称和头像的两项比较。比较本身已经清楚时,注释可以只解释审核为什么略过简介。

两个消费者需要共享同一次查询时,保留查询结果。分别内联到两个调用点会多发一次请求,也可能读到不同的数据。

const permissions = await loadPermissions(userId);
renderActions(permissions);
recordPermissionSnapshot(permissions);

开始操作和等待操作之间有其他工作时,中间变量也标出了时序。下面假设 useArchive() 启动资料读取,并像前面的 AsyncData 一样支持立即访问 data。useRoute() 在读取启动后同步调用,最后才等待资料。

const source = useArchive();
const route = useRoute();
const { data: archive } = source;
await source;

第一行直接 await useArchive() 会把 useRoute() 推迟到等待结束之后。解构默认值也可能改变时机,例如 data = createFallback() 只在取到 undefined 时执行。还有一类值需要在不同生命周期使用,例如创建定时器得到的句柄要留给卸载时的 clearInterval。

组合函数的调用处用名字交代依赖

阅读区的 script setup 同时调度批注写回、浮层、链接预览和滚动恢复。读到批注写回入口时,我先想知道它用哪份快照、失败时通知谁、写完以后会做什么。每个回调都在选项对象里写定义,读到下一个字段之前就得先穿过上一段实现。

const { commitReview, saving } = useReviewSubmission({
  afterSave,
  clearError,
  markedView,
  onFailure,
  onSaved,
  onSavingChange,
  snapshot,
});

// 批注写回成功后关闭浮层并清理草稿。
function afterSave() {
  closePopup(false);
}

afterSave 只作为参数传了一次,却能告诉我浮层清理发生在写回成功之后。排查写入竞争时,读完选项名就可以继续看 useReviewSubmission。遇到保存后浮层没关的问题,再跳到 afterSave。给派生值起名也有同样的作用,例如 preferredSidebarWidth 让侧栏宽度的调用处直接交代它的初始偏好来自哪里。

抽出回调时保留读取时机。例如原函数在用户点击时才读取 snapshot.value.path,提成 getDocumentPath 后仍应在被调用时读取。把路径提成初始化时就计算的字符串,切换文档后可能还会读到旧值。React Hook 的同类例子和字段命名见《会演进的函数用对象参数》。

实际重构时,我会先把简单表达式放回消费处,核对求值次数和时机。如果一挪过去就看不清组合函数在接收哪些依赖,原来的名字还有用,可以留着它来解释值或动作在流程里的职责。