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属性,指定需要使用的分页辅助类即可。例如将博客文章列表分页替换为limitoffset的分页方式,可以这样设置:
fromrest_framewrok.paginationimportPageNumberPagination classPostViewSet(viewsets.GenericViewSet): pagination_class=LimitOffsetPagination
这样,PostViewSet视图集将返回limitoffset分页形式的文章列表,而其他视图或者视图集仍将使用全局的分页配置。
请求文章api,返回结果如下:
对返回结果的解释:
count:总资源数目
next:下一页资源的链接
previous:上一页资源的链接
results:当前页的资源列表
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持毛票票。
声明:本文内容来源于网络,版权归原作者所有,内容由互联网用户自发贡献自行上传,本网站不拥有所有权,未作人工编辑处理,也不承担相关法律责任。如果您发现有涉嫌版权的内容,欢迎发送邮件至:czq8825#qq.com(发邮件时,请将#更换为@)进行举报,并提供相关证据,一经查实,本站将立刻删除涉嫌侵权内容。