drf分页器的使用
仙人技术
共 6637字，需浏览 14分钟
·
2021-03-26 14:33
目录
1、概述
2、PageNumberPagination
3、LimitOffsetPagination
4、CursorPagination
1、概述
Django REST framework提供了分页的支持
可以在配置文件中设置全局的分页方式，如：
REST_FRAMEWORK = {
'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination', # 选用的分页器
'PAGE_SIZE': 100 # 每页数目
}
也可通过自定义Pagination类，来为视图添加不同分页行为。在视图中通过pagination_clas属性来指明
例如：
from rest_framework.pagination import PageNumberPagination
class MyPageNumberPagination(PageNumberPagination):
# 设置url中的取多少页的key
page_query_param = 'page'
# 设置url中设置取数据条数的key
page_size_query_param = 'size'
#设置每一页的数据条数
page_size = 2
# 设置每一页最多可取的数据数
max_page_size = 5
class Book2View(ListAPIView):
queryset = models.Book.objects.all()
serializer_class = BookModelSerializer
pagination_class = MyPageNumberPagination #指定该视图类的分页器
注意：如果在视图内关闭分页功能，只需在视图内设置pagination_class = None 即可，即在设置了全局分页之后我们可以在局部禁用该设置
drf 提供给我们的分页器有PageNumberPagination、LimitOffsetPagination、CursorPagination
2、PageNumberPagination
url形式：
http://127.0.0.1:8000/books/?page=1
可以在自定义类中定义的属性有：
page_query_param：设置url中页数的关键字，默认的是pagepage_size_query_param：设置url中每页数据条数的关键字，默认的是Nonepage_size：设置每一页的数据条数（必设）max_page_size：设置每一页最多可取的数据条数（可选）
class MyPageNumberPagination(PageNumberPagination):
page_size = 2
page_query_param = 'page'
page_size_query_param = 'size'
max_page_size = 5
class Book2View(ListAPIView):
queryset = models.Book.objects.all()
serializer_class = BookModelSerializer
pagination_class = MyPageNumberPagination
# APIView 中使用自定义分页类进行分页操作
class Pager(APIView):
def get(self,request,*args,**kwargs):
# 获取所有数据
ret=models.Book.objects.all()
# 创建分页对象
page=MyPageNumberPagination()
# 在数据库中获取分页的数据
page_list=page.paginate_queryset(ret,request,view=self)
# 对分页进行序列化
ser=BookSerializer1(instance=page_list,many=True)
# return Response(ser.data)
# 这个也是返回Response对象，但是比基本的多了上一页，下一页，和总数据条数（了解）
return page.get_paginated_response(ser.data)
3、LimitOffsetPagination
url形式：
http://127.0.0.1/four/books/?limit=100&offset=400
可以在自定义类中定义的属性有：
default_limit：默认限制，默认值与PAGE_SIZE设置一致limit_query_param：limit参数名，默认为limitoffset_query_param：offset参数名，默认offsetmax_limit：最大limit限制，默认None
class MyLimitOffsetPagination(LimitOffsetPagination):
default_limit = 3
limit_query_param = 'limit'
max_limit = None
offset_query_param = 'offset'
class Book2View(ListAPIView):
queryset = models.Book.objects.all()
serializer_class = BookModelSerializer
pagination_class = MyLimitOffsetPagination
# APIView 中使用自定义分页类进行分页操作
class Pager(APIView):
def get(self,request,*args,**kwargs):
# 获取所有数据
ret=models.Book.objects.all()
# 创建分页对象
page=LimitOffsetPagination()
# 在数据库中获取分页的数据
page_list=page.paginate_queryset(ret,request,view=self)
# 对分页进行序列化
ser=BookSerializer1(instance=page_list,many=True)
# return page.get_paginated_response(ser.data)
return Response(ser.data)
4、CursorPagination
url形式：
http://127.0.0.1/four/books/?cursor=cD0xNQ%3D%3D
可以在自定义类中定义的属性有：
cursor_query_param：默认查询字段，不需要修改page_size：每页数目ordering：按什么排序，需要指定
class MyCursorPagination(CursorPagination):
cursor_query_param = 'cursor'
page_size = 2
ordering = '-id'
class Book2View(ListAPIView):
queryset = models.Book.objects.all()
serializer_class = BookModelSerializer
pagination_class = MyCursorPagination
# APIView 中使用自定义分页类进行分页操作
class Pager(APIView):
def get(self,request,*args,**kwargs):
# 获取所有数据
ret=models.Book.objects.all()
# 创建分页对象
page=CursorPagination()
page.ordering='nid'
# 在数据库中获取分页的数据
page_list=page.paginate_queryset(ret,request,view=self)
# 对分页进行序列化
ser=BookSerializer1(instance=page_list,many=True)
# 可以避免页码被猜到
return page.get_paginated_response(ser.data)
评论