注册 登录
  • 欢迎访问"运维那点事",推荐使用Google浏览器访问,可以扫码关注本站的"微信公众号"。
  • 如果您觉得本站对你有帮助,那么可以扫码捐助以帮助本站更好地发展。

Django REST framework分页

Python框架 彭东稳 147次浏览 已收录 0个评论

一、分页配置

在系统开发中,分页一般都是必不可少的功能。REST framework包含对可定制分页样式的支持,这使你可以将较大的结果集分成单独的数据页面。

需要知道是,分页仅在你使用通用视图或视图集时自动执行。如果你使用的是常规APIView,则需要自己调用分页 API 以确保返回分页响应。示例请参阅mixins.ListModelMixingenerics.GenericAPIView类的源代码。

分页样式设置可以使用DEFAULT_PAGINATION_CLASSPAGE_SIZE在setting.py文件中全局设置。例如,要使用内置的 limit/offset 分页,你可以这样做:

请注意,你需要设置分页类和使用的页面大小。默认情况下,DEFAULT_PAGINATION_CLASSPAGE_SIZE都是None,为None时表示关闭分页。

除了在全局设置外,你还可以使用pagination_class属性在单个视图上设置分页类。通常,你希望在整个 API 中使用相同的分页样式,但你可能希望在每个视图的基础上更改分页的各个方面,例如默认或最大页面大小等。如果要修改分页样式的特定方面,则需要继承其中一个分页类,并设置要更改的属性。

PageNumberPagination类包括可以覆盖以修改分页样式的许多属性,要设置这些属性,应继承PageNumberPagination类,然后如上所示启用自定义分页类。

  • django_paginator_class:使用的Django Paginator类,默认是django.core.paginator.Paginator,对大部分用例是适用的。
  • page_size:数值,页面大小,默认是全局PAGE_SIZE的值。
  • page_query_param:字符串,查询参数的名称,默认是’page’
  • page_size_query_param:字符串,请求设置页面大小的参数名称,默认是None,表示客户端可能无法控制请求的页面大小。
  • max_page_size:字符串,最大允许请求的页面大小,此属性仅在page_size_query_param也被设置时有效。
  • last_page_strings:字符串列表或者元组,默认是(‘last’,)
  • template:分页控件使用的模板的名称,可以覆盖或设置为None,默认为”rest_framework/pagination/numbers.html”

然后,你可以使用.pagination_class属性将新样式应用于视图:

或者在settings中使用DEFAULT_PAGINATION_CLASS全局应用样式。例如:

二、分页API

上面演示中我们使用了两种分页的API,分别是PageNumberPaginationLimitOffsetPagination

PageNumberPagination

此分页样式在请求查询参数中接受一个页码值。

Request:

Response:

可以看出,响应数据发生了变化。多了count字段,表示所有页统计数;next字段表示下一页的链接;previous字段表示上一页的链接;results字段才是真正包含响应数据。这些额外的字段信息,在前端拿到时非常有用,前端也需要分页。

虽然我们定义的默认page_size是12,但是也是支持前端动态指定的page_size的大小,指定page_size后会覆盖默认page_size大小,这一点非常灵活。

LimitOffsetPagination

这种分页样式与SQL语句语法近似,客户端包含 “limit” 和 “offset” 查询参数。limit 表示要返回的 item 的最大数量,并且等同于PageNumberPagination样式中的 page_size。offset 指定查询的起始位置与完整的未分类 item 集的关系。

Request:

Response:

LimitOffsetPagination 类包含一些可以被覆盖以修改分页样式的属性。要设置这些属性,应该继承 LimitOffsetPagination 类,然后像上面那样启用你的自定义分页类。

  • default_limit:一个数字值,指定客户端在查询参数中未提供的 limit 。默认值与 PAGE_SIZE setting key 相同。
  • limit_query_param:一个字符串值,指示 “limit” 查询参数的名称。默认为 ‘limit’。
  • offset_query_param:一个字符串值,指示 “offset” 查询参数的名称。默认为 ‘offset’。
  • max_limit:一个数字值,表示客户端可以要求的最大允许 limit。默认为 None。
  • template:在可浏览 API 中渲染分页控件时使用的模板的名称。可能会被覆盖以修改渲染样式,或设置为 None 以完全禁用 HTML 分页控件。默认为 “rest_framework/pagination/numbers.html”。

如果您觉得本站对你有帮助,那么可以支付宝扫码捐助以帮助本站更好地发展,在此谢过。
喜欢 (0)or分享 (0)
关于作者:

您必须 登录 才能发表评论!