跳到正文

我所理解的 JavaScript 最佳实践(7):卫语句让主流程保持平直

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

审核员点击通过,服务端先检查申请有没有被冻结,再检查材料是否齐全。被冻结的申请要记录拦截日志。两项检查都通过后,才保存审核状态并发送通知。

检查不通过就提前返回

按「满足条件再向里走」来写,通过路径会嵌在两层检查里。

async function approve(application) {
  if (application.frozen) {
    await recordAudit(application.id, 'blocked-by-freeze');
    return '申请已冻结';
  } else {
    if (application.missingDocuments) {
      return '请先补齐材料';
    } else {
      await saveStatus(application.id, 'approved');
      await notifyApplicant(application.id);
      return '已通过';
    }
  }
}

冻结和缺材料都可以在当前分支结束函数,后续代码只在检查通过时执行。把两项检查分别写成 卫语句,保存和通知就回到函数的第一层。

async function approve(application) {
  if (application.frozen) {
    await recordAudit(application.id, 'blocked-by-freeze');
    return '申请已冻结';
  }

  if (application.missingDocuments) {
    return '请先补齐材料';
  }

  await saveStatus(application.id, 'approved');
  await notifyApplicant(application.id);
  return '已通过';
}

卫语句的顺序就是检查的优先级

申请同时被冻结和缺材料时,冻结分支先返回,留下拦截日志。把两项检查交换位置,同一条申请会先得到补材料提示,冻结日志也会被跳过。保存失败时,await saveStatus(...) 抛出异常,通知仍然不会发出。重构前后可以用这两个输入核对检查顺序和副作用。

卫语句适合在当前函数里就能做完处理的提前退出。如果后续还有每条路径都要执行的操作,例如释放已经取得的资源,就要保留共同的清理路径。可以在取得资源前做检查,或者在取得后用 try…finally 确保提前返回也经过清理。

审核页显示文案是另一类操作。给定一个状态值就能取到对应文案,映射关系可以集中声明,参见《使用常量枚举来管理状态》。