时间戳

首页 > 技术文章 > drf框架中分页组件

drf框架中分页组件

baohanblog 2020-03-06 09:33 原文

drf框架中分页组件

分页组件的使用步骤

1、重写分页类 - 自定义同名类继承drf的分页类，完成必要的配置

2、将重写的分页类配置给有需求的视图类

基础分页器（最常用）

自定义分页类

pagination.py

from rest_framework.pagination import PageNumberPagination as DrfPageNumberPagination

class PageNumberPagination(DrfPageNumberPagination):
    # 默认一页显示的条数
    page_size = 2
    # url中携带页码的key
    page_query_param = 'page'
    # url中用户携带自定义一页条数的key
    page_size_query_param = 'page_size'
    # 用户最大可自定义一页的条数
    max_page_size = 3

    # 默认条数访问 /我们路由设置访问这个视图的路由/?page=页面号
    #       eg：/我们路由设置访问这个视图的路由/?page=1
    # 自定义条数访问 /我们路由设置访问这个视图的路由/?page=页面号&page_size=一页的条数
    #       eg：/我们路由设置访问这个视图的路由/?page=1&page_size=5

view.py

from . import pagination
class 模型名称(ModelViewSet):
    .......
    pagination_class = pagination.PageNumberPagination

偏移分页器

自定制分页类

pagination.py

from rest_framework.pagination import LimitOffsetPagination as DrfLimitOffsetPagination
# 偏移分页
class CarLimitOffsetPagination(LimitOffsetPagination):
    # 默认一页显示的条数
    default_limit = 3
    # limit控制一页显示的条数，offset控制偏移的条数(从头开始计数)
    # limit是url中用户携带自定义一页条数的key
    limit_query_param = 'limit'
    # offset是url中用户携带自定义偏移条数的key
    offset_query_param = 'offset'
    # 限制limit可以设置的最大显示条数
    max_limit = 5

    # 接口 /我们路由设置访问这个视图的路由/?limit=一页的条数&offset=偏移的条数
    #       eg：/我们路由设置访问这个视图的路由/?limit=5&offset=2  # 显示3~7条

view.py

from . import pagination
class 模型名称(ModelViewSet):
    .......
    # 偏移分页器，没有固定页码，自定义从偏移量开始往后查询自定义条数
    pagination_class = pagination.LimitOffsetPagination

游标分页器（加密分页器）

自定制分页类

pagination.py

from rest_framework.pagination import CursorPagination as DrfCursorPagination
class CursorPagination(DrfCursorPagination):
    # 默认一页显示的条数
    page_size = 2
    # url中携带页码的key（编码后的结果）
    cursor_query_param = 'cursor'
    # url中用户携带自定义一页条数的key
    page_size_query_param = 'page_size'
    # 用户最大可自定义一页的条数
    max_page_size = 3
    # 游标分页器的特殊点：
    """
    1）如果视图类没有配 排序过滤组件filter_backends = [OrderingFilter]，采用 ordering 设置的作为默认排序规则
    2）如果视图类配了 排序过滤组件filter_backends = [OrderingFilter]，url请求必须带上ordering排序规则，因为默认排序规则失效
    注：因为游标分页是基于排序后结果上的分页
    """
    ordering = '-price'

    # 采用默认排序访问 /我们路由设置访问这个视图的路由/?cursor=加密串
    #       eg：/我们路由设置访问这个视图的路由/?cursor=cD0z
    # 结合视图类实现OrderingFilter自定义排序规则
    #  /我们路由设置访问这个视图的路由/?cursor=加密串&ordering=排序字段
    #       eg：/我们路由设置访问这个视图的路由/?cursor=cD0z&ordering=-price

view.py

from . import pagination
class 模型名称(ModelViewSet):
    .......
    pagination_class = pagination.CursorPagination

    # 允许排序的字段
    ordering_fields = ['id', 'price']

推荐阅读