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:当前页的资源列表

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

相关文章

  • 深入理解Python中range和xrange的区别

    深入理解Python中range和xrange的区别

    这篇文章主要介绍了深入理解Python中range和xrange的区别,从用法和输出等方便详细介绍了之间的差别。
    2017-11-11
  • python requests实现上传excel数据流

    python requests实现上传excel数据流

    这篇文章主要介绍了python requests实现上传excel数据流,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-02-02
  • Python参数的传递几种情况实例详解

    Python参数的传递几种情况实例详解

    这篇文章主要给大家介绍了关于Python参数的传递的相关资料,在Python中传递参数指的是函数或方法中的参数传输方式,文中给出了详细的代码示例,需要的朋友可以参考下
    2023-09-09
  • django 数据库返回queryset实现封装为字典

    django 数据库返回queryset实现封装为字典

    这篇文章主要介绍了django 数据库返回queryset实现封装为字典,具有很好的参考价值,希望对大家有所帮助。一起跟随小编过来看看吧
    2020-05-05
  • python3之Splash的具体使用

    python3之Splash的具体使用

    Splash是一个javascript渲染服务。本文主要介绍了python3之Splash的具体使用,文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2021-08-08
  • python生成器,可迭代对象,迭代器区别和联系

    python生成器,可迭代对象,迭代器区别和联系

    这篇文章主要介绍了python生成器,可迭代对象,迭代器区别和联系,通过对比用法让大家更加深入理解相关知识,需要的朋友参考学习下吧。
    2018-02-02
  • 使用k8s部署Django项目的方法步骤

    使用k8s部署Django项目的方法步骤

    这篇文章主要介绍了使用k8s部署Django项目的方法步骤,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-01-01
  • Win10下python 2.7.13 安装配置方法图文教程

    Win10下python 2.7.13 安装配置方法图文教程

    这篇文章主要为大家详细介绍了Win10下python 2.7.13 安装配置方法图文教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-09-09
  • 浅析使用Python操作文件

    浅析使用Python操作文件

    文件操作对编程语言的重要性不用多说,如果数据不能持久保存,信息技术也就失去了意义。按照本人经验,IO也是蛮头疼的一件事,因为不会用得太多,所以总是记不住API,每次都要重新google就会打断思路,还不一定每次都快速得到正确的文章。
    2017-07-07
  • Python3 re.search()方法的具体使用

    Python3 re.search()方法的具体使用

    本文主要介绍了Python3 re.search()方法的具体使用,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2022-08-08

最新评论