分页 - pagination - 两种分页器

介绍

REST framework提供了分页的支持

分类

pagination模块内有两种分页器,可由开发者选择

  • 第一种:PageNumberPagination

可以在子类中定义的属性:

  • page_size 每页数目
  • page_query_param 前端发送的页数关键字名,默认为"page"
  • page_size_query_param 前端发送的每页数目关键字名,默认为None
  • max_page_size 前端最多能设置的每页数量

 

  • 第二种:LimitOffsetPagination

可以在子类中定义的属性:

  • default_limit 默认限制,默认值与PAGE_SIZE设置一致
  • limit_query_param limit参数名,默认'limit'
  • offset_query_param offset参数名,默认'offset'
  • max_limit 最大limit限制,默认None

设置并使用

第一种:

settings.py中,设置全局的分页方式(如:PageNumberPagination):

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS':  'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 100  # 每页数目
}

第二种(重点-常用):

也可通过自定义Pagination类,来为视图添加不同分页行为。

然后,在视图中通过pagination_clas属性来指明。

第一种分页方式(比较常用) :PageNumberPagination

from rest_framework.pagination import PageNumberPagination

class StandartPageNumberPagination(PageNumberPagination):
    page_size = 2                   # 默认每页返回的条数
    max_page_size = 50              # 每页返回的最大条数
    page_size_query_param = 'ps'    # url中设置 page_size 的键(该页多少条),默认为page_size (即,默认上边自己设置的,但如果 前端/用户 想自定义返回该页多少条,就传递过来)
    page_query_param = 'p'          # url中设置 page 的键(哪一页),默认为page


class BookModelViewSet(ModelViewSet):
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    # 分页
    pagination_class = StandartPageNumberPagination

    # http://127.0.0.1:8000/books/?p=1&ps=4

第二种分页方式:LimitOffsetPagination(就不自定义了,自定义和上边一样的定义方式)

from rest_framework.pagination import LimitOffsetPagination


class BookModelViewSet(ModelViewSet):
    serializer_class = BookSerializer

    def get_queryset(self):
        return BookInfo.objects.all()

    pagination_class = LimitOffsetPagination
    
    # http://127.0.0.1:8000/books/?limit=2&offset=4

你可能感兴趣的:(Django开发-Python)