Django Rest Framework 序列化器中的聚合（和其他带注释的）字段

我正在尝试找出添加带注释字段的最佳方法，例如将任何聚合（计算）字段添加到 DRF（模型）序列化器。我的用例只是一种情况，端点返回的字段未存储在数据库中，而是从数据库计算得出。

让我们看下面的例子：

模型.py

class IceCreamCompany(models.Model):
    name = models.CharField(primary_key = True, max_length = 255)

class IceCreamTruck(models.Model):
    company = models.ForeignKey('IceCreamCompany', related_name='trucks')
    capacity = models.IntegerField()

序列化器.py

class IceCreamCompanySerializer(serializers.ModelSerializer):
    class Meta:
        model = IceCreamCompany

所需的 JSON 输出：

[

    {
        "name": "Pete's Ice Cream",
        "total_trucks": 20,
        "total_capacity": 4000
    },
    ...
]

我有几个有效的解决方案，但每个都有一些问题。

选项 1：向模型添加 getter 并使用 SerializerMethodFields

模型.py

class IceCreamCompany(models.Model):
    name = models.CharField(primary_key=True, max_length=255)

    def get_total_trucks(self):
        return self.trucks.count()

    def get_total_capacity(self):
        return self.trucks.aggregate(Sum('capacity'))['capacity__sum']

序列化器.py

class IceCreamCompanySerializer(serializers.ModelSerializer):

    def get_total_trucks(self, obj):
        return obj.get_total_trucks

    def get_total_capacity(self, obj):
        return obj.get_total_capacity

    total_trucks = SerializerMethodField()
    total_capacity = SerializerMethodField()

    class Meta:
        model = IceCreamCompany
        fields = ('name', 'total_trucks', 'total_capacity')

上面的代码或许可以稍微重构一下，但这不会改变这个选项将执行 2 个额外 SQL 查询的事实根据冰淇淋公司这不是很有效。

选项2：在ViewSet.get_queryset中注释

models.py 如最初所述。

views.py

class IceCreamCompanyViewSet(viewsets.ModelViewSet):
    queryset = IceCreamCompany.objects.all()
    serializer_class = IceCreamCompanySerializer

    def get_queryset(self):
        return IceCreamCompany.objects.annotate(
            total_trucks = Count('trucks'),
            total_capacity = Sum('trucks__capacity')
        )

这将在单个 SQL 查询中获取聚合字段，但我不确定如何将它们添加到序列化器中，因为 DRF 不会神奇地知道我已在查询集中注释了这些字段。如果我将total_trucks和total_capacity添加到序列化器中，它将抛出有关模型上不存在这些字段的错误。

通过使用选项 2 可以在没有序列化器的情况下工作View http://www.django-rest-framework.org/api-guide/views/但是如果模型包含很多字段，并且只需要其中一些字段位于 JSON 中，那么在没有序列化器的情况下构建端点将是一个有点丑陋的黑客行为。

可能的解决方案：

views.py

class IceCreamCompanyViewSet(viewsets.ModelViewSet):
    queryset = IceCreamCompany.objects.all()
    serializer_class = IceCreamCompanySerializer

    def get_queryset(self):
        return IceCreamCompany.objects.annotate(
            total_trucks=Count('trucks'),
            total_capacity=Sum('trucks__capacity')
        )

序列化器.py

class IceCreamCompanySerializer(serializers.ModelSerializer):
    total_trucks = serializers.IntegerField()
    total_capacity = serializers.IntegerField()

    class Meta:
        model = IceCreamCompany
        fields = ('name', 'total_trucks', 'total_capacity')

通过使用序列化器字段 http://www.django-rest-framework.org/api-guide/fields/我有一个小例子可以工作。这些字段必须声明为序列化器的类属性，以便 DRF 不会抛出有关它们在 IceCreamCompany 模型中不存在的错误。