Django-Rest-Framework的分页

发表于 | 分类于
字数统计: 815 | 阅读时长 ≈ 3

DRF的分页

为什么要使用分页

其实这个不说大家都知道，大家写项目的时候也是一定会用的，

我们数据库有几千万条数据，这些数据需要展示，我们不可能直接从数据库把数据全部读取出来，

这样会给内存造成特别大的压力，有可能还会内存溢出，所以我们希望一点一点的取，

那展示的时候也是一样的，总是要进行分页显示，我们之前自己都写过分页。

那么大家想一个问题，在数据量特别大的时候，我们的分页会越往后读取速度越慢，

当有一千万条数据，我要看最后一页的内容的时候，怎么能让我的查询速度变快。

DRF给我们提供了三种分页方式，我们看下他们都是什么样的

DRF提供的三种分页

1
from rest_framework.pagination import PageNumberPagination, LimitOffsetPagination, CursorPagination

全局配置

1
2
3
REST_FRAMEWORK = {
    'PAGE_SIZE': 2
}

第一种

PageNumberPagination 看第n页，每页显示n条数据
http://127.0.0.1:8000/book?page=2&size=1

自定义分页类

1
2
3
4
5
class MyPageNumber(PageNumberPagination):
    page_size = 2  # 每页显示多少条
    page_size_query_param = 'size'  # URL中每页显示条数的参数
    page_query_param = 'page'  # URL中页码的参数
    max_page_size = None  # 最大页码数限制

视图

1
2
3
4
5
6
7
8
9
class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 分页
        page_obj = MyPageNumber()
        page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)
        
        ret = BookSerializer(page_article, many=True)
        return Response(ret.data)

返回带页码链接的响应

1
2
3
4
5
6
7
8
9
10
11
class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 分页
        page_obj = MyPageNumber()
        page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)

        ret = BookSerializer(page_article, many=True)
        # return Response(ret.data)
        # 返回带超链接 需返回的时候用内置的响应方法
        return page_obj.get_paginated_response(ret.data)

第二中

LimitOffsetPagination 在第n个位置 向后查看n条数据
http://127.0.0.1:8000/book?offset=2&limit=1

自定义的分页类

1
2
3
4
5
class MyLimitOffset(LimitOffsetPagination):
    default_limit = 1
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    max_limit = 999

视图

1
2
3
4
5
6
7
8
9
10
11
12
# 只有用的分页类不同，其他都相同
class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 分页
        page_obj = MyLimitOffset()
        page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)

        ret = BookSerializer(page_article, many=True)
        # return Response(ret.data)
        # 返回带超链接 需返回的时候用内置的响应方法
        return page_obj.get_paginated_response(ret.data)

第三种

CursorPagination 加密游标的分页 把上一页和下一页的id记住

自定义分页类

1
2
3
4
class MyCursorPagination(CursorPagination):
    cursor_query_param = 'cursor'
    page_size = 1
    ordering = '-id'

视图

1
2
3
4
5
6
7
8
9
10
11
class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        # 分页
        page_obj = MyCursorPagination()
        page_article = page_obj.paginate_queryset(queryset=book_list, request=request, view=self)

        ret = BookSerializer(page_article, many=True)
        # return Response(ret.data)
        # 返回带超链接 需返回的时候用内置的响应方法
        return page_obj.get_paginated_response(ret.data)

总结

pagination.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
from rest_framework import pagination


class MyPaginator(pagination.PageNumberPagination):
    # 每页限制数量
    page_size = 2
    # 参数
    page_query_param = 'page_num'
    page_size_query_param = 'size'
    # 限制
    max_page_size = 3


class MyLimitOffset(pagination.LimitOffsetPagination):
    default_limit = 1
    limit_query_param = 'limit'
    offset_query_param = 'offset'
    max_limit = 999


class MyCursorPagination(pagination.CursorPagination):
    cursor_query_param = 'cursor'
    page_size = 1
    ordering = '-id'

view.py

普通版

1
2
3
4
5
6
7
8
9
10
11
12
13
class PageBookView(APIView):
    def get(self, request):
        queryset = models.Book.objects.all()
        # 先实例化分页器对象
        # page_obj = MyPaginator()
        # page_obj = MyLimitOffset()
        page_obj = MyCursorPagination()
        # 用自己的分页器调用分页方法进行分页
        page_data = page_obj.paginate_queryset(queryset, request)
        # 序列化分页好的数据
        ser_obj = serializers.BookSerializer(page_data, many=True)
        # 给响应添加上一页下一页的链接
        return page_obj.get_paginated_response(ser_obj.data)

ModelViewSet版

1
2
3
4
5
6
7
8
from rest_framework import viewsets

class BookModelView(viewsets.ModelViewSet):
    queryset = models.Book.objects.all()
    serializer_class = serializers.BookSerializer
    # pagination_class = MyPaginator
    # pagination_class = MyLimitOffset
    pagination_class = MyCursorPagination
感谢您的支持！学如逆水行舟，不进则退！