如何对GraphQL中外键关联的部门集合排序？Django技术栈问题

我之前在使用graphene-django构建关联模型的GraphQL API时，也碰到过和你一模一样的问题——主模型（Faculty）能排序，但关联的子集合（Department）没法排序。结合你的模型结构，我给你整理了具体的解决步骤：

1. 为Department创建FilterSet #

django-filter的FilterSet是实现关联集合排序的核心，我们需要为Department模型定义一个支持排序的FilterSet：

import django_filters
from .models import Department

class DepartmentFilter(django_filters.FilterSet):
    class Meta:
        model = Department
        fields = {
            'code': ['exact', 'icontains'],
            # 这里可以添加其他需要过滤的字段，比如有name字段也可以加上
        }
    
    # 显式定义排序字段，指定前端可用来排序的模型字段
    order_by = django_filters.OrderingFilter(
        fields=(
            ('code', 'code'),
            # 如需按其他字段排序，比如创建时间，可加 ('created_at', 'created_at')
        ),
        # 可选：设置默认排序规则
        # initial='code'
    )

2. 修改FacultyType中的departments字段 #

原来的关联字段默认不支持排序参数，我们需要用DjangoFilterConnectionField替换普通字段，让它结合上面的FilterSet来支持排序和过滤：

首先导入必要的类：

import graphene
from graphene_django import DjangoObjectType
from graphene_django.filter import DjangoFilterConnectionField
from .models import Faculty, Department
from .filters import DepartmentFilter

然后更新类型定义：

class DepartmentType(DjangoObjectType):
    class Meta:
        model = Department
        fields = ("id", "code", "faculty")
        interfaces = (graphene.relay.Node,)

class FacultyType(DjangoObjectType):
    class Meta:
        model = Faculty
        fields = ("id", "code")
        interfaces = (graphene.relay.Node,)

    # 替换原departments字段，通过FilterConnectionField关联排序规则
    departments = DjangoFilterConnectionField(
        DepartmentType,
        filterset_class=DepartmentFilter
    )

3. 在GraphQL查询中使用orderBy参数 #

现在你就可以在查询Faculty时，给关联的departments添加orderBy参数了：

query GetFacultiesWithSortedDepartments {
  faculties(orderBy: ["code"]) { # 主模型Faculty的排序
    id
    code
    departments(orderBy: ["code"]) { # 关联的Department集合排序
      id
      code
    }
  }
}

关键注意点 #

• 如果你不想使用Relay的Connection模式，也可以手动处理排序参数，但DjangoFilterConnectionField是graphene-django官方推荐的方式，支持更完整的过滤和排序功能。
• 确保DepartmentType的Meta配置不会和FilterSet的排序规则冲突，FilterSet的order_by配置优先级高于DepartmentType中的ordering选项。

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