drf框架中分页组件

Posted 2020-11-14 pythonywy

0922自我总结

drf框架中分页组件

普通分页（最常用）

自定制分页类

pagination.py

from rest_framework.pagination import PageNumberPagination
# 普通分页
class CarPageNumberPagination(PageNumberPagination):
    # 默认一页的条数
    page_size = 3
    # 用户可以自定义选择一页的条数，但最多显示5条
    page_size_query_param = 'page_size'
    max_page_size = 5
    # 默认条数访问 /我们路由设置访问这个视图的路由/?page=页面号
    #       eg：/我们路由设置访问这个视图的路由/?page=1
    # 自定义条数访问 /我们路由设置访问这个视图的路由/?page=页面号&page_size=一页的条数
    #       eg：/我们路由设置访问这个视图的路由/?page=1&page_size=5

views.py

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

偏移分页

自定制分页类

pagination.py

from rest_framework.pagination import LimitOffsetPagination
# 偏移分页
class CarLimitOffsetPagination(LimitOffsetPagination):
    # 默认一页的条数
    default_limit = 3
    # limit控制一页显示的条数，offset控制偏移的条数(从头开始计数)
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    # 限制limit可以设置的最大显示条数
    max_limit = 5
    # 接口 /我们路由设置访问这个视图的路由/?limit=一页的条数&offset=偏移的条数
    #       eg：/我们路由设置访问这个视图的路由/?limit=5&offset=2  # 显示3~7条

views.py

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

加密分页

自定制分页类

pagination.py

from rest_framework.pagination import CursorPagination
# 加密分页
class CarCursorPagination(CursorPagination):
    # 默认一页的条数
    page_size = 3
    # 用户可以自定义选择一页的条数，但最多显示5条
    page_size_query_param = 'page_size'
    max_page_size = 5
    # 默认排序规则
    ordering = 'pk'
    # 采用默认排序访问 /我们路由设置访问这个视图的路由/?cursor=加密串
    #       eg：/我们路由设置访问这个视图的路由/?cursor=cD0z
    # 结合视图类实现OrderingFilter自定义排序规则
    #  /我们路由设置访问这个视图的路由/?cursor=加密串&ordering=排序字段
    #       eg：/我们路由设置访问这个视图的路由/?cursor=cD0z&ordering=-price

views.py

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