如何在Python Django REST Framework中实现自定义的分页返回格式?

梦瑶小哥_2433

梦瑶小哥_2433

2026-07-07

555人浏览

原创

默认 pagenumberpagination 返回结构不满足需求是因为其响应数据嵌套在 results 键下且含 next/previous 链接,而前端或 openapi 规范常要求扁平化字段如 data、total、page 等;必须继承并重写 get_paginated_response 方法返回 response({ 'data': data, 'total': self.page.paginator.count, 'page': self.page.number, 'page_size': self.page_size, 'total_pages': self.page.paginator.num_pages })。

如何在python django rest framework中实现自定义的分页返回格式?

为什么默认的 PageNumberPagination 返回结构不满足需求?

Django REST Framework 默认分页器(如 PageNumberPagination)返回的数据是包裹在 results 键下的列表,外层还有 count、next、previous 等字段。但很多前端团队或第三方 API 规范(比如某些 OpenAPI 合约)要求分页字段扁平化,例如直接返回 data、total、page、page_size,甚至要求没有 next/previous 字符串链接——只返回数字页码。

这不是配置能解决的,必须重写 get_paginated_response 方法。

如何继承 PageNumberPagination 并覆盖响应结构?

最稳妥的方式是继承 DRF 的分页类,复写 get_paginated_response,手动构造字典。注意:不要改动 paginate_queryset,它负责切片逻辑,保持原样即可。

  • self.page.number 是当前页码(从 1 开始),self.page.paginator.num_pages 是总页数
  • self.page.paginator.count 是总记录数,比 len(self.page) 更准(后者只返回当前页数据量)
  • 避免在响应里拼接 request 相关 URL——除非你明确需要,否则容易在异步任务或测试中出错
from rest_framework.pagination import PageNumberPagination

class CustomPagination(PageNumberPagination):
    def get_paginated_response(self, data):
        return Response({
            'data': data,
            'total': self.page.paginator.count,
            'page': self.page.number,
            'page_size': self.page_size,
            'total_pages': self.page.paginator.num_pages,
        })

怎样在视图中正确启用自定义分页器?

不能只靠 DEFAULT_PAGINATION_CLASS 全局设置——因为不同接口可能需要不同结构(比如用户列表要 total_pages,日志列表只要 has_next 布尔值)。推荐在具体 APIView 或 ViewSet 中显式指定。

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载
  • 用 pagination_class = CustomPagination 类属性,不是实例属性
  • 如果视图集用了 ListModelMixin,确保没被 get_paginated_response 的 mixin 实现意外覆盖(DRF 会自动调用)
  • 测试时注意:未登录或权限不足导致空查询集时,self.page 仍存在,但 self.page.object_list 为空——你的 total 仍应返回真实总数(即 paginator.count)

遇到 AssertionError: Expected a `Response`, received a `dict` 怎么办?

这是最常见的错误,发生在你忘了在 get_paginated_response 里调用 Response(...),而是直接 return 了一个 dict。DRF 的分页流程严格依赖返回 Response 实例。

另一个隐形坑是:如果你在自定义分页器里调用了 super().get_paginated_response(...),它会按默认格式返回,然后你再试图修改那个 response.data —— 这不行,因为 Response 初始化后 data 是只读的(除非用 .data = ... 赋值,但破坏封装且易漏)。

务必从头构造新 Response,别复用父类返回值。

自定义分页真正麻烦的不是结构本身,而是和权限、过滤、缓存这些中间环节的交互——比如 django-filter 的 FilterSet 会影响 paginator.count 的计算时机,而缓存若只缓存 data 部分,就会漏掉 total 字段。这些细节不报错,但会让前端拿到的总数和实际翻页行为对不上。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1791

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4664

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1749

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

27657

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3327

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3347

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1203

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2603

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习