DRF项目中全局分页失效问题排查求助

问题根源 #

1. 重写list方法绕过DRF分页机制
   ModelViewSet自带的list方法会自动调用全局配置的分页类处理queryset，但你完全自定义了list逻辑，直接遍历所有数据并返回，根本没触发分页流程，这是分页失效的核心原因。

2. 代码存在语法错误
   循环中使用的queryset未定义，应该替换为self.queryset，否则会直接抛出NameError。

3. N+1查询加剧响应缓慢
   循环每个Teacher时都单独查询一次Student，数据量大时会产生大量数据库请求，这是接口响应慢的重要诱因。

修复方案 #

方案一：复用ModelViewSet原生逻辑（推荐） #

通过Serializer关联数据，同时优化查询性能，无需自定义list方法，让DRF自动处理分页。

1. 修改Serializer，添加关联字段：

class TeacherSerializer(serializers.ModelSerializer):
    student_names = serializers.SerializerMethodField()

    def get_student_names(self, obj):
        # 直接通过反向关联获取学生姓名列表
        return obj.student_set.values_list('name', flat=True)

    class Meta:
        model = Teacher
        fields = ['id', 'student_names']  # 按需添加Teacher的其他字段

2. 修改ViewSet，添加预查询优化并移除自定义list方法：

class TeacherViewSet(ModelViewSet):
    # 使用prefetch_related预查询关联的Student，避免N+1查询
    queryset = Teacher.objects.all().prefetch_related('student_set')
    serializer_class = serializers.TeacherSerializer
    authentication_classes = [TokenAuthentication]

这样配置后，全局分页会自动生效，接口会返回分页后的结果，同时查询性能也得到优化。

方案二：自定义list方法时手动处理分页 #

如果确实需要自定义返回格式，需手动调用分页类处理数据：

class TeacherViewSet(ModelViewSet):
    queryset = Teacher.objects.all().prefetch_related('student_set')
    serializer_class = serializers.TeacherSerializer
    authentication_classes = [TokenAuthentication]

    def list(self, request, *args, **kwargs):
        # 调用DRF的分页方法处理queryset
        page = self.paginate_queryset(self.queryset)
        if page is not None:
            response_data = []
            for teacher in page:
                student_names = teacher.student_set.values_list('name', flat=True)
                response_data.append({"name": student_names})
            # 返回带分页信息的响应
            return self.get_paginated_response(response_data)
        
        # 未分页的 fallback 逻辑（仅当全局配置允许不分页时触发）
        response_data = []
        for teacher in self.queryset:
            student_names = teacher.student_set.values_list('name', flat=True)
            response_data.append({"name": student_names})
        return Response(response_data)

手动调用paginate_queryset会遵循全局的分页配置，get_paginated_response会自动添加分页相关的响应头和数据结构。

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