Django REST Framework 分页机制详解:全局配置与局部覆盖

Felix
Felix
发布时间:2026-10-14| 5人浏览过
原创

本文深入解析 Django REST Framework 的分页功能,旨在解决大数据量返回导致的性能问题。详细对比 PageNumberPagination 与 LimitOffsetPagination 两种常用策略,并演示如何通过全局配置文件统一启用分页,以及在特定视图集中通过 pagination_class 属性进行局部覆盖,实现灵活的资源列表控制。

Django REST Framework 分页必要性

若未在 Django REST Framework 中配置分页机制,系统默认会将所有资源序列化后一次性返回。当数据量庞大时,这种全量返回方式会严重拖慢网站响应速度并消耗大量服务器资源。因此,为博客文章列表 API 引入分页功能是提升系统性能的关键步骤。

常用分页策略对比

Django REST Framework 内置了多种分页辅助类以支持不同的业务需求,其中最为常用的是以下两种:

PageNumberPagination

该策略将资源集合划分为第 1 页、第 2 页直至第 n 页,客户端通过指定页码参数来获取对应的分页数据。

LimitOffsetPagination

此方式通过 limit(限制数量)和 offset(偏移量)两个参数来精确控制返回的资源范围。例如,发起 API 请求 /posts/?offset=20&limit=5,即可获取从第 20 篇文章之后开始的 5 篇文章。若 offset 按固定步长递增且 limit 保持不变,其效果等同于按页码分页。然而,由于 offset 和 limit 可设置为任意数值,该分页方式比 PageNumberPagination 具备更高的灵活性。

全局分页配置与局部覆盖

启用分页功能的操作十分简便,只需在项目的配置文件中定义分页选项,即可实现全局生效。请打开 config/common.py 配置文件,并添加如下分页配置代码:


REST_FRAMEWORK = {
  # 设置 DEFAULT_PAGINATION_CLASS 后,将全局启用分页,所有 List 接口的返回结果都会被分页。
  # 如果想单独控制每个接口的分页情况,可不设置这个选项,而是在视图函数中进行配置
  "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
  # 这个选项控制分页后每页的资源个数
  "PAGE_SIZE": 10,
}

完成上述配置后,所有由通用视图函数或视图集生成的资源列表 API,其返回结果均会自动应用分页逻辑。配置文件中的设置具有全局效力;若某个特定的视图函数或视图集希望忽略全局配置,可采用在视图内部设置 pagination_class 属性的方式,明确指定该视图所使用的分页辅助类。例如,若需将博客文章列表的分页方式替换为 limit offset 模式,可按如下方式配置:


from rest_framewrok.pagination import PageNumberPagination
class PostViewSet(viewsets.GenericViewSet):
  pagination_class = LimitOffsetPagination

通过上述设置,PostViewSet 视图集将返回采用 limit offset 分页格式的文章列表,而其他未做特殊配置的视图或视图集将继续沿用全局设定的分页策略。

调用文章 API 后,返回的数据结构示例如下:

对返回结果中各字段的具体解释如下:

count:表示当前查询条件下的资源总数。

next:指向下一页资源列表的 URL 链接。

previous:指向上一页资源列表的 URL 链接。

results:包含当前页具体资源数据的列表。

以上内容涵盖了 Django REST Framework 分页功能的核心配置与使用细节,希望能为读者的开发工作提供有益参考,欢迎持续关注本站获取更多技术资讯。

免责声明:本文内容仅供参考,不代表本站观点。转载或引用请注明出处。

Python 相关产品和应用

全部下载
Selenium

Selenium

4.51.0 · Windows

用于浏览器自动化和 Web 测试的 Python 工具。

scikit-learn

scikit-learn

1.9.1 · Windows

常用 Python 机器学习算法与模型评估工具库。

Black

Black

26.10.1 · Windows

强调一致性的 Python 自动代码格式化工具。

Ruff

Ruff

0.17.1 · macOS

由 Rust 编写的高速 Python 代码检查和格式化工具。

pytest

pytest

9.1.1 · Windows

简洁而强大的 Python 自动化测试框架。

FastAPI

FastAPI

0.146.0 · Windows

高性能 Python API 框架,支持类型提示和自动接口文档。

Flask

Flask

3.1.3 · Windows

轻量灵活的 Python Web 应用框架。

Django

Django

6.1.2 · Windows

成熟的 Python Web 框架,适合构建内容站点和业务系统。

Spyder

Spyder

6.1.7 · Windows

面向科学计算与数据分析的 Python 集成开发环境。

SciPy

SciPy

1.18.1 · Windows

面向科学、工程和技术计算的 Python 算法库。