在Django REST Framework中实现多层关联及多对多关系序列化

1. 从最底层模型编写序列化器 #

先定义最内层的Option和Question序列化器，确保每个Question能嵌套关联的Option集合：

from rest_framework import serializers
from .models import Client, Box, Product, Question, Option, BoxContent

class OptionSerializer(serializers.ModelSerializer):
    class Meta:
        model = Option
        fields = '__all__'  # 也可指定具体字段，比如'id', 'text'

class QuestionSerializer(serializers.ModelSerializer):
    options = OptionSerializer(many=True, read_only=True)

    class Meta:
        model = Question
        fields = '__all__'  # 或指定字段如'id', 'title', 'options'

2. 编写Product序列化器，嵌套Question集合 #

让Product序列化器包含其关联的Question数据：

class ProductSerializer(serializers.ModelSerializer):
    questions = QuestionSerializer(many=True, read_only=True)

    class Meta:
        model = Product
        fields = '__all__'  # 或指定字段如'id', 'name', 'questions'

3. 处理Box与Product的多对多关联 #

因为两者通过BoxContent中间表关联，分两种场景处理：

场景一：中间表无额外字段

直接利用DRF的source参数通过反向关联获取Product：

class BoxSerializer(serializers.ModelSerializer):
    products = ProductSerializer(many=True, read_only=True, source='boxcontent_set.product')

    class Meta:
        model = Box
        fields = '__all__'  # 或指定字段如'id', 'name', 'products'

场景二：中间表有额外字段（如数量）

用SerializerMethodField自定义逻辑，同时携带中间表数据：

class BoxSerializer(serializers.ModelSerializer):
    products = serializers.SerializerMethodField()

    def get_products(self, obj):
        box_contents = obj.boxcontent_set.all()
        product_list = []
        for bc in box_contents:
            product_data = ProductSerializer(bc.product).data
            # 若中间表有额外字段，比如quantity，可追加到数据中
            # product_data['quantity'] = bc.quantity
            product_list.append(product_data)
        return product_list

    class Meta:
        model = Box
        fields = '__all__'

4. 编写顶层Client序列化器，嵌套Box集合 #

最后定义Client序列化器，包含已嵌套完整关联数据的Box集合：

class ClientSerializer(serializers.ModelSerializer):
    box_set = BoxSerializer(many=True, read_only=True)

    class Meta:
        model = Client
        fields = '__all__'  # 或指定字段如'id', 'name', 'box_set'

5. 调整API视图使用新序列化器 #

在api_views.py中替换为新的序列化器，比如：

from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Client
from .serializers import ClientSerializer

class ClientDetailView(APIView):
    def get(self, request, pk):
        client = Client.objects.get(pk=pk)
        serializer = ClientSerializer(client)
        return Response(serializer.data)

class ClientListView(APIView):
    def get(self, request):
        clients = Client.objects.all()
        serializer = ClientSerializer(clients, many=True)
        return Response(serializer.data)

关键注意点 #

• 嵌套序列化必须从最内层到最外层定义，否则DRF无法识别关联关系
• 若模型反向关联名称不是默认的xxx_set，需要替换为模型中related_name指定的名称
• 如果需要支持写入操作（POST/PUT），需额外重写序列化器的create/update方法处理嵌套数据的保存逻辑

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