Django REST Framework-分页

DRF-分页-官方文档

使用注意：
Pagination is only performed automatically if you’re using the generic views or viewsets. If you’re using a regular APIView, you’ll need to call into the pagination API yourself to ensure you return a paginated response. See the source code for the mixins.ListModelMixin and generics.GenericAPIView classes for an example.

1、LimitOffsetPagination

1.1、配置settings.py

# settings.pyREST_FRAMEWORK = {...# 分页 只有在使用通用视图或视图集时才会自动执行分页。如果您使用的是常规APIView，则需要自己调用分页 API 以确保返回分页响应'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination','PAGE_SIZE': 1,...
}

1.2、视图views.py

class UserInfoView(GenericAPIView, ListModelMixin):queryset = UserInfo.objects.all()serializer_class = UserInfoSerializerdef get(self, request):return self.list(request=request)

1.3、访问结果

    http://127.0.0.1:9989/vueshop/user/后面不带参数，默认取settings配置，进行分页；配置的是每页1条数据

    {"count": 3,"next": "http://127.0.0.1:9989/vueshop/user/?limit=1&offset=1","previous": null,"results": [{"id": 1,"username": "admin","mobile": "19856226325"}]
}

http://127.0.0.1:9989/vueshop/user/?limit=2
后面带参数了，就按limit的值进行分页；每页limit=2条数据

    {"count": 3,"next": "http://127.0.0.1:9989/vueshop/user/?limit=2&offset=2","previous": null,"results": [{"id": 1,"username": "admin","mobile": "19856226325"},{"id": 2,"username": "test","mobile": ""}]
}

http://127.0.0.1:9989/vueshop/user/?offset=1&limit=1
还可以自定义从哪条数据offset=1开始进行分页limit=1；从offset=1第二条数据开始，每页1条数据limit=1

    {"count": 3,"next": "http://127.0.0.1:9989/vueshop/user/?limit=1&offset=2","previous": "http://127.0.0.1:9989/vueshop/user/?limit=1","results": [{"id": 2,"username": "test","mobile": ""}]
}

2、PageNumberPagination

2.1、配置settings.py

# settings.pyREST_FRAMEWORK = {...# 分页 只有在使用通用视图或视图集时才会自动执行分页。如果您使用的是常规APIView，则需要自己调用分页 API 以确保返回分页响应'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination','PAGE_SIZE': 1,...
}

2.2、视图views.py

class UserInfoView(GenericAPIView, ListModelMixin):queryset = UserInfo.objects.all()serializer_class = UserInfoSerializerdef get(self, request):return self.list(request=request)

2.3、访问结果

    http://127.0.0.1:9989/vueshop/user/后面不带参数，默认取settings配置，进行分页；每页1条数据展示

   {"count": 3,"next": "http://127.0.0.1:9989/vueshop/user/?page=2","previous": null,"results": [{"id": 1,"username": "admin","mobile": "19856226325"}]
}

http://127.0.0.1:9989/vueshop/user/?page=2
后面带参数了，就按page的值进行分页；每页1条（setting配置的），显示第二页数据

   {"count": 3,"next": "http://127.0.0.1:9989/vueshop/user/?page=3","previous": "http://127.0.0.1:9989/vueshop/user/","results": [{"id": 2,"username": "test","mobile": ""}]
}

http://127.0.0.1:9989/vueshop/user/?page=1&page_size=2
还可以自定义每页数据量，并显示第几页；每页page_size=2，显示第page=1页数据
**注意**：实际请求参数的page_size=2并不生效，取的还是系统settings的值=1。如下图，一共3条数据，如果page_size=2生效，取第一页应该是2条数据，但实际是1条数据。这个问题下面解决。

{"count": 3,"next": "http://127.0.0.1:9989/vueshop/user/?page=2&page_size=2","previous": null,"results": [{"id": 1,"username": "admin","mobile": "19856226325"}]
}

从上面的源码可以看出page_size不生效的原因page_size_query_param=None，那么就需要自定义分页类，修改此属性。

3、自定义分页类

from collections import OrderedDictfrom rest_framework.pagination import PageNumberPagination# 自定义分页对象
from rest_framework.response import Responseclass MyPageNumberPagination(PageNumberPagination):# 1,默认的大小 [每页显示数量],如果不配置，就取settings的值page_size = 5# 2,前端可以指定页面大小，此字段名称决定了 url后面的 每页数量的字段page_size_query_param = 'page_size'# 3,页面的最大大小 [每页显示数量]，如果前端传的值大于这个设置，就以这个值返回max_page_size = 999# 重写响应值的方法def get_paginated_response(self, data):return Response(OrderedDict([('page', self.page.number),('pages', self.page.paginator.num_pages), # 总页数('lists', data)  # 结果集]))

视图函数中设置pagination_class的值等于上面自定义的分页器类。

# views.py
class UserInfoView(GenericAPIView, ListModelMixin):queryset = UserInfo.objects.all()serializer_class = UserInfoSerializerpagination_class = MyPageNumberPaginationdef get(self, request):return self.list(request=request)

响应结果如下：

{"page": 1,"pages": 2,"lists": [{"id": 1,"username": "admin","mobile": "19856226325"},{"id": 2,"username": "test","mobile": ""}]
}