django - Django Rest框架在SerializerMethodField上的排序

Question

我有一个论坛主题模型，需要在计算的SerializerMethodField上订购，例如vote_count。这是一个非常简化的Model，Serializer和ViewSet来显示问题:

# models.py
class Topic(models.Model):
    """
    An individual discussion post in the forum
    """
    title = models.CharField(max_length=60)

    def vote_count(self):
        """
        count the votes for the object
        """
        return TopicVote.objects.filter(topic=self).count()


# serializers.py
class TopicSerializer(serializers.ModelSerializer):
    vote_count = serializers.SerializerMethodField()

    def get_vote_count(self, obj):
        return obj.vote_count()

    class Meta:
        model = Topic


# views.py
class TopicViewSet(TopicMixin, viewsets.ModelViewSet):
    queryset = Topic.objects.all()
    serializer_class = TopicSerializer

这是有效的方法:

OrderingFilter默认情况下处于启用状态，我可以成功订购/topics?ordering=title

的vote_count功能可以完美运行

我正在尝试按TopicSerializer上的MethodField进行排序，例如/topics?ordering=-vote_count的vote_count，但似乎不支持。我可以通过该字段订购什么方法？

我的简化JSON响应如下所示:

{
    "id": 1,
    "title": "first post",
    "voteCount": 1
},
{ 
    "id": 2,
    "title": "second post",
    "voteCount": 8
},
{ 
    "id": 3,
    "title": "third post",
    "voteCount": 4
}

我正在使用Ember消耗我的API，并且解析器将其转换为camelCase。我也尝试过ordering = voteCount，但这不起作用(而且不应该)

Answer 1

使用the default OrderingFilter 是不可能的，因为排序是在数据库端实现的。这是出于效率方面的考虑，因为手动对结果进行排序可能会非常慢，并且意味着会违反标准QuerySet。通过将所有内容都保留为QuerySet，您将受益于Django REST框架提供的内置过滤(通常需要QuerySet)和内置分页(如果没有一个，可能会很慢)。

现在，在这些情况下，您有两个选择:弄清楚如何在数据库端检索值，或尝试使对性能的影响最小化。由于后一个选项是非常特定于实现的，因此我现在将略过它。

在这种情况下，您可以使用Django提供的the Count function在数据库端进行计数。这是作为the aggregation API的一部分提供的，类似于the SQL COUNT function。您可以通过将 View 上的Count修改为等效的queryset调用

queryset = Topic.objects.annotate(vote_count=Count('topicvote_set'))

用your topicvote_set for the field替换related_name(您有一套，对吧？)。这将使您可以根据投票数对结果进行排序，甚至可以进行过滤(如果需要)，因为它可以在查询本身中使用。

这将需要对序列化器进行一些更改，因此它从对象上可用的新vote_count属性中提取。

class TopicSerializer(serializers.ModelSerializer):
    vote_count = serializers.IntegerField(read_only=True)

    class Meta:
        model = Topic

这将覆盖现有的vote_count方法，因此您可能需要重命名注释时使用的变量(如果无法替换旧方法)。

另外，您可以将方法名称作为Django REST框架字段的source传递，它将自动调用它。因此从技术上讲，您当前的序列化器可能只是

class TopicSerializer(serializers.ModelSerializer):
    vote_count = serializers.IntegerField(read_only=True)

    class Meta:
        model = Topic

它的工作原理与当前完全相同。请注意，这种情况下需要read_only，因为方法与属性不同，因此无法设置该值。