Ash项目中的默认排序机制优化方案

背景介绍

在Ash框架中，当资源(Resource)配置了全局准备(preparation)排序，同时又通过其他扩展(如JSON API)应用了不同的排序条件时，会出现排序条件拼接的问题。这会导致数据库查询出现不符合预期的结果，甚至在某些数据库(如SQLite)中引发500错误。

问题分析

当前Ash框架在处理排序时存在以下问题：

1. 当全局准备(preparation)中定义了排序条件，而API请求中也指定了排序参数时，两者会被简单地拼接在一起
2. 在PostgreSQL中，这可能导致返回与请求相反的排序结果
3. 在SQLite中，可能导致重复列错误并返回500状态码

解决方案

核心思路

引入default_sort概念，提供一种机制来定义默认排序规则，同时允许这些规则在必要时被覆盖。这可以通过以下几种方式实现：

1. 在准备(preparation)层级添加default_sort选项
2. 在JSON API路由配置中添加default_sort选项
3. 实现智能合并策略，确保当显式指定排序时，默认排序可以被忽略或合理合并

技术实现方案

1. 新增Ash.Query.default_sort/2函数：

   • 该函数仅在当前查询没有非空排序条件时应用指定的排序
   • 否则保持现有排序不变

2. 扩展Ash.Query.build/2支持：

   • 允许在准备阶段使用build(default_sort: [...])语法
   • 使默认排序配置更加简洁直观

3. 关系(Relationship)默认排序支持：

   • 在关系DSL中添加default_sort选项
   • 在构建关系查询时自动应用默认排序
   • 实现逻辑：Ash.Query.sort(relationship.sort) |> Ash.Query.default_sort(relationship.default_sort)

临时解决方案

对于急需解决此问题的开发者，可以通过自定义准备(preparation)实现类似功能：

defmodule MyApp.Preparations.SortDescByOverridableAttribute do
  use Ash.Resource.Preparation

  @impl true
  def init(opts) do
    if is_atom(opts[:attribute]), do: {:ok, opts}, else: {:error, "attribute must be an atom!"}
  end

  @impl true
  def prepare(query, %{attribute: attribute}, _context) do
    if Keyword.has_key?(query.sort, attribute), do: query, else: Ash.Query.sort(query, [{attribute, :desc}])
  end
end

然后在资源中配置：

preparations do
  prepare {SortDescByOverridableAttribute, attribute: :inserted_at}
end

技术价值

1. 更合理的默认行为：默认排序只在没有显式排序时生效，符合开发者直觉
2. 更好的兼容性：避免了不同来源排序条件冲突导致的数据库问题
3. 更灵活的配置：支持在多个层级定义默认排序，满足不同场景需求
4. 更清晰的代码：通过专用函数和DSL选项，使排序逻辑更加明确

最佳实践建议

1. 对于需要强保证排序顺序的资源，优先使用default_sort而非普通sort
2. 在API设计中，考虑通过文档明确说明哪些字段支持排序覆盖
3. 对于复杂排序需求，可以组合使用默认排序和自定义准备(preparation)
4. 在测试中应包含默认排序被覆盖的场景，确保行为符合预期

总结

Ash框架的排序机制优化方案通过引入default_sort概念，解决了多来源排序条件冲突的问题，同时提供了更灵活、更符合直觉的排序配置方式。这一改进不仅提升了框架的稳定性，也为开发者提供了更强大的数据查询控制能力。