Django Rest Framework 3.1 中断 pagination.PaginationSerializer

Question

我刚刚更新到 Django Rest Framework 3.1，似乎一切都乱套了。

在我的 serializers.py 中，我有以下代码：

class TaskSerializer(serializers.ModelSerializer):
    class Meta:
    model = task
    exclude = ('key', ...)

class PaginatedTaskSerializer(pagination.PaginationSerializer):
    class Meta:
        object_serializer_class = TaskSerializer

工作正常。现在随着 3.1 的发布，我找不到关于如何做同样事情的例子，因为 PaginationSerializer 不再存在。我尝试子类化 PageNumberPagination 并使用其默认的 paginate_queryset 和 get_paginated_response 方法，但我无法再将它们的结果序列化。

换句话说，我的问题是我不能再这样做了：

class Meta:
    object_serializer_class = TaskSerializer

有什么想法吗？

提前致谢

Answer 1

我不确定这是否是完全正确的方法，但它适合我的需要。它使用 Django 分页器和自定义序列化程序。

这是我的视图 Class，它检索要序列化的对象

class CourseListView(AuthView):
    def get(self, request, format=None):
        """
        Returns a JSON response with a listing of course objects
        """
        courses = Course.objects.order_by('name').all()
        serializer = PaginatedCourseSerializer(courses, request, 25)
        return Response(serializer.data)

这是使用我的课程序列化程序的黑客组合序列化程序。

from django.core.paginator import Paginator, PageNotAnInteger, EmptyPage

class PaginatedCourseSerializer():
    def __init__(self, courses, request, num):
        paginator = Paginator(courses, num)
        page = request.QUERY_PARAMS.get('page')
        try:
            courses = paginator.page(page)
        except PageNotAnInteger:
            courses = paginator.page(1)
        except EmptyPage:
            courses = paginator.page(paginator.num_pages)
        count = paginator.count
    
        previous = None if not courses.has_previous() else courses.previous_page_number()
        next = None if not courses.has_next() else courses.next_page_number()
        serializer = CourseSerializer(courses, many=True)
        self.data = {'count':count,'previous':previous,
                 'next':next,'courses':serializer.data}

这给了我一个类似于旧分页器给出的行为的结果。

{
    "previous": 1,
    "next": 3,
    "courses": [...],
    "count": 384
}

希望对您有所帮助。我仍然认为必须有更好的方法来使用新的 API 来做到这一点，但它没有被很好地记录下来。如果我想出更多的东西，我会编辑我的 post.

编辑

我想我已经找到了一种更好、更优雅的方法来做到这一点，即创建我自己的自定义分页器以获得我以前使用旧的分页序列化器时获得的行为 class。

这是一个自定义分页器 class。我重载了响应和下一页方法以获得我想要的结果（即 ?page=2 而不是完整的 url）。

from rest_framework.response import Response
from rest_framework.utils.urls import replace_query_param

class CustomCoursePaginator(pagination.PageNumberPagination):
    def get_paginated_response(self, data):
        return Response({'count': self.page.paginator.count,
                         'next': self.get_next_link(),
                         'previous': self.get_previous_link(),
                         'courses': data})

    def get_next_link(self):
        if not self.page.has_next():
            return None
        page_number = self.page.next_page_number()
        return replace_query_param('', self.page_query_param, page_number)

    def get_previous_link(self):
        if not self.page.has_previous():
            return None
        page_number = self.page.previous_page_number()
        return replace_query_param('', self.page_query_param, page_number)

那么我的课程视图与您实现它的方式非常相似，只是这次使用了自定义分页器。

class CourseListView(AuthView):
    def get(self, request, format=None):
        """
        Returns a JSON response with a listing of course objects
        """
        courses = Course.objects.order_by('name').all()
        paginator = CustomCoursePaginator()
        result_page = paginator.paginate_queryset(courses, request)
        serializer = CourseSerializer(result_page, many=True)
        return paginator.get_paginated_response(serializer.data)

现在我得到了我想要的结果。

{
    "count": 384,
    "next": "?page=3",
    "previous": "?page=1",
    "courses": []
}

我仍然不确定这对 Browsable 是如何工作的 API（我不使用 drf 的这个功能）。我认为您也可以为此创建自己的自定义 class。希望对您有所帮助！

Answer 2

我想我明白了（至少在很大程度上）：

我们一开始应该用的是这个：

只需使用内置分页器并将您的 views.py 更改为：

from rest_framework.pagination import PageNumberPagination

class CourseListView(AuthView):
    def get(self, request, format=None):
        """
        Returns a JSON response with a listing of course objects
        """
        courses = Course.objects.order_by('name').all()
        paginator = PageNumberPagination()
        # From the docs:
        # The paginate_queryset method is passed the initial queryset 
        # and should return an iterable object that contains only the 
        # data in the requested page.
        result_page = paginator.paginate_queryset(courses, request)
        # Now we just have to serialize the data just like you suggested.
        serializer = CourseSerializer(result_page, many=True)
        # From the docs:
        # The get_paginated_response method is passed the serialized page 
        # data and should return a Response instance.
        return paginator.get_paginated_response(serializer.data)

对于所需的页面大小，只需在 settings.py 中设置 PAGE_SIZE:

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 15
}

您现在应该已经准备就绪，响应正文中的所有选项（计数、下一个和后退链接）都按照更新前的顺序排列。

然而还有一件事仍然困扰着我：我们也应该能够得到新的 html pagination controls，但由于某种原因现在丢失了...

我绝对可以在这方面使用更多建议...

Answer 3

我意识到自发布这篇文章以来已经过去了一年多，但希望这对其他人有所帮助。对我类似问题的回答是我的解决方案。我正在使用 DRF 3.2.3。

Django Rest Framework 3.2.3 pagination not working for generics.ListCreateAPIView

看到它是如何实现的，我得到了获得分页和可见控件所需的解决方案 API。

https://github.com/tomchristie/django-rest-framework/blob/master/rest_framework/mixins.py#L39

Django Rest Framework 3.1 中断 pagination.PaginationSerializer

Django Rest Framework 3.1 breaks pagination.PaginationSerializer

python

django

pagination

django-pagination

django-rest-framework

编辑