在Django Rest Framework中实现多对多嵌套关系列表

嘿，我刚好处理过类似手动维护多对多关联表的场景，给你分享几种实用的实现方式，尤其是能避免N+1查询的优化方案！

首先先明确下我们的模型结构（假设你的手动关联表叫TaskContact）：

class Contact(models.Model):
    name = models.CharField(max_length=100)
    # 其他自定义字段

class Task(models.Model):
    title = models.CharField(max_length=200)
    # 其他自定义字段

class TaskContact(models.Model):
    task = models.ForeignKey(Task, on_delete=models.CASCADE, related_name='task_contacts')
    contact = models.ForeignKey(Contact, on_delete=models.CASCADE, related_name='contact_tasks')
    # 可选：添加共享时间、权限等额外字段

方案1：使用SerializerMethodField（基础实现） #

这应该是你可能已经在用的方式，通过自定义方法手动查询关联的Contacts：

from rest_framework import serializers

class ContactSerializer(serializers.ModelSerializer):
    class Meta:
        model = Contact
        fields = ['id', 'name']  # 按需选择需要返回的字段

class TaskSerializer(serializers.ModelSerializer):
    # 自定义字段名，用来返回共享的联系人列表
    shared_contacts = serializers.SerializerMethodField()

    class Meta:
        model = Task
        fields = ['id', 'title', 'shared_contacts']

    def get_shared_contacts(self, obj):
        # 通过Contact的反向关联查询当前Task对应的所有联系人
        contacts = Contact.objects.filter(contact_tasks__task=obj)
        return ContactSerializer(contacts, many=True).data

方案2：结合Prefetch优化性能（推荐） #

上面的基础方案会存在N+1查询问题（每个Task都要单独查一次关联的Contacts），我们可以用Django的Prefetch来预取关联数据，大幅提升接口性能：

步骤1：修改Serializer #

class ContactSerializer(serializers.ModelSerializer):
    class Meta:
        model = Contact
        fields = ['id', 'name']

class TaskSerializer(serializers.ModelSerializer):
    shared_contacts = serializers.SerializerMethodField()

    class Meta:
        model = Task
        fields = ['id', 'title', 'shared_contacts']

    def get_shared_contacts(self, obj):
        # 直接从预取的关联对象中提取Contact，避免重复查询
        contacts = [task_contact.contact for task_contact in obj.task_contacts.all()]
        return ContactSerializer(contacts, many=True).data

步骤2：在视图中配置预取 #

from rest_framework.generics import ListAPIView
from django.db.models import Prefetch

class TaskListView(ListAPIView):
    queryset = Task.objects.all().prefetch_related(
        # 预取TaskContact关联表，同时关联查询对应的Contact
        Prefetch('task_contacts', queryset=TaskContact.objects.select_related('contact'))
    )
    serializer_class = TaskSerializer

方案3：返回关联表的额外字段（如果有） #

如果你的手动关联表有额外字段（比如shared_at共享时间、permission权限），可以直接序列化关联表对象，同时包含Contact信息：

class ContactSerializer(serializers.ModelSerializer):
    class Meta:
        model = Contact
        fields = ['id', 'name']

class TaskContactSerializer(serializers.ModelSerializer):
    contact = ContactSerializer()
    # 序列化关联表的额外字段
    shared_at = serializers.DateTimeField()

    class Meta:
        model = TaskContact
        fields = ['contact', 'shared_at']

class TaskSerializer(serializers.ModelSerializer):
    # 直接使用关联表的related_name来序列化
    shared_contacts_with_details = TaskContactSerializer(source='task_contacts', many=True)

    class Meta:
        model = Task
        fields = ['id', 'title', 'shared_contacts_with_details']

这样就能在Task接口中返回包含共享详情的联系人列表啦！

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