首页
/ ES-Toolkit 排序功能优化:统一 sortBy 和 orderBy 的实现

ES-Toolkit 排序功能优化:统一 sortBy 和 orderBy 的实现

2025-05-28 13:46:19作者:幸俭卉

在 JavaScript 数据操作库 ES-Toolkit 中,排序功能是开发者常用的工具之一。最近,该项目针对排序功能进行了一系列重要的优化和改进,主要涉及 sortByorderBy 两个核心函数的统一实现。

背景与问题分析

ES-Toolkit 原本提供了两个相似的排序函数:sortByorderBy。这两个函数的主要区别在于:

  1. sortBy 支持自定义键函数(key function),但只能进行升序排序
  2. orderBy 支持指定升序或降序,但不支持自定义键函数

这种不一致性导致了几个明显的问题:

  • 功能重复:两个函数核心逻辑相似,却分开实现
  • 功能缺失:orderBy 缺少自定义键函数支持
  • 兼容性问题:与 lodash 的 orderBy 行为不一致

解决方案设计

经过社区讨论,最终确定了以下优化方案:

  1. 增强 orderBy 功能:使其支持自定义键函数,与 sortBy 保持一致
  2. 重构实现方式:将 sortBy 改为基于 orderBy 的轻量级封装
  3. 保持 API 兼容:不改变现有函数的调用方式,只优化内部实现

新的实现方式使得代码更加简洁且易于维护。具体来说,sortBy 现在可以简单地实现为:

export function sortBy<T extends object>(arr: T[], criteria: Array<((item: T) => unknown) | keyof T>): T[] {
  return orderBy(arr, criteria, ['asc']);
}

技术实现细节

在底层实现上,优化后的排序功能需要考虑以下几个关键点:

  1. 类型处理:同时支持属性名和自定义函数作为排序依据
  2. 多条件排序:处理多个排序条件和对应的排序方向
  3. 性能优化:避免不必要的计算和内存分配

新的 orderBy 实现需要能够处理以下各种调用方式:

// 按属性名排序
orderBy(data, 'value', 'desc');

// 按自定义函数排序
orderBy(data, x => x.value.toString(), 'asc');

// 多条件排序
orderBy(data, ['name', 'age'], ['asc', 'desc']);

开发者收益

这次优化为开发者带来了以下好处:

  1. 功能一致性:现在 orderBysortBy 都支持相同的键函数功能
  2. 代码复用:减少了重复代码,降低了维护成本
  3. 更好的兼容性:与 lodash 的行为更加接近,便于迁移
  4. 更灵活的排序:可以同时使用自定义键函数和指定排序方向

最佳实践建议

基于新的实现,我们推荐以下使用方式:

  1. 当只需要简单升序排序时,使用 sortBy 更为简洁
  2. 当需要降序排序或复杂排序条件时,使用 orderBy
  3. 对于需要特殊处理的排序键,使用自定义函数:
// 将数值转换为字符串后再排序
orderBy(data, x => x.value.toString(), 'desc');

总结

ES-Toolkit 通过统一 sortByorderBy 的实现,不仅解决了功能不一致的问题,还提高了代码的可维护性和开发者体验。这种优化体现了优秀开源项目持续改进的精神,也为开发者提供了更强大、更一致的排序工具。

登录后查看全文
热门项目推荐
相关项目推荐