Django:通过排序的SerializerMethodField进行分页

时间:2014-11-04 21:42:55

标签: django pagination django-rest-framework

我遇到了对rest_framework SerializerMethodField排序的json数据进行分页的问题。在我开始向列表视图添加分页之前,我将排序的json数据放在上下文变量中,如下所示:

class ExampleList(ListView):
    ...
    def get_context_data(self, **kwargs):
        context = super(ExampleList, self).get_context_data(**kwargs)
        context["examples"] = sorted(ExampleSerializer(
            submissions, many=True, context={'request': self.request}
        ).data, key=lambda x: x.get("score"), reverse=True)
        return context
    ...

这非常有效,因为lambda函数抓住了分数,并按其排序,正是sorted()应该如何工作。问题始于分页。我已经研究了几天了,而且我找不到任何json数据分页的方法。仅限查询集。

当我开始分页时,这是我的两个序列化程序类:

class ExampleSerializer(serializers.ModelSerializer):
    score = serializers.SerializerMethodField('get_score')

    class Meta:
        model = Example
        fields = ('id', '...', 'score',)

    def get_score(self, obj):
        return obj.calculate_score()

class PaginatedExampleSerializer(pagination.PaginationSerializer):
    class Meta:
        object_serializer_class = ExampleSerializer

在我的一个列表视图中,我创建了一个排序的上下文对象,它按score对序列化数据进行排序并对其进行分页。我也创建了一个调用分页{J} paginate_examples()的方法。如您所见,它首先按查询集分页,然后在每个分页页面上按score对数据进行排序。因此,应该在第1页上的内容可以追溯到第5页左右。

class ExampleList(ListView):
    queryset = Example.objects.all()

    def paginate_examples(self, queryset, paginate_by):
        paginator = Paginator(queryset, paginate_by)
        page = self.request.GET.get('page')
        try:
            examples = paginator.page(page)
        except PageNotAnInteger:
            examples = paginator.page(1)
        except EmptyPage:
            examples = paginator.page(paginator.num_pages)

        return PaginatedExampleSerializer(examples, context={'request': self.request}).data

    def get_context_data(self, **kwargs):
        context = super(ExampleList, self).get_context_data(**kwargs)

        pagination = self.paginate_examples(self.queryset, self.paginate_by)
        examples = pagination.get("results")
        context["examples"] = sorted(examples, key=lambda x: x.get("score"), reverse=True)
        context["pagination"] = pagination
        return context

同样,问题是应该在/?page=1上显示的列表项显示在/?page=x上,因为PaginatedExampleSerializer在数据按SerializerMethodField排序之前对数据进行分页。

有没有办法对已经序列化的数据进行分页,而不是由Django中的queryset进行分页?或者我将不得不自己创建一些方法?我想避免使score成为数据库字段,但如果我无法找到解决方案,那么我想我必须这样做。 对此的任何帮助将不胜感激。

1 个答案:

答案 0 :(得分:1)

有一个较晚的答案,但可能会帮助在这里找到自己的人。

我遇到一个类似的问题,我需要在输出中组合两个单独的模型,在两个模型中选择最后一个项目,并进行分页和排序。我发现OrdereringFilter超出了我的期望,因此选择默认顺序,但是OrderingFilter也应该适用。

基本方法是确定通过database functionsaggregate functionannotate由串行器计算的字段的方式。

from rest_framework.pagination import LimitOffsetPagination
from rest_framework.generics import ListAPIView
from django.db.models import Q, Count, Avg
from django.db.models.functions import Greatest

class ExampleListViewPagination(LimitOffsetPagination):
    default_limit = 10

class ExampleSerializer(serializers.ModelSerializer):
    
    def get_last_message_and_score(self, obj):
        # added to obj via the view get_queryset annotate
        return {
          "last_message": self.get_last_comment_or_file(),
          "last_message_time": obj.last_message_time,
          "score": obj.score
         }

    class Meta:
        model = Example
        fields = ('id', '...', 'last_message_and_score',)

class ExampleList(ListAPIView):
    serializer_class = ExampleSerializer
    pagination_class = ExampleListViewPagination

    def get_queryset(self):
        # the annotation here is being used for the pagination to work
        # on last_message_time, and hypothetical calculate_score
        # both descending
        qs = (
            Example.objects.filter(
                Q(item__parent__users=self.get_user())
                & (
                    Q(last_read_by_user=None)
                    | Q(last_read_by_user__lte=timezone.now())
                )
            )
            .exclude(
                Q(user_comments__isnull=True) 
                & Q(user_files__user_item_files__isnull=True)
            )
            .annotate(
                last_message_time=Greatest(
                    "user_comments__created",
                    "user_files__user_item_files__created",
                ),
                score=Avg(Count("user_comments"), Count("user_files__user_item_files")),
                )
            )
            .distinct()
            .order_by("-last_message_time", "-score")
        )
        return qs

注意事项之一是prefetch_related和select_related也许可以稍微优化查询。

我尝试探索的其他选项之一是基于在paginate_queryset上覆盖rest_framework.pagination.LimitOffsetPagination来在数据库查询和queryset之外进行分页,但是发现注释更容易。