在 javascript 中，当需要对同一数据结构根据不同属性进行排序时，常会遇到编写多个相似排序函数的重复问题。本文将介绍如何通过封装一个通用的 `sortby` 函数来解决此问题，该函数接受一个数组和一个用于提取排序键的函数，从而实现代码复用，提高排序逻辑的灵活性和可维护性。
在构建交互式Web应用，例如待办事项列表（Todo List）时，数据排序是一个常见需求。开发者往往需要根据不同的数据属性（如任务标题、截止日期、优先级等）对列表进行排序。一个常见的初级实践是为每个排序维度编写一个独立的排序函数。例如，一个函数用于按标题排序，另一个用于按日期排序，还有一个用于按优先级排序。尽管这些函数能实现各自的排序目的，但它们的核心逻辑往往高度相似，导致代码重复冗余，降低了代码的可维护性和扩展性。
重复排序函数的问题示例
考虑以下针对 todos 数组的三个排序函数，它们分别按标题、截止日期和优先级进行升序排序：
// 原始的按标题排序函数 function sortTitle(Array) { return array.sort((a, b) => { const titleA = a.title.toUpperCase(); const titleB = b.title.toUpperCase(); return (titleA > titleB) - (titleA < titleB); // 简化比较器 }); } // 原始的按日期排序函数 function sortDate(array) { return array.sort((a, b) => { return (a.duedate > b.duedate) - (a.duedate < b.duedate); // 简化比较器 }); } // 原始的按优先级排序函数 function sortPrio(array) { return array.sort((a, b) => { return (a.prio > b.prio) - (a.prio < b.prio); // 简化比较器 }); }
这些函数虽然功能不同，但其内部的 array.sort() 结构和比较逻辑高度相似。唯一的区别在于访问的属性和对属性值的预处理（例如 toUpperCase()）。这种模式表明存在优化的空间。
立即学习“Java免费学习笔记（深入）”；
通用 sortBy 函数的实现
为了解决上述代码重复问题，我们可以设计一个通用的 sortBy 函数。这个函数将接收两个参数：要排序的数组和用于从数组元素中提取排序键的“键函数”（key function）。这种模式在函数式编程中非常常见，类似于 Schwartzian 变换，其核心思想是在排序前将复杂对象转换为包含排序键的临时结构，排序后再还原。
/** * 通用排序函数，根据指定的键函数对数组进行排序。 * 该函数返回一个新数组，不修改原数组。 * * @param {Array<Object>} array - 需要排序的数组。 * @param {Function} keyFn - 一个函数，接受数组中的一个元素并返回用于排序的键值。 * 例如：item => item.title.toUpperCase() 或 item => item.duedate。 * @returns {Array<Object>} 排序后的新数组。 */ const sortBy = (array, keyFn) => array .map(item => [keyFn(item), item]) // 步骤1: 创建 [键值, 原始元素] 对 .sort((a, b) => { // 步骤2: 根据键值进行排序 const keyA = a[0]; const keyB = b[0]; // 简洁的比较逻辑： // 如果 keyA > keyB，结果为 1 - 0 = 1 // 如果 keyA < keyB，结果为 0 - 1 = -1 // 如果 keyA == keyB，结果为 0 - 0 = 0 return (keyA > keyB) - (keyA < keyB); }) .map(pair => pair[1]); // 步骤3: 还原为原始元素数组
sortBy 函数的工作原理
-
array.map(item => [keyFn(item), item]):
- 这一步遍历原始数组中的每个 item。
- 对于每个 item，它调用 keyFn(item) 来提取出用于实际排序的键值（例如，item.title.toUpperCase() 或 item.duedate）。
- 然后，它创建一个包含 [键值, 原始元素] 的新数组。这样做的好处是，我们避免了在比较器中反复计算键值，并且在排序过程中始终能关联到原始元素，这在处理复杂对象时尤其高效。
-
.sort((a, b) => (a[0] > b[0]) – (a[0] < b[0])):
- 这一步对上一步生成的 [键值, 原始元素] 对数组进行排序。
- 比较器 (a, b) => (a[0] > b[0]) – (a[0] < b[0]) 是一种简洁而高效的数值比较方式，它适用于数字和字符串的字典序比较：
- 如果 a[0] 大于 b[0]，a[0] > b[0] 为 true（转换为 1），a[0] < b[0] 为 false（转换为 0），结果是 1 – 0 = 1。
- 如果 a[0] 小于 b[0]，a[0] > b[0] 为 false（转换为 0），a[0] < b[0] 为 true（转换为 1），结果是 0 – 1 = -1。
- 如果 a[0] 等于 b[0]，两者都为 false，结果是 0 – 0 = 0。
- 这种比较器避免了冗长的 if/else if 结构，使代码更紧凑。
-
.map(pair => pair[1]):
- 在数组排序完成后，我们只需要原始的元素，因此这一步遍历排序后的 [键值, 原始元素] 对，并只返回其中的 原始元素 (pair[1])。
实际应用示例
假设我们有一个 todos 数组，包含多个待办事项对象：
const todos = [ { id: 1, title: 'Learn javaScript', duedate: new Date('2023-12-15'), prio: 2 }, { id: 2, title: 'Build Todo app', duedate: new Date('2023-12-10'), prio: 1 }, { id: 3, title: 'Refactor Sort', duedate: new Date('2023-12-20'), prio: 3 }, { id: 4, title: 'Read Book', duedate: new Date('2023-12-12'), prio: 2 }, ]; console.log('原始 todos:', todos); // 按标题字母顺序排序 (不区分大小写) const sortedByTitle = sortBy(todos, item => item.title.toUpperCase()); console.log('按标题排序:', sortedByTitle); // 按日期排序 (升序) const sortedByDate = sortBy(todos, item => item.duedate); console.log('按日期排序:', sortedByDate); // 按优先级排序 (升序) const sortedByPrio = sortBy(todos, item => item.prio); console.log('按优先级排序:', sortedByPrio); // 将排序结果应用到 UI 的模拟 // 假设 cleanTodo() 和 showTodos() 是更新 UI 的函数 function updateAndShowTodos(sortedArray) { console.log('n--- UI 更新模拟 ---'); console.log('当前排序结果:', sortedArray); // 实际项目中会在这里调用具体的 UI 更新逻辑， // 例如：清除旧列表，然后使用 sortedArray 渲染新列表。 // cleanTodo(); // showTodos(sortedArray); } // 假设有以下事件监听器，现在可以统一调用 sortBy 函数 const titleSortButton = document.getElementById("titleSort"); // 假设存在 const dateSortButton = document.getElementById("dateSort"); // 假设存在 const priosortButton = document.getElementById("prioSort"); // 假设存在 if (titleSortButton) { titleSortButton.addEventListener("click", () => { const newTodos = sortBy(todos, item => item.title.toUpperCase()); updateAndShowTodos(newTodos); }); } if (dateSortButton) { dateSortButton.addEventListener("click", () => { const newTodos = sortBy(todos, item => item.duedate); updateAndShowTodos(newTodos); }); } if (prioSortButton) { prioSortButton.addEventListener("click", () => { const newTodos = sortBy(todos, item => item.prio); updateAndShowTodos(newTodos); }); }
优势与注意事项
优势：
- 代码复用性高： 避免了为每个排序属性编写独立的排序函数，大大减少了代码量，使代码库更加精简。
- 可维护性强： 排序的核心逻辑集中在一个函数中。任何对排序算法的优化或调整都只需在一个地方进行，降低了维护成本。
- 灵活性： 仅通过修改 keyFn 参数即可轻松实现新的排序需求，无需修改核心 sortBy 逻辑，提高了代码的适应性。
- 清晰度： sortBy(array, item => item.Property) 的调用方式直观易懂，明确表达了排序意图，提高了代码的可读性。
注意事项：
- 性能考量： sortBy 函数内部使用了两次 map 和一次 sort 操作。对于非常大的数据集（例如，数万甚至数十万条记录），这会创建两个中间数组，可能带来一定的内存和计算开销。在绝大多数Web应用场景中，这种开销通常可以接受，但在对性能有极致要求的场景下，可能需要评估其影响。
- 原地排序 vs. 返回新数组： sortBy 函数返回一个新数组，而不是修改原始数组。这符合函数式编程的原则，保持了数据的不可变性，有助于避免副作用和提高代码可预测性。如果确实需要原地修改，可以手动将结果赋值回原变量。
- 降序排序： 如果需要降序排序，可以通过几种方式实现：
- 在 keyFn 中对数值型键值取反（例如 item => -item.prio）。
- 在 sort 比较器中调整 (keyA > keyB) – (keyA < keyB) 的顺序，例如 (keyA < keyB) – (keyA > keyB)。
- 更通用的做法是为 sortBy 函数添加一个 descending 参数，并在比较器中根据此参数调整返回值的正负。
总结
通过封装一个通用的 sortBy 函数并结合“键函数”的概念，我们可以有效地管理和优化 javascript 中的排序逻辑