Django-drf分页、自定义分页

前言

这几年一直在it行业里摸爬滚打，一路走来，不少总结了一些python行业里的高频面试，看到大部分初入行的新鲜血液，还在为各样的面试题答案或收录有各种困难问题

于是乎，我自己开发了一款面试宝典，希望能帮到大家，也希望有更多的Python新人真正加入从事到这个行业里，让python火不只是停留在广告上。

微信小程序搜索：Python面试宝典

或可关注原创个人博客：https://lienze.tech

也可关注微信公众号，不定时发送各类有趣猎奇的技术文章：Python编程学习

分页

强大的 drf 还提供了对于分页的支持，可以方便快捷的进行接口的全局分页或者局部分页设置

全局分页

直接在 ***settings***中配置即可

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

配置完了如果不向用，那么就直接在视图类下使用如下属性关闭全局分页功能

class View(...):
    pagination_class = None

• PageNumberPagination

可以进行直接的页码处理，返回某一页分页数据

http://127.0.0.1:8000/user/?limit=2&page=2
# limit：每页的数据大小
# page：当前的页码

• LimitOffsetPagination

可以通过连接可选的参数进行分页单页数量大小的控制，分页数据偏移的选择

http://127.0.0.1:8000/path/?limit=2&offset=2"
# limit：每页的数据大小
# offset：从某一个数据位置开始偏移

---

局部分页

除了默认的分页样式之外，还可以通过继承分页类的方式重写分页样式，并将其作用至局部

from rest_framework.pagination import PageNumberPagination
class StandardResultsSetPagination(PageNumberPagination):
    page_size = 2 # 每页数据量
    page_size_query_param = 'page_size' # 每页大小连接传递参数
    max_page_size = 5 # 每页数据量最多
    page_query_param = 'page' # 路由传递获取的页码参数 key 值

• 局部作用分页类，需要使用***pagination_class***属性

class SomeModelViewSet(ModelViewSet):
    ...
    pagination_class = StandardResultsSetPagination

---

自定义分页

要创建自定义的分页序列化程序类，可以继承分页基类，重写 paginate_queryset 和 get_paginated_response 方法

• paginate_queryset：分页所要操作的数据对象
• get_paginated_response：分页后的实际数据，并返回一个 Response

如希望可以返回分页数据时，带上分了多少页的信息，可以重写*******get_paginated_response***

from rest_framework.utils.urls import replace_query_param
class CustomPagination(PageNumberPagination):
    def get_paginated_response(self, data):
        url = self.request.build_absolute_uri()
        num_pages = self.page.paginator.num_pages
        return Response({
            'links': {
                'next': self.get_next_link(),
                'previous': self.get_previous_link()
            },
            'count': self.page.paginator.count,
            # 'num_pages': self.page.paginator.num_pages,
            'num_pages': [
                  replace_query_param(
                      url, # 接口主机地址
                      self.page_query_param, # get传参时的页码标示
                      num_page # 带拼接的页码
                  )
                  for num_page in range(1, num_pages + 1) # 推导式
            ],
            'results': data
        })