跳到正文

我所理解的 JavaScript 最佳实践(11):一行代码只做一件事

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

多行关注流程,单行关注细节。读流程时,我想看清条件成立后做什么、在哪里提前返回。读到一条只算出一个结果的表达式,或一串共同完成一个动作的调用,可以先知道它的用途,等需要时再读里面的细节。

Marker 的滚动区可以用已有标题作为无障碍名称。有标题 ID 时写入 aria-labelledby,标题清空时移除旧属性。原组件把每条分支的条件和 DOM 操作放在同一行。

if (title) element.setAttribute('aria-labelledby', title);
else element.removeAttribute('aria-labelledby');

我会给两个分支都加上大括号,让 if 那一行只显示条件,把写入或移除属性的操作放进各自的块里。这样扫一眼 title 就知道会走哪条路。

if (title) {
  element.setAttribute('aria-labelledby', title);
} else {
  element.removeAttribute('aria-labelledby');
}

缩进看起来属于分支,执行时可能已经出了分支

假设滚动节点为空时,原来只需要提前返回。后来还要在返回前断开观察器,往原来的卫语句里加一行,很容易写成下面这样。

function measureViewport(viewport, observer) {
  if (!viewport)
    observer.disconnect()
    return

  return viewport.getBoundingClientRect()
}

if 只管紧接着的 observer.disconnect()。即使 viewport 存在,下一行的 return 也会结束函数,最后的测量永远执行不到。大括号提前圈出了卫语句的边界,新增清理动作时,原来的 return 仍留在分支里。

function measureViewport(viewport, observer) {
  if (!viewport) {
    observer.disconnect();
    return;
  }

  return viewport.getBoundingClientRect();
}

Douglas Crockford 在 2005 年的 The Elements of JavaScript Style 里,用 Yahoo 的 Cookie 读取代码做过一个类似的演示。把后面的索引调整也缩进到单句 if 下面,缩进看似把它划入分支,JavaScript 仍会照常执行它。他给出的建议是「Always use blocks in structured statements.」

Google 的 JavaScript 风格指南也把非空块的第一条语句放到 { 后的新行,并保留 } else { 的连写。它允许足够短、没有 else 的简单 if 省略块。我在项目里连这种卫语句也加括号。维护代码时,一行 return 很容易变成「记录原因再返回」或「清理资源再返回」。

一行可以选一个值

滚动区还要处理 aria-label 和 role。先算出标题 ID 和文字标签,再用同一个工具同步各个属性。下面的 setOrRemoveAttribute 来自 sheng-tool,接收字符串时写入属性,接收 null 时移除。

import { setOrRemoveAttribute } from 'sheng-tool';

function syncViewportName(viewport, label, titleId) {
  const ariaLabelledBy = titleId.trim() || null;
  const ariaLabel = ariaLabelledBy ? null : label.trim() || null;

  setOrRemoveAttribute(viewport, 'aria-labelledby', ariaLabelledBy);
  setOrRemoveAttribute(viewport, 'aria-label', ariaLabel);
  setOrRemoveAttribute(viewport, 'role', ariaLabelledBy || ariaLabel ? 'region' : null);
}

ariaLabelledBy ? null : label.trim() || null 按标题 ID 优先的规则选出文字标签。标题 ID 和文字标签还会一起决定是否设置 role,所以各自留了变量。role 的值只在写属性时用一次,可以就在参数里选。三次属性更新各占一行,读者可以直接扫到哪些属性会被同步。

表单有改动时才需要检查字段。isFormValid(form) 只读表单并返回布尔值,所以可以用 && 把两项检查合成一个判断,交给提交按钮或后续逻辑使用。

const canSubmit = hasChanges && isFormValid(form);

审核文案也可以写成一个表达式。冻结和缺材料同时成立时,优先显示「已冻结」。只有两个条件都不成立时,才显示「可审核」。

const reviewLabel = frozen ? '已冻结' : missingDocuments ? '缺材料' : '可审核';

两层判断合起来只决定 reviewLabel。顺着主流程读时,看一眼变量名就能继续。排查文案时,再读这一行里的优先级。表达式长了可以换行,整条赋值仍然只负责选出文案。

把条件触发的动作和执行顺序写出来

把 canSubmit && submitForm(form) 单独写成一条语句时,&& 控制的是提交请求要不要发出。用 if 展开这条分支,提交动作和它的触发条件就都能扫到了。

if (canSubmit) {
  submitForm(form);
}

如果校验函数还负责更新页面上的错误提示,我会在提交入口先判断要不要校验,再单独调用它,把布尔结果存下来。这里的 errorMessage 是页面上显示错误的元素,submitForm 是发出请求的函数。

function validateAndShowErrors(form, errorMessage) {
  const nameError = form.name.trim() ? '' : '请输入姓名';
  errorMessage.textContent = nameError;
  return nameError === '';
}

async function handleSubmit(form, hasChanges, errorMessage, submitForm) {
  if (!hasChanges) {
    return;
  }

  const isValid = validateAndShowErrors(form, errorMessage);
  if (!isValid) {
    return;
  }

  await submitForm(form);
}

没有改动时,提交入口直接返回。有改动就校验一次并更新提示,接着用 isValid 判断是否继续。姓名为空时流程停在这里,姓名有效时则会在清空旧提示后发出请求。

只用一次的结果直接传给下一步

刷新列表会读取数据并更新界面。加载结果直接交给 normalizeRows,整理后的记录再交给 renderRows。这几个调用接起来完成一次刷新,数据的去向已经写在参数里。

async function refreshRows(loadRows, normalizeRows, renderRows) {
  renderRows(normalizeRows(await loadRows()));
}

这里省去 rawRows 和 rows,读者沿着调用就能看出记录先加载、再整理、最后渲染。要判断一个名字还有没有必要,可以参考只用一次的中间变量的其他例子。

如果导出也要用这批原始记录,再给 await loadRows() 的结果起个名字,让两个调用共用同一次加载。提取时对照原有的调用次数、等待顺序和错误传递。

用 ESLint 要求大括号,用 Prettier 排版

ESLint 的 curly: ['error', 'all'] 会报告省略大括号的控制语句,并可自动修复。如果已经用了 eslint-config-prettier,把这条规则放在兼容配置后面。Prettier 会排开已有块里的语句,省略的大括号则由 ESLint 补齐。

import prettier from 'eslint-config-prettier/flat';

export default [prettier, { rules: { curly: ['error', 'all'] } }];

接手旧代码时,可以先用 eslint --fix 补上块,再跑一次 Prettier。评审时,先看这段代码负责什么,再看哪些条件、动作和提前返回需要逐行看清。