经验首页 前端设计 程序设计 Java相关 移动开发 数据库/运维 软件/图像 大数据/云计算 其他经验
当前位置:技术经验 » 程序设计 » Django » 查看文章
Django REST framework 分页的实现代码
来源:jb51  时间:2019/6/20 8:35:57  对本文有异议

官方文档[这里]

用于分页的模块: Pagination

Django REST framework 有内置 Pagination 模块,无需额外安装, 只需做简单的配置.

配置什么呢? 就是告诉Django要用到什么样的分页样式, 比如: 返回哪些字段, 每页的大小, 请求参数的名称等等.

2种配置途径:

1.settings.py 文件里做全局的配置
2.单独为每个需要分页的 view 分配自定义分页器.

途径1是为所有继承ListViewAPI的接口做默认配置, 途径2对单独一个接口做个性化配置.

需要注意的是: 途径1做了全局的配置, 所有继承 ListAPIView 的接口,默认都会有分页. 这会影响到现有接口返回数据的结构. 除了这一点, 途径1还是相当不错的.

我比较喜欢仅使用途径2, 我可以自定义了一个通用型的分页器, 只为有需要分页的view分配分页器, 也是挺方便的.

途径1: settings.py文件里做全局配置

  1. REST_FRAMEWORK = {
  2. # ...
  3. 'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
  4. 'PAGE_SIZE': 100
  5. }

DEFAULT_PAGINATION_CLASS: 默认分页器(BasePagination的子类). Django提供了3个类型: PageNumberPagination、LimitOffsetPagination、CursorPagination. 不同类型返回的分页信息不同. 也可以是你自定义的分页器.

PAGE_SIZE: 分页大小.

途径2: 自定义分页器

这里将示例使用自定义分页器的流程.

新建一个 paginations.py 用于写分页器:

我们在 paginations.py 文件里写一个通用的分页器:

  1. class StandarPagination(PageNumberPagination):
  2. page_size = 20 # 默认每页显示条数配置
  3. page_query_param = 'page' # “页数”的请求参数名称, 默认是page
  4. page_size_query_param = 'page_size' # “分页大小”的请求参数名称
  5. # 进入父类 PageNumberPagination 可看响应体返回字段.
  6. # def get_paginated_response(self, data):
  7. # return Response(OrderedDict([
  8. # ('count', self.page.paginator.count),
  9. # ('next', self.get_next_link()),
  10. # ('previous', self.get_previous_link()),
  11. # ('results', data)
  12. # ]))
  13.  
  14. # 觉得不适用, 那就拷贝出来,重载函数, 自己多加几个字段.
  15. # (可通过官方文档或直接调试得知从哪些属性获取正确的值.)
  16. def get_paginated_response(self, data):
  17. return Response(OrderedDict([
  18. ('count', self.page.paginator.count),
  19. ('next', self.get_next_link()),
  20. ('previous', self.get_previous_link()),
  21. ('page', self.page.number),
  22. ('total_page', self.page.paginator.num_pages),
  23. ('page_size', self.page.paginator.per_page),
  24. ('results', data)
  25. ]))
  26.  

(更多的属性介绍请查看文档)

为接口分配分页器, 为属性 pagination_class 赋值即可.

  1. from rest_framework.pagination import PageNumberPagination
  2.  
  3. class MyListAPI(ListAPIView):
  4. queryset = TestModel.objects.filter()
  5. serializer_class = TestModelSerializer
  6. pagination_class = StandarPagination # 新增
  7.  

完成!

假如该接口请求地址是 http://api/test/

看客户端是如何请求接口的:

http://api/test/ : 返回第一页, 分页大小是20.

http://api/test/?page=2&page_size=10: 返回第二页,分页大小是10.

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

 友情链接:直通硅谷  点职佳  北美留学生论坛

本站QQ群:前端 618073944 | Java 606181507 | Python 626812652 | C/C++ 612253063 | 微信 634508462 | 苹果 692586424 | C#/.net 182808419 | PHP 305140648 | 运维 608723728

W3xue 的所有内容仅供测试,对任何法律问题及风险不承担任何责任。通过使用本站内容随之而来的风险与本站无关。
关于我们  |  意见建议  |  捐助我们  |  报错有奖  |  广告合作、友情链接(目前9元/月)请联系QQ:27243702 沸活量
皖ICP备17017327号-2 皖公网安备34020702000426号