跳到正文

我所理解的 JavaScript 最佳实践(23):用查表取值,用 switch 分派动作

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

同一个状态只决定显示什么文案时,把文案列成一张表。同一个命令决定打开面板、移动焦点还是发起请求时,用 switch 把每项动作放在对应的 case 里。需要依次检查权限、参数和当前状态时,按业务优先级写 if 或卫语句。选写法时,我先看每条分支交付的是一个值,还是一段需要执行的流程。

让命令名直接指向动作

Marker 的阅读区会收到工作台转来的命令。以前的 runCommand() 反复比较 command === 'outline'、command === 'find' 等字符串。想找「查找正文」会执行什么,要先从各条条件里辨认命令名。其中还有一项额外条件:只有当前视图支持批注时,document-annotations 才切到批注面板。

改成 switch 后,命令名都出现在 case 标签上。批注面板的守卫留在对应分支,查找和链接预览各自保留原有的调用方式。

// 执行能够由当前阅读区处理的工作台命令。
function runCommand(command: string) {
  switch (command) {
    case 'outline':
      togglePanel(ReadingPanel.Outline);
      break;
    case 'document-annotations':
      if (markedView.value) {
        togglePanel(ReadingPanel.Annotations);
      }
      break;
    case 'find':
      void toggleSearch(true);
      break;
    case 'preview-link':
      previewFocusedLink();
      break;
  }
}

switch (command) 读取一次判别值,再按严格相等匹配 case。共用一个动作的命令可以连续写空标签,让它们进入同一段代码。有动作的分支用 break 结束当前 switch,或用 return 结束整个函数。需要在多个分支里声明同名的 const 或 let 时,把各分支的语句放进自己的大括号。ECMAScript 的 switch 语义,ESLint 的 no-case-declarations

未匹配输入的行为由调用关系决定。阅读区收到自己处理不了的命令就跳过,因此可以省略 default。工作台的分派还要把剩余命令转交给阅读区,因此需要保留 default。如果原先的 else 会记录错误或返回默认结果,改写后也要在对应路径执行。

固定结果可以直接查表

如果只是给命令面板显示标题,输入和输出之间只有对应关系。把它写成对象,增加一项命令时只需要增加一项数据。类型封闭时,可用 Record<Command, string> 让 TypeScript 检查遗漏。

// 命令面板中可显示的阅读操作标题。
const commandLabels = {
  find: '查找正文',
  outline: '打开大纲',
  'preview-link': '预览链接',
};

// 为工作台传来的命令提供显示标题。
function getCommandLabel(command) {
  return Object.hasOwn(commandLabels, command) ? commandLabels[command] : '未知命令';
}

这里的命令来自开放的字符串输入。直接读普通对象的 commandLabels[command] ?? fallback 时,toString 之类的输入可能读到原型上的属性。用 Object.hasOwn() 先判断自有属性,或用 Map#get() 查找,才能让这类值进入预期的兜底。

还要区分查值和计算值。把 openOutline()、startSearch() 写成对象的属性值,构造对象时就会把两个调用都执行。处理器由多个模块按同一接口登记时,可以存函数引用,查到哪项就调用哪项。动作和额外条件都在一个函数内维护时,switch 能让读者就地看到每条路径什么时候执行。

改写时核对守卫失败后的去向

例如 if (command === 'edit' && canEdit) ... else ... 里的 else 会同时处理未知命令和无权编辑。移成 case 'edit' 后,命令已匹配,canEdit 为假也不会跳到 default。如果原来的兜底有动作,就要在该 case 内保留这条路径。

对阈值和有顺序的检查,if 更容易逐条验证。例如上传时先拦截超限文件,再检查扩展名,这两项不是同一个值的离散取值,执行顺序还会改变用户先看到的错误。若原条件多次读取 getter 或调用函数,也要核对改成只求值一次后是否还能得到同样的结果。

Lint 提示后先判断分支职责

共享 ESLint 预设用 unicorn/prefer-switch 查找连续比较同一个值的 if / else if,默认门槛是三个可匹配分支。单个条件中的 || 可以匹配共用动作的多个标签。&& 复合条件会截断识别,后面符合条件的一段仍可能单独被提示。Marker 的批注命令就是这种情况,人工改写时把守卫一起迁进了 switch。

@sheng/ts-prefer-keyed-object-map 检查同一个离散值的三元链或直接返回链,提示按键查值。两条规则在部分 if / else if 返回链上都会报出提示。看到固定文案、样式或配置时,可以直接改成映射。看到带有状态更新、权限或请求的命令时,先把每项动作和守卫放到对应分支,再用已知命令、未知命令和守卫失败的输入对照改写结果。