DRF中如何从OrderedProduct序列化关联的ProductImage图片？

现有表结构中，Product为主表，ProductImage和OrderedProduct均通过外键关联至Product。需要从OrderedProduct中获取关联Product对应的图片，以下是具体实现方案：

现有Model代码 #

class Product(models.Model):
    name = models.CharField(max_length=50)
    description = models.TextField()
    def __str__(self) -> str:
        return self.name


class ProductImage(models.Model):
    product = models.ForeignKey(
        Product, on_delete=models.CASCADE, related_name='product_images')
    image = models.ImageField(upload_to="images/", null=True, blank=True)

class OrderedProduct(models.Model):
    product = models.ForeignKey(
        Product, on_delete=models.CASCADE, related_name='ordered_products')
    quantity = models.IntegerField()

现有Serializer代码 #

class OrderedProductSerializer(serializers.ModelSerializer):
    product_name = serializers.CharField(source='product.name')
    product_price = serializers.FloatField(source='product.price')
    # product_img = >>> what should I do here? <<<

    class Meta:
        model = OrderedProduct
        fields = ('product', 'quantity',
                  'product_name', 'product_price', 'product_img')

解决方案 #

根据Product对应图片数量的需求，分两种场景处理：

场景1：仅需获取单张图片（如第一张） #

方式1：使用SerializerMethodField自定义逻辑

通过自定义方法获取关联Product的首张图片URL，无图片时返回None：

class OrderedProductSerializer(serializers.ModelSerializer):
    product_name = serializers.CharField(source='product.name')
    # 注意：原Product模型无price字段，需补全模型字段或删除该序列化字段
    # product_price = serializers.FloatField(source='product.price')
    product_img = serializers.SerializerMethodField()

    def get_product_img(self, obj):
        # 获取关联Product的第一张图片
        first_image = obj.product.product_images.first()
        if first_image and first_image.image:
            # 生成图片的完整访问URL
            return self.context['request'].build_absolute_uri(first_image.image.url)
        return None

    class Meta:
        model = OrderedProduct
        fields = ('product', 'quantity', 'product_name', 'product_img')

方式2：直接通过source关联字段

如果确定每个Product仅对应一张图片，可直接通过关联路径取值：

class OrderedProductSerializer(serializers.ModelSerializer):
    product_name = serializers.CharField(source='product.name')
    product_img = serializers.ImageField(source='product.product_images.first.image', allow_null=True)

    class Meta:
        model = OrderedProduct
        fields = ('product', 'quantity', 'product_name', 'product_img')

场景2：需要获取Product的所有图片 #

先定义ProductImage的序列化器，再嵌套到OrderedProductSerializer中：

1. 定义ProductImage序列化器

class ProductImageSerializer(serializers.ModelSerializer):
    image_url = serializers.SerializerMethodField()

    def get_image_url(self, obj):
        if obj.image:
            return self.context['request'].build_absolute_uri(obj.image.url)
        return None

    class Meta:
        model = ProductImage
        fields = ('image_url',)

2. 修改OrderedProduct序列化器

class OrderedProductSerializer(serializers.ModelSerializer):
    product_name = serializers.CharField(source='product.name')
    product_imgs = ProductImageSerializer(source='product.product_images', many=True)

    class Meta:
        model = OrderedProduct
        fields = ('product', 'quantity', 'product_name', 'product_imgs')

注意事项 #

• 确保Django项目已正确配置MEDIA_URL和MEDIA_ROOT，开发环境需添加媒体文件的访问路由。
• 原Product模型中无price字段，需补全模型字段或删除序列化器中的product_price字段，否则会抛出字段不存在的错误。

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