17

我刚刚更新到 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

有任何想法吗？

提前致谢

4

3 回答 3

23

我想我想通了（至少在大多数情况下）：

我们应该从一开始就使用的是：

只需使用内置分页器并将您的更改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)

对于所需的页面大小，只需设置PAGE_SIZEin settings.py：

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

您现在应该设置好响应正文中存在的所有选项（计数、下一个和返回链接），就像更新之前一样。

然而，还有一件事仍然困扰着我：我们还应该能够获得新的html 分页控件，由于某种原因，这些控件现在已经丢失了……

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

于 2015-03-19T12:36:53.843 回答
12

我不确定这是否是完全正确的方法，但它可以满足我的需要。它使用 Django Paginator 和自定义序列化程序。

这是我的视图类，它检索对象以进行序列化

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)

这是使用我的 Course 序列化器的组合序列化器。

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 来做到这一点，但它只是没有很好地记录下来。如果我想出更多的东西，我会编辑我的帖子。

编辑

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

这是一个自定义分页器类。我重载了响应和下一页方法以获得我想要的结果（即?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 的这个功能）。我认为您也可以为此创建自己的自定义类。我希望这有帮助！

于 2015-03-19T01:38:53.017 回答
0

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

Django Rest Framework 3.2.3 分页不适用于 generics.ListCreateAPIView

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

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

于 2016-04-15T17:45:29.287 回答