rest_framework.pagination的高级用法与技巧

rest_framework.pagination 是 Django Rest Framework 提供的一个分页工具，用于在 API 响应中进行分页并提供分页的一些功能。

高级用法与技巧如下：

1. 自定义分页大小

可以通过设置 PAGE_SIZE 参数来自定义每页的数量。默认情况下，每页数量是 settings.REST_FRAMEWORK.PAGE_SIZE，如果没有设置，则为 10。

class MyPagination(PageNumberPagination):
    page_size = 20

可以在视图中使用这个分页器：

class MyView(APIView):
    pagination_class = MyPagination

    def get(self, request):
        queryset = MyModel.objects.all()
        paginated_queryset = self.paginate_queryset(queryset)
        serializer = MySerializer(paginated_queryset, many=True)
        return self.get_paginated_response(serializer.data)

2. 定制分页响应格式

可以通过继承 PageNumberPagination 类，并重写 get_paginated_response 方法来定制分页响应格式。

from rest_framework.response import Response
from rest_framework.pagination import PageNumberPagination

class MyPagination(PageNumberPagination):
    page_size = 20

    def get_paginated_response(self, data):
        return Response({
            'page': self.page.number,
            'page_size': self.page_size,
            'count': self.page.paginator.count,
            'results': data
        })

3. 游标分页

游标分页是一种更高效的分页形式，它使用数据库中的游标或偏移量来确定页码，而不是使用页码本身。这种分页适用于大型数据集，并且不会受到数据量增加的影响。

from rest_framework.pagination import CursorPagination

class MyPagination(CursorPagination):
    page_size = 20
    ordering = 'created_at'

    def get_paginated_response(self, data):
        return Response({
            'next': self.get_next_link(),
            'previous': self.get_previous_link(),
            'count': self.page.paginator.count,
            'results': data
        })

4. 处理无效的页码

可以通过设置 INVALID_PAGE_PARAMETER 参数来处理无效的页码请求。 例如，当请求的页码小于 1 或超过最大页码时，可以返回自定义的错误信息。

from rest_framework.exceptions import NotFound
from rest_framework.pagination import PageNumberPagination

class MyPagination(PageNumberPagination):
    page_size = 20
    invalid_page_message = 'Invalid page requested.'

    def paginate_queryset(self, queryset, request, view=None):
        page_number = request.query_params.get(self.page_query_param, 1)
        if page_number == '':
            page_number = 1
        try:
            self.page.number = self.page.paginator.validate_number(page_number)
        except InvalidPage as exc:
            msg = self.invalid_page_message.format(page_number=page_number)
            raise NotFound(msg)
        return self.page.paginator.get_page(self.page.number)

以上是 rest_framework.pagination 的高级用法与技巧的相关示例，可以根据实际需求进行定制和配置。