我所理解的 JavaScript 最佳实践(21):使用改进的原生 API
- 使用现代化工具
- 尽量去掉只用一次的中间变量
- 遍历的起点决定按 ID 取数的顺序
- 不用 reduce
- 按遍历任务选择循环和数组方法
- 异步遍历按任务依赖选择并发或串行
- 卫语句让主流程保持平直
- 用函数给可复用的业务规则命名
- 让顺序无关的代码按名称排列
- 正确写注释
- 一行代码只做一件事
- 给函数起合适的名字
- 用空值合并运算符更好地控制默认值生效逻辑
- 用队列串行处理偏好更新,避免修改互相覆盖
- 确认弹窗关闭时,让等待中的 Promise 得到结果
- 用独立的预期值捕获实现错误
- 控制文件行数
- 控制函数圈复杂度和认知复杂度
- 使用工具函数进行类型判断
- 会演进的函数用对象参数
- 使用改进的原生 API(当前)
- 使用模板字符串优化多行文字展示
- 用查表取值,用 switch 分派动作
- 正确使用纯函数和副作用
- 避免数组空位
- 把条件写在可选元素和字段旁边
- 让独立条件各自表达
Marker 的目录树接收父组件传来的 entries,再按名称或修改时间决定显示顺序。直接调用 entries.sort(compareEntries) 会改变父组件传来的数组。以前可以先用 [...entries] 复制,再对副本排序。目标运行环境支持 toSorted() 时,一次调用就能返回排好序的新数组。
排序要先看谁持有原数组。检查用户设置时,则要区分自有字段和继承字段;清理临时 DOM 时,手上是否已经有要移除的节点,也会影响方法选择。
用 toSorted 返回排序后的数组
目录树需要保留输入顺序,同时按数字自然排序,让 第 2 章 排在 第 10 章 前面。下面的比较器和 Marker 一样用 Intl.Collator。比较器决定顺序,数组方法决定排序结果放在哪里。
const entries = [{ name: '第 10 章' }, { name: '第 2 章' }];
const collator = new Intl.Collator('zh-CN', { numeric: true });
const compareEntries = (first, second) => collator.compare(first.name, second.name);
const rows = entries.toSorted(compareEntries);
console.log(rows.map(entry => entry.name)); // ['第 2 章', '第 10 章']
console.log(entries.map(entry => entry.name)); // ['第 10 章', '第 2 章']
[...entries].sort(compareEntries) 会先生成数组,再让 sort() 修改这个副本。ES2015 的数组展开普及前,存量代码常写 entries.slice().sort(compareEntries),无参 slice() 在这里负责浅拷贝。entries.toSorted(compareEntries) 直接表达了同一个需求,数组里的对象仍然是同一批引用。Marker 保留了原来的目录优先级、修改时间和名称比较条件,改的是结果数组的产生方式。
如果输入是 Set 或生成器,[...entries].toSorted(compareEntries) 里的展开负责把可迭代对象转成数组。需要改变某个现有数组的顺序时,可以单独调用 sort()。迁移稀疏数组时还要注意,toSorted() 会把空位当作 undefined 读出来,结果中的这些位置有实际的 undefined 值。原地 sort() 则把空位移到末尾。
用 toReversed 取得逆序列表
一份发布记录按时间顺序放进 Map,展示时可以倒过来读,原记录仍按录入顺序遍历。先把 values() 的迭代结果展开成数组,再对它调用 toReversed()。
const stages = new Map([
[1, '草稿'],
[2, '校对'],
[3, '发布'],
]);
const latestFirst = [...stages.values()].toReversed();
console.log(latestFirst); // ['发布', '校对', '草稿']
console.log([...stages.values()]); // ['草稿', '校对', '发布']
如果调用方已经拿到一个数组,只需要它的逆序结果,直接用 toReversed()。需要让原数组上的其他引用看到逆序时,单独调用 reverse()。两种方法的返回值和空槽行为见规范里的 Array.prototype.reverse 和 Array.prototype.toReversed。
用 toSpliced 取得编辑后的完整列表
从状态里删掉一项并插入新值时,调用方需要的是更新后的列表。splice() 会修改输入,返回被删掉的元素。toSpliced() 返回更新后的整个数组,输入保持原顺序。
const tabs = ['首页', '草稿', '设置'];
const nextTabs = tabs.toSpliced(1, 1, '已发布');
console.log(nextTabs); // ['首页', '已发布', '设置']
console.log(tabs); // ['首页', '草稿', '设置']
如果要让现有标签数组原地更新,单独调用 tabs.splice(1, 1, '已发布')。有些调用还需要把删除项写入撤销记录,这时要保留 splice() 返回删除项的契约。只需要下一份完整列表时,再选 toSpliced()。仅传 start 会删到末尾,单纯插入时把删除数量明确写成 0。参数与返回值见 Array.prototype.toSpliced。
同一组复制式数组方法还提供 with(),用来替换新数组中指定位置的值。items.with(-1, value) 替换最后一项,索引越界会抛出 RangeError。如果原代码允许越界赋值并扩展数组,就需要保留那层行为。几种方法的设计见 TC39 Change Array by copy。
用 Object.hasOwn 检查字段是否由对象自己提供
读取用户设置时,有时要区分「对象没有提供这个字段」和「对象显式提供了 undefined」。Object.hasOwn(settings, 'mode') 检查这个键是否属于对象自己,既能用于无原型对象,也不受同名 hasOwnProperty 字段影响。
const settings = Object.create({ theme: 'light' });
settings.mode = undefined;
console.log(Object.hasOwn(settings, 'mode')); // true
console.log(Object.hasOwn(settings, 'theme')); // false
console.log('theme' in settings); // true
旧写法 Object.prototype.hasOwnProperty.call(settings, 'mode') 和 Object.hasOwn() 表达的是同一个检查。in 会沿原型链查找,判断的范围更大。如果设置可能为 null 或 undefined,先在输入边界校验它,再调用 Object.hasOwn()。
用 remove 移除节点自身
给脚本临时创建的提示元素做清理时,手上已经有节点引用,直接调用 hint.remove() 就可以把它从当前父节点移除。节点已经没有父节点时,再调用一次也不会抛错。
const hint = document.createElement('span');
hint.textContent = '正在读取';
document.body.append(hint);
hint.remove();
parent.removeChild(child) 会返回被移除的节点,还会检查 child 是否属于指定的父节点。旧代码依赖返回值或需要验证父子关系时,保留这层语义。上例的 hint 由脚本创建,再用 remove() 清理。Vue 模板渲染的提示元素则应通过状态控制显隐或卸载。
其他能直接表达意图的原生 API
| 要做的事 | 原生写法 | 换之前核对 |
|---|---|---|
| 读数组最后一项 | items.at(-1) |
空数组返回 undefined。MDN 的 at |
| 从后往前找最后一个匹配项 | items.findLast(matches) 或 items.findLastIndex(matches) |
返回元素或原数组里的索引,省去先反转再查找。MDN 的 findLast |
| 把一组键值对变成对象 | Object.fromEntries(entries) |
同键取最后一个值。需要按对象身份区分键时,使用 Map。MDN 的 fromEntries |
| 按分类得到一组列表 | Object.groupBy(rows, getCategory) 或 Map.groupBy(rows, getCategory) |
前者返回无原型对象,后者可以按对象身份区分键。分组示例 |
| 替换所有匹配的字符串 | text.replaceAll(search, replacement) |
直接传字符串可按字面查找。传正则时必须带 g。MDN 的 replaceAll |
| 在容器末尾追加节点和文字 | container.append(node, text) |
字符串会成为文本节点。appendChild() 只接受一个节点并返回该节点。MDN 的 Element.append |
| 用新内容替换容器的全部子节点 | container.replaceChildren(...nodes) |
容器本身保留,无参数时清空全部子节点。MDN 的 replaceChildren |
先确认运行环境,再把提醒接到 lint
复制式数组方法属于 ES2023,Object.hasOwn() 属于 ES2022,Element.remove() 则由 DOM 提供。TypeScript 的 lib 决定类型检查认识哪些 API。实际可用性由最低支持的浏览器、Node.js 或 Electron 版本决定。一个项目可能同时有主进程、渲染进程和独立脚本,按实际执行位置核对,再对需要兼容的入口保留旧写法或提供 polyfill。
Unicorn 79 和共享预设都提示使用了排序或反转结果的临时数组。区别出现在编辑器建议上。Unicorn 为单一展开提供两条条件建议,选中保留展开的一条可以得到 [...new Set(values)].toSorted()。选中移除展开的一条,会在 Set 上调用不存在的 toSorted()。共享预设统一保留展开,Map 的迭代器、字符串和生成器也按同样方式处理。上游选择两条条件建议的理由见 Unicorn 的展开讨论。
有同名方法时也要保留展开。[...new Uint8Array([10, 2])].toSorted() 得到普通数组 [10, 2]。直接调用 TypedArray 的 toSorted() 会按数值排序,得到 Uint8Array [2, 10]。这里省掉的展开同时改变了结果类型和顺序。
在已有 ESLint flat config 里可以按运行环境和文件范围加入下面的配置。Vue 项目沿用现有的 Vue 和 TypeScript parser 配置。
import sheng from '@sheng/eslint-plugin';
import unicorn from 'eslint-plugin-unicorn';
export default [
sheng.configs['array-copy'],
{
plugins: { unicorn },
rules: {
'unicorn/prefer-dom-node-remove': 'warn',
'prefer-object-has-own': 'warn',
},
},
];
如果 entries 是普通稠密数组,比较器参数的求值也不会修改原数组,可以把 entries.slice().sort(compareEntries) 写成 entries.toSorted(compareEntries),少生成一个副本。共享预设对这类无参复制给出提示,只有能确认内联数组没有空槽时才会提供合并建议。slice(start, end) 和 Array.from(iterable) 分别承担截取或类型转换的职责。
检查旧的自有属性判断和 DOM 移除时,也可以接入 prefer-object-has-own 和 prefer-dom-node-remove。
splice 的重新赋值会留下旧引用
Unicorn 79 的 no-array-splice 检查用新数组初始化的局部 let 或 var。如果调用丢弃删除项,规则又没发现数组被直接赋给别处、传出或返回,它会建议把 rows.splice(1, 1, 9) 改成 rows = rows.toSpliced(1, 1, 9)。这样后续通过 rows 读取时会拿到新内容。具体条件见 Unicorn 79 的 no-array-splice 实现。
直接赋值只是取得引用的一种方式。下面的 reverse() 会反转数组,并把同一个数组返回给 alias。
let rows = [1, 2, 3];
const alias = rows.reverse();
rows.splice(1, 1, 9);
console.log(alias.join(','), rows.join(',')); // '3,9,1' '3,9,1'
Unicorn 79 把 rows.reverse() 视为成员访问,仍会给 splice() 提供重新赋值的建议。应用建议后,rows 指向 [3, 9, 1],而 alias 仍指向先前反转过的 [3, 2, 1]。同一行日志会变成 '3,2,1' '3,9,1'。这个分支见 Unicorn 的引用检查。
即使只有一个引用,稀疏数组也有差异。从 [1, , 3, 4] 删掉 3,原地 splice() 保留中间的空槽,后续 map(() => 1).join(',') 得到 '1,,1'。换成复制式方法后,下标 1 存了实际的 undefined,map() 多执行一次,结果变成 '1,1,1'。
已经在返回副本时,可以合并复制和编辑
共享预设允许上面的原地编辑。它会检查另一种写法,连续三条语句先用无参 slice() 创建副本,单独编辑,再直接返回副本。
function getUpdatedRows() {
const copy = [1, 2, 3].slice();
copy.splice(1, 1, 9);
return copy;
}
共享预设会建议把前两条语句合成 const copy = [1, 2, 3].toSpliced(1, 1, 9),保留 return copy。Unicorn 的重新赋值规则会放过这里的 const。如果源是稀疏数组,参数依赖 copy.length,或插入项依赖副本的显式类型,共享预设也只给文字提示。直接返回 copy.splice(...) 时,函数交付的是删除项,两套规则都放过。
排序和反转也要核对空槽与共享引用
同样从 [3, , 1, 2] 开始,sort() 把空槽移到末尾,reverse() 把它反转到下标 2。接上 map(() => 1).join(','),分别得到 '1,1,1,' 和 '1,1,,1'。换成 toSorted() 或 toReversed() 后,两者都会得到 '1,1,1,1'。如果之前已经做了 [...rows],空槽在展开时就填实了,此时保留展开、只换方法名不会再次改变数组密度。索引行为见 Array.prototype.toSorted 和 Array.prototype.toReversed。
const alias = rows.sort() 会让 alias 和 rows 指向同一数组,后续调用 rows.reverse(),两处都能读到逆序。换成 toReversed() 后,只有读取返回值的代码才会看到逆序,alias 仍读到排序后的旧顺序。共享预设遇到这类已有数组只给文字提示,调用者可以把需要的原地修改单独写成一行。