Django rest framework分页接口实现原理解析

 更新时间:2020年08月21日 09:46:44   作者:削微寒  
这篇文章主要介绍了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:下一页资源的链接

previous:上一页资源的链接

results:当前页的资源列表

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持脚本之家。

相关文章

  • Django的多表查询操作实战

    Django的多表查询操作实战

    Django提供一种强大而又直观的方式来"处理"查询中的关联关系,它在后台自动帮你处理JOIN,下面这篇文章主要给大家介绍了关于Django多表查询操作的相关资料,文中通过实例代码介绍的非常详细,需要的朋友可以参考下
    2023-06-06
  • django 使用内置messages的操作

    django 使用内置messages的操作

    这篇文章主要介绍了django 使用内置messages的操作,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2021-04-04
  • Python的函数使用示例详解

    Python的函数使用示例详解

    在Python的函数中,我们将其分为内置函数、自定义函数、main函数三个模块,当然,使用的过程中会涉及到变量以及参数,这些都会举例进行说明,对Python函数使用相关知识感兴趣的朋友跟随小编一起看看吧
    2021-12-12
  • 使用Python实现图像有效压缩的方法

    使用Python实现图像有效压缩的方法

    在数字时代,图像作为信息传递的重要媒介,在网页设计、移动应用和多媒体制作中扮演着不可或缺的角色,本文将详细介绍如何使用Python,一个功能强大且易于学习的编程语言,来实现图像的有效压缩,感兴趣的朋友可以参考下
    2024-03-03
  • 解决jupyter notebook import error但是命令提示符import正常的问题

    解决jupyter notebook import error但是命令提示符import正常的问题

    这篇文章主要介绍了解决jupyter notebook import error但是命令提示符import正常的问题,具有很好的参考
    2020-04-04
  • python操作配置文件实战记录

    python操作配置文件实战记录

    这篇文章主要给大家介绍了关于python操作配置文件的相关资料,配置文件是为程序配置参数和初始设置的文件,文中通过代码介绍的非常详细,需要的朋友可以参考下
    2023-11-11
  • 基于python实现检索标记敏感词并输出

    基于python实现检索标记敏感词并输出

    这篇文章主要介绍了基于python实现检索敏感词并输出,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-05-05
  • 200行python代码实现贪吃蛇游戏

    200行python代码实现贪吃蛇游戏

    这篇文章主要为大家详细介绍了200行python代码实现贪吃蛇游戏,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2020-04-04
  • Python的集合类型之set和frozenset详解

    Python的集合类型之set和frozenset详解

    这篇文章主要为大家详细介绍了Python的集合类型之set和frozenset,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下,希望能够给你带来帮助
    2022-03-03
  • Python处理中文标点符号大集合

    Python处理中文标点符号大集合

    中文文本中可能出现的标点符号来源比较复杂,通过匹配等手段对他们处理的时候需要格外小心,防止遗漏,下面小编给大家带来了Python处理中文标点符号大集合,感兴趣的朋友跟随脚本之家小编一起看看吧
    2018-05-05

最新评论