Django 如何序列化关联Gallery的相册首张图片作为画廊列表封面

可行实现方案 #

你猜想的Gallery.objects.get(id=id).photos.first()写法本身是可以拿到单个相册的首张图片的，但如果是画廊列表场景直接用会产生N+1查询问题，性能极差，以下是不同场景的适配方案：

方案1：SerializerMethodField 实现（小数据量场景） #

这是最直接的实现方式，直接在序列化器中定义方法取首张图：

from rest_framework import serializers
from .models import Gallery, GalleryImage

class GalleryListSerializer(serializers.ModelSerializer):
    cover = serializers.SerializerMethodField()
    
    class Meta:
        model = Gallery
        fields = ('id', 'title', 'cover')
    
    def get_cover(self, obj):
        first_photo = obj.photos.first()
        return first_photo.photo.url if first_photo else None

注意：配套视图的查询集一定要加prefetch_related预加载关联的图片数据，避免N+1查询：

# 视图查询集写法
queryset = Gallery.objects.all().prefetch_related('photos')

方案2：模型层封装Property（多场景复用） #

如果多个地方都需要用到封面字段，可以把逻辑封装到Gallery模型中，减少重复代码：

class Gallery(models.Model):
    title = models.CharField()

    @property
    def cover_url(self):
        first_photo = self.photos.first()
        return first_photo.photo.url if first_photo else None

序列化器直接引用该字段即可：

class GalleryListSerializer(serializers.ModelSerializer):
    cover = serializers.CharField(source='cover_url', read_only=True)
    
    class Meta:
        model = Gallery
        fields = ('id', 'title', 'cover')

同样需要在视图查询集加prefetch_related('photos')优化性能。

方案3：查询注解实现（大数据量高性能场景） #

如果画廊列表数据量很大，预加载所有图片还是会浪费性能，可以用Subquery直接在查询数据库时就把封面地址注解出来，不用加载多余的图片数据：

from django.db.models import OuterRef, Subquery

# 视图查询集写法
photo_subquery = GalleryImage.objects.filter(gallery_id=OuterRef('pk')).values('photo')[:1]
queryset = Gallery.objects.annotate(
    cover=Subquery(photo_subquery)
).all()

序列化器直接映射注解的cover字段即可：

class GalleryListSerializer(serializers.ModelSerializer):
    cover = serializers.ImageField(read_only=True)
    
    class Meta:
        model = Gallery
        fields = ('id', 'title', 'cover')

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