Django - DRF - 分页器

目录

一、简单分页 - 查看第n页，每页显示m条

1-1 基本使用

1-2 自定义传统分页类 - 重写 PageNumberPagination内属性

二、偏移分页 - 在n位置，向后查看m条数据

三、加密分页 - 加密分页，速度快，只能上下页

四、局部配置和全局配置

4-1 源码分析

4-2 全局配置

4-3 局部配置

---

一、简单分页 - 查看第n页，每页显示m条

注意：

• 必须配置每页显示条数：page.page_size 
• page.page_query_param:配置get提交数据名
  
• 序列化需传入分页后数据对象
  
• return page.get_paginated_response(ser.data) - 返回数据带着上下链接和数据总条数 
  

1-1 基本使用

# DRF 传统分页
from rest_framework.pagination import PageNumberPagination
from rest_framework.views import APIView
from rest_framework.response import Response
from app01 import MySerializers


# DRF 基本使用 - 默认配置
# http://127.0.0.1:8000/index/?page=2&size=3，size无效
class Index(APIView):
    def get(self, request, *arges, **kwargs):
        book_list = models.Book.objects.all()
        page = PageNumberPagination()
        # 每页显示条数
        page.page_size = 2
        # http://127.0.0.1:8000/index/?test=2
        # page_query_param修改get提交数据名
        page.page_query_param='test'
        # 参数：分页对象，request对象，当前视图对象
        page_list = page.paginate_queryset(book_list, request, view=self)
        ser = MySerializers.BookSerializers(instance=page_list, many=True)
        return Response(ser.data)
        # return page.get_paginated_response(ser.data)
        # return render(request, 'drf_index.html', locals())

1-2 自定义传统分页类 - 重写 PageNumberPagination内属性

注意：

• 每页显示数据的优先级：前台提交（page_size_query_param = 'size' >page_size）
• 
• 
• 

# DRF 自定义传统分页类，重写属性
class MyPageNumberPagination(PageNumberPagination):
    # 每页显示数据
    page_size = 3

    #  http://127.0.0.1:8000/index/?data=2&size=2
    # get数据提交名
    page_query_param = 'data'
    # ？后size传输每页显示条数
    page_size_query_param = 'size'
    # 每页最多显示4条，若page_size大于max_page_size则优先后者
    max_page_size = 5


class Index(APIView):
    def get(self, request, *arges, **kwargs):
        book_list = models.Book.objects.all()
        page = MyPageNumberPagination()
        # 参数：分页对象，request对象，当前视图对象
        page_list = page.paginate_queryset(book_list, request, view=self)
        ser = MySerializers.BookSerializers(instance=page_list, many=True)
        # return Response(ser.data)
        return page.get_paginated_response(ser.data)

二、偏移分页 - 在n位置，向后查看m条数据

注意：

• 

# -----------DRF 偏移分页-------------
from rest_framework.pagination import LimitOffsetPagination


# DRF 自定义偏移分页类，重写属性
class MyLimitOffsetPagination(LimitOffsetPagination):
    default_limit = 3
    max_limit = 5
    # 返回数据从 (offset,limit} 左开右闭
    # 数据最大值（id最大）
    limit_query_param = 'limit'
    # 数据最小值（id下线）
    offset_query_param = 'offset'


class Index(APIView):
    def get(self, request, *arges, **kwargs):
        book_list = models.Book.objects.all()
        page = MyLimitOffsetPagination()
        # 参数：分页对象，request对象，当前视图对象
        page_list = page.paginate_queryset(book_list, request, view=self)
        ser = MySerializers.BookSerializers(instance=page_list, many=True)
        # return Response(ser.data)
        return page.get_paginated_response(ser.data)

三、加密分页 - 加密分页，速度快，只能上下页

注意：

• 

from rest_framework.pagination import CursorPagination


# DRF 自定义偏移分页类，重写属性
class MyCursorPagination(CursorPagination):
    page_size = 1
    page_size_query_param = 'size'
    max_page_size = 5

    # 当前页的加密key
    # "next": "http://127.0.0.1:8000/index/?cursor=cD01&size=6",
    cursor_query_param = 'cursor'
    # 排序方式
    ordering = 'id'


class Index(APIView):
    def get(self, request, *arges, **kwargs):
        book_list = models.Book.objects.all()
        page = MyCursorPagination()
        # 参数：分页对象，request对象，当前视图对象
        page_list = page.paginate_queryset(book_list, request, view=self)
        ser = MySerializers.BookSerializers(instance=page_list, many=True)
        # return Response(ser.data)
        return page.get_paginated_response(ser.data)

四、局部配置和全局配置

4-1 源码分析

4-2 全局配置

REST_FRAMEWORK = {
    # 每页显示两条
    'PAGE_SIZE':2,
}

4-3 局部配置