Django Serializer中如何聚合自定义方法计算旅行总天数

需求 #

计算某一旅行的总天数。每个旅行可包含多个时长不同的行程段（Leg），已通过自定义方法total_days计算出单个行程段的天数，现需汇总指定旅行下所有行程段的天数。

现有代码 #

模型定义 #

class Trip(models.Model):
    name = models.CharField(max_length=140)

 
class Leg(models.Model):
    trip_name = models.ForeignKey(Trip, on_delete=models.PROTECT)
    depature_date = models.DateField()
    arrival_date = models.DateField()
  
    def total_days(self):
      return ((self.arrival_date - self.depature_date).days) + 1 

序列化器定义 #

class Trip_Serializer(serializers.ModelSerializer):
    total_no_of_days = serializers.SerializerMethodField()

    class Meta:
        model = Trip 
        fields = ['id', 'name', 'total_no_of_days']

    def get_total_no_of_days(self, instance):
        return Leg.objects.filter(trip_name=instance.id).aggregate(Sum('total_days'))



class Leg_Full_Serializer(serializers.ModelSerializer):

    class Meta:
        model = Leg
        fields = [ 'id', 'trip_name', 'depature_date', 'arrival_date' , 'total_days' ]

视图定义 #

class Trip_List (ListAPIView):
    serializer_class = Trip_Serializer

    def get_queryset(self):
      return Trip.objects.filter(user=self.request.user).order_by("-id")

当前问题 #

不清楚如何在Trip_Serializer中使用total_days自定义方法来计算旅行总天数。

解决方案 #

原代码的问题在于：total_days是Leg模型的自定义方法，并非数据库字段，所以Django ORM的Sum聚合函数无法直接对其进行操作。这里提供两种可行的解决方式：

方式一：遍历行程段求和（简单直观） #

直接遍历当前旅行下的所有Leg实例，调用每个实例的total_days方法后累加求和，适合数据量不大的场景：

修改Trip_Serializer中的get_total_no_of_days方法：

def get_total_no_of_days(self, instance):
    # 利用生成器表达式简洁求和
    return sum(leg.total_days() for leg in instance.leg_set.all())

或者用更易懂的循环写法：

def get_total_no_of_days(self, instance):
    total = 0
    for leg in instance.leg_set.all():
        total += leg.total_days()
    return total

方式二：数据库层面聚合计算（性能更优） #

如果旅行和行程段数据量较大，建议在数据库层面完成计算，减少Python层面的遍历开销。通过annotate结合表达式，把total_days的逻辑搬到ORM查询中：

步骤1：修改视图的查询集

from django.db.models import F, Sum, ExpressionWrapper, IntegerField

class Trip_List (ListAPIView):
    serializer_class = Trip_Serializer

    def get_queryset(self):
        return Trip.objects.filter(user=self.request.user).annotate(
            total_no_of_days=Sum(
                # 计算单个行程段的天数：(到达日期-出发日期).days +1
                ExpressionWrapper(
                    F('leg__arrival_date') - F('leg__depature_date'), 
                    output_field=IntegerField()
                ) + 1
            )
        ).order_by("-id")

步骤2：简化序列化器

此时total_no_of_days已经是Trip查询集的注解字段，无需再用SerializerMethodField：

class Trip_Serializer(serializers.ModelSerializer):
    total_no_of_days = serializers.IntegerField(read_only=True)

    class Meta:
        model = Trip 
        fields = ['id', 'name', 'total_no_of_days']

内容的提问来源于stack exchange，提问作者Mark