使用rest_framework.pagination实现多级分页效果

Django REST framework（简称DRF）是一个强大的Web框架，可用于构建和发布Web API。它提供了许多内置功能，其中包括对分页的支持。DRF的分页功能非常灵活，可以轻松地实现多级分页效果。

在DRF中，分页功能是通过使用rest_framework.pagination模块来实现的。这个模块提供了一些内置分页类，例如PageNumberPagination、LimitOffsetPagination和CursorPagination，可以用于根据特定的分页策略对查询结果进行分页。

下面是一个使用PageNumberPagination实现多级分页效果的例子：

首先，在你的Django项目中创建一个新的文件，例如pagination.py，并在其中导入DRF的分页类和其他必要的模块：

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

然后，定义一个继承自PageNumberPagination的分页类，并根据需要进行定制。在这个例子中，我们将展示三级分页效果，其中每页显示10个对象， 级分页显示5个页码，第二级分页显示10个页码，第三级分页显示15个页码：

class CustomPagination(PageNumberPagination):
    page_size = 10
    page_size_query_param = 'page_size'
    max_page_size = 100

    def get_paginated_response(self, data):
        current_page = self.page.number
        total_pages = self.page.paginator.num_pages

        #       级分页
        level_1_pages = list(range(1, total_pages + 1, 5))

        # 第二级分页
        level_2_pages = []
        for page in level_1_pages:
            if current_page <= page + 5 and current_page >= page - 5:
                level_2_pages = list(
                    range(max(1, page - 5), min(total_pages + 1, page + 6))
                )
                break

        # 第三级分页
        level_3_pages = []
        for page in level_2_pages:
            if current_page <= page + 3 and current_page >= page - 3:
                level_3_pages = list(
                    range(max(1, page - 7), min(total_pages + 1, page + 8))
                )
                break

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

在这个示例中，我们自定义了一个名为CustomPagination的分页类，并设置了每页显示10个对象，默认页面大小参数为page_size，最大页面大小为100。get_paginated_response方法用于返回包含分页信息的响应。

在get_paginated_response方法中，我们首先获取当前页码current_page和总页码数total_pages。然后，根据分页级别，计算并返回相应的页码列表。

最后，在视图中使用CustomPagination分页类来分页查询结果。假设有一个名为ExampleViewSet的视图集：

from rest_framework.viewsets import ModelViewSet

from .pagination import CustomPagination
from .models import Example
from .serializers import ExampleSerializer

class ExampleViewSet(ModelViewSet):
    queryset = Example.objects.all()
    serializer_class = ExampleSerializer
    pagination_class = CustomPagination

在这个示例中，我们通过设置pagination_class属性来指定使用CustomPagination来对查询结果进行分页处理。这样，当你访问该API视图时，将以多级分页效果返回结果。

综上所述，我们使用rest_framework.pagination模块可以方便地实现多级分页效果。通过继承内置的分页类，并在自定义分页类中重写相应的方法，我们可以根据具体需求定制分页策略，并在视图中应用它。这样，我们可以在DRF的API中实现灵活且符合需求的分页功能。