跳到正文

我所理解的 JavaScript 最佳实践(8):用函数给可复用的业务规则命名

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

资料编辑页用昵称和头像判断身份信息是否变了。把比较抽成函数可以缩短调用点,但读者仍需要知道哪些字段算身份信息。

同一份表单,三种比较写法

资料表单可以修改昵称、头像和简介。保存时三个字段都会提交,但这个页面只在昵称或头像变化时重新审核公开身份。下面只改了简介,因此三种写法都应该得到 false。

const currentProfile = { nickname: '小雨', avatar: '/a.png', bio: '喜欢摄影' };
const formValue = { nickname: '小雨', avatar: '/a.png', bio: '周末拍照' };

直接写在调用处

const identityChanged = currentProfile.nickname !== formValue.nickname || currentProfile.avatar !== formValue.avatar;

调用处就能看到比较了哪两个字段。规则只在这里用、条件也很短时,这一行已经足够。如果别处也要判断是否重新审核,复制这条条件容易让两个入口在日后修改时各用一套字段。

抽成普通 helper

function hasProfileChanged(before, after) {
  return before.nickname !== after.nickname || before.avatar !== after.avatar;
}

const profileChanged = hasProfileChanged(currentProfile, formValue);

调用处变短了,但 hasProfileChanged 听起来像在检查整份资料。看到简介明明变了、函数却返回 false,读者要跳进实现才知道这个函数只检查昵称和头像。

把业务判断写进函数名

function hasProfileIdentityChanged(before, after) {
  return before.nickname !== after.nickname || before.avatar !== after.avatar;
}

const needsIdentityReview = hasProfileIdentityChanged(currentProfile, formValue);

函数体和上一种相同,调用处说的是「公开身份是否变化」。如果保存前的审核提示和保存后的审核触发都用这条规则,两处就可以调用同一个函数。需要调整哪些字段触发审核时,改动有一个明确入口。

同样只改简介,三种写法都返回 false。直接写能看见字段,普通 helper 只说资料变了没有,业务函数名说明判断的是公开身份

只服务一处的短条件留在调用处

表单还有一行头像提示,仅在没选头像、也没有正在上传的文件时显示。它只服务这一处界面,两个条件放在一起就能看出提示什么时候消失。

const showAvatarHint = !formValue.avatar && !isUploadingAvatar;

如果只为缩短这一行,把它挪进一个叫 shouldShowAvatarHint 的函数,调用处虽然还看得出会显示什么,却看不见上传中的状态会怎样影响它。

function shouldShowAvatarHint(profile, isUploading) {
  return !profile.avatar && !isUploading;
}

const showAvatarHint = shouldShowAvatarHint(formValue, isUploadingAvatar);

这个局部变量已经给结果起了名字,条件也紧挨着使用处。读者排查「上传时为什么不显示提示」时,可以直接看到答案。至于是否连这个变量也可以内联,要看变量名还有没有帮助,可以接着看第二篇的中间变量取舍。

总结

几处代码需要遵守同一条业务规则时,可以用一个函数给这条规则命名。条件只服务一个调用点,而且读者需要看清每个条件时,先让它们留在调用处。