DRF之分页

分页类

在DRF中,如果需要对数据进行分页处理,就可以使用分页类,要求视图类需要继承GenericAPIView类和ListModelMixin类

image

image

DRF三种分页方式

PageNumberPagination类

基本分页,根据页码和每页显示的数据条数控制返回的数据。

继承PageNumberPagination重写属性:

from rest_framework.pagination import PageNumberPagination

class CommonPageNumberPagination(PageNumberPagination):
    page_size = 5  # 每页显示的数据条数
    page_query_param = 'page'  # 页码的参数名
    page_size_query_param = 'size'  # 每页显示条数的参数名
    max_page_size = 2  # 最大显示条数,只有size参数有值才会生效

image

带了size参数,如果超出最大显示条数,就显示设置的最大条数

image

LimitOffsetPagination类

偏移分页,根据偏移量和限制条控制返回的数据。

继承LimitOffsetPagination重写属性:

class CommonLimitOffsetPagination(LimitOffsetPagination):
    default_limit = 5 # 每页默认显示多少条
    limit_query_param = 'limit'  # 限制条数的参数名
    offset_query_param = 'offset'  # 偏移量的参数名
    max_limit = 6  # 最大限制条数

从第3条数据开始,取5条数据

http://127.0.0.1:8000/books/?limit=3&offset=5

CursorPagination类

游标分页,根据当前游标位置控制返回的数据,页面跳转只能跳上一页和下一页,但是针对于大数据量分页效率高。

继承CursorPagination类重写属性:

class CommonCursorPagination(CursorPagination):
    cursor_query_param = 'cursor'  # 游标的参数
    page_size = 5  # 每页显示的条数
    ordering = 'price'  # 排序的字段,必须是表中有的字段

image

视图类配置:只能选择一个分页类。

from rest_framework.generics import ListAPIView

class BookView(ListAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    # 添加分页类
    pagination_class = 分页类

    def get(self, request, *args, **kwargs):
        return super().list(request, *args, **kwargs)

继承APIView类实现分页

继承APIView类想要实现分页效果,就需要用到分页类中的paginate_queryset方法(分页处理)和get_paginated_response方法(获取处理好的Response对象)

image

视图类编写:

class BookView(APIView):
    def get(self, request, *args, **kwargs):
        # 数据库数据
        books = Book.objects.all()
        # 分页类对象
        paginator = CommonPageNumberPagination()
        # 分页结果
        res = paginator.paginate_queryset(books, request, self)
        # 序列化
        ser = BookSerializer(res, many=True)
        # 返回
        return paginator.get_paginated_response(ser.data)
posted @ 2022-06-23 19:21  Yume_Minami  阅读(470)  评论(0编辑  收藏  举报