我正在try 找出添加注释字段的最佳方法,例如将任何聚合(计算)字段添加到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
},
...
]
我有几个可行的解决方案,但每个都有一些问题.
Option 1: add getters to model and use 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')
上面的代码也许可以重构一点,但它不会改变这样一个事实,即该选项将执行两个额外的SQL查询per IceCreamCompany,这不是很有效.
Option 2: annotate in ViewSet.get_queryset
模型.py as originally described.
意见.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不知道我已经在QuerySet中注释了这些字段.如果我将total_trucks和total_capacity添加到序列化程序中,它将抛出一个关于模型中不存在这些字段的错误.
通过使用View,选项2可以在没有序列化程序的情况下工作,但是如果模型包含很多字段,并且JSON中只需要一些字段,那么在没有序列化程序的情况下构建端点将是一种有点丑陋的攻击.