如何在Django中为extra添加的自定义查询字段应用nulls_last排序

实现思路 #

1. 自动识别排序方向：根据传入字段名是否以-开头判断是否为降序
2. 自动区分字段类型：从模型元数据中匹配原生字段，未匹配到的则从查询集内置的extra_select属性中提取extra字段对应的SQL语句，无需用户重复传入
3. 统一构造带nulls_last=True的排序表达式，兼容两类字段

完整实现代码 #

from django.db import models
from django.db.models.expressions import RawSQL, OrderBy

def apply_order_by_nulls_last(queryset, field: str):
    # 解析排序方向
    is_descending = field.startswith('-')
    field_name = field.lstrip('-')

    # 匹配原生模型字段
    all_model_fields = [f.name for f in queryset.model._meta.fields]
    if field_name in all_model_fields:
        sort_expr = models.F(field_name)
    else:
        # 从查询集内置属性获取extra字段的SQL逻辑
        if field_name not in queryset.query.extra_select:
            raise ValueError(f"字段 {field_name} 不存在，既不是模型原生字段，也未通过extra方法添加到当前查询集")
        extra_sql = queryset.query.extra_select[field_name]
        sort_expr = RawSQL(extra_sql, [])

    # 构造带nulls_last的排序规则
    order_by_expr = OrderBy(
        sort_expr,
        descending=is_descending,
        nulls_last=True
    )
    return queryset.order_by(order_by_expr)

使用示例 #

原生字段排序 #

# 按创建时间降序排列，空值排在最后
queryset = apply_order_by_nulls_last(MyModel.objects.all(), '-create_time')

extra自定义字段排序 #

# 先构造带extra字段的查询集，无需额外存储自定义SQL
queryset = MyModel.objects.extra(select={'custom_score': 'count(related_table.id)'})
# 直接传入extra字段名即可实现带nulls_last的排序
queryset = apply_order_by_nulls_last(queryset, 'custom_score')

注意事项 #

• 兼容Django 2.2及以上版本（OrderBy的nulls_last参数从2.2版本正式引入）
• 若需要同时支持多字段排序，可对函数稍加修改，接收字段列表后循环生成排序表达式即可
• 如果需要切换为nulls_first，只需修改OrderBy的nulls_last参数为False，或者新增参数对外暴露配置

内容的提问来源于stack exchange，提问作者serg