跳到正文

我所理解的 JavaScript 最佳实践(24):正确使用纯函数和副作用

我所理解的 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. 让独立条件各自表达

给筛选器生成一份按分值排列的选项时,调用方要的是排序结果。给同一个列表更新顺序,让已经持有它的代码也看到变化时,调用方要的是原地修改。两种需求都能用 sort(),但 const sorted = scores.sort(compare) 会同时做这两件事。只看赋值,很容易漏掉 scores 也变了。

我设计业务函数时会把这两种职责分开。需要返回值时,用纯函数计算结果。只需要改变状态时,让函数只执行副作用,调用处直接表达这个动作。这条约定也适用于临时数组。调用处要排序结果,就用 toSorted(),即使排序前刚创建了数组。

让调用处说清是计算还是修改

纯函数的结果由输入决定,相同的输入得到相同的结果,调用也不会修改外部可观察的状态。改动传入的对象、写入缓存或更新界面都是副作用。读取当前时间也会破坏计算的可重复性。写到期判断时,可以在调用处取 Date.now(),把时间戳作为参数传给判断函数。测试只需给定到期时间和当前时间。

接口设计里有一个相近的原则叫「命令查询分离」。查询返回值并保留可观察状态,命令负责改变状态。这个术语源自 Bertrand Meyer,Martin Fowler 也用栈的 pop() 说明了有明确契约的例外,见他的 Command Query Separation。

用 toSorted 取得结果,用 sort 改动原数组

sort() 返回的就是它刚重排过的数组。如果两个组件持有同一个数组,任一处调用 sort(),两处都能读到新顺序。需要这种共享变化时,把原地操作单独写出来。

const scores = [30, 10, 20];
const sharedScores = scores;

scores.sort((first, second) => first - second);

console.log(sharedScores); // [10, 20, 30]

需要从分值里去重并得到一份排序后的选项时,可以先用 Set 去重,再展开成数组并调用 toSorted()。展开负责把可迭代对象转换成数组。方法应该调用在展开结果上,直接写 new Set(scores).toSorted() 会抛出 TypeError。

const scores = [30, 10, 30, 20];
const options = [...new Set(scores)].toSorted((first, second) => first - second);

console.log(options); // [10, 20, 30]
console.log(scores); // [30, 10, 30, 20]

同样从 B、A 开始,sort 修改并返回原数组,toSorted 保留原数组并返回排序后的新数组

toSorted() 仍会调用比较器。比较器里写日志或修改元素,整段计算就会带上这些副作用。数组方法本身只负责把新顺序放到新数组里,这组方法的设计见 TC39 Change Array by copy 提案。

相同的分工也能用在反转和编辑上。筛选器要显示从高到低的选项,可以对已排好序的 options 调用 toReversed(),原来的升序列表仍可用于别处。需要派生一份去掉第一项的列表时,用 options.toSpliced(0, 1)。直接调用 splice() 则会修改 options,并返回删除的那一项组成的数组。改写时也要核对空槽,复制式方法会把保留下来的空槽写成实际的 undefined。更完整的用法见 《使用改进的原生 API》。

把选项的计算和应用分开测试

分值选项算错时,可以拿一份固定输入重跑计算。界面没有显示正确选项时,再检查负责应用结果的调用是否执行,以及写入的是哪一个筛选器。这里用一个普通对象表示筛选器状态,两个检查都可以用 Node.js 的断言执行。

import assert from 'node:assert/strict';

function getScoreOptions(scores) {
  return [...new Set(scores)].toSorted((first, second) => first - second);
}

function setScoreOptions(filter, options) {
  filter.scoreOptions = options;
}

const scores = [30, 10, 30, 20];
const filter = { scoreOptions: [] };
const options = getScoreOptions(scores);

assert.deepEqual(options, [10, 20, 30]);
assert.deepEqual(getScoreOptions(scores), options);
assert.deepEqual(scores, [30, 10, 30, 20]);
assert.deepEqual(filter.scoreOptions, []);

setScoreOptions(filter, options);

assert.deepEqual(filter.scoreOptions, [10, 20, 30]);

预览时只调用 getScoreOptions(),确认后再调用 setScoreOptions()。测试计算时,输入、预期输出和输入保持原样都可以直接断言。测试写入时,把断言放在实际改变的状态上。Redux DevTools 能用同样的初始状态和动作重新计算历史状态,也依赖 reducer 可重复执行的契约,具体行为见 Redux 的时间旅行调试。

React 把同样的要求用在渲染上。相同的输入应得到相同的渲染结果,更新状态等动作通常由事件处理函数触发。组件仍然可以往本次渲染中新建的数组里添加元素,因为这个构造过程对外不可见,见 React 的 Keeping Components Pure。

写入的完成状态也需要表达

await saveSettings(settings) 等待写入成功或失败。即使返回类型是 Promise<void>,调用者也能在成功后显示提示,或者处理拒绝。创建记录时,服务器生成的 ID 可能就是后续跳转的输入,可以把请求数据的计算留在纯函数里,再由发请求的函数返回这个 ID。

Review 筛选器时,我会顺着调用看,连续打开两次预览,会不会提前写入选项?把写入留在确认分支后,排查问题时可以分别在生成选项和应用选项的位置打断点,定位是哪一步出了错。