如何用单个序列化器更新Store实例及其关联模型字段

1. 编写自定义序列化器 #

创建StoreUpdateSerializer，负责验证请求数据格式、处理Store及关联模型的更新逻辑：

from rest_framework import serializers
from .models import Store, AmazonStore, AliStore

class StoreUpdateSerializer(serializers.ModelSerializer):
    class Meta:
        model = Store
        fields = ['name']

    def validate(self, attrs):
        # 判断请求数据的店铺类型
        request = self.context['request']
        has_amazon = 'AmazonConnectOptions' in request.data
        has_ali = 'AliConnectOptions' in request.data

        # 互斥检查：不能同时提交两种类型数据
        if has_amazon and has_ali:
            raise serializers.ValidationError("仅支持单类型店铺数据更新")
        if not has_amazon and not has_ali:
            raise serializers.ValidationError("必须提交Amazon或Ali类型的店铺配置")

        # 验证对应类型的数据结构
        if has_amazon:
            amazon_data = request.data['AmazonConnectOptions']
            if not isinstance(amazon_data, dict) or 'name' not in amazon_data or 'ApiKey' not in amazon_data:
                raise serializers.ValidationError("AmazonConnectOptions需包含name和ApiKey字段")
            attrs['amazon_data'] = amazon_data
        else:
            ali_data = request.data['AliConnectOptions']
            if not isinstance(ali_data, dict) or 'name' not in ali_data or 'ApiKey' not in ali_data:
                raise serializers.ValidationError("AliConnectOptions需包含name和ApiKey字段")
            attrs['ali_data'] = ali_data

        return attrs

    def update(self, instance, validated_data):
        # 更新Store的name字段，并处理关联模型的API Key
        if 'amazon_data' in validated_data:
            data = validated_data.pop('amazon_data')
            instance.name = data['name']
            instance.save()
            # 存在则更新，不存在则创建关联的AmazonStore
            amazon_store, _ = AmazonStore.objects.get_or_create(store=instance)
            amazon_store.amazon_api_key = data['ApiKey']
            amazon_store.save()
        else:
            data = validated_data.pop('ali_data')
            instance.name = data['name']
            instance.save()
            # 存在则更新，不存在则创建关联的AliStore
            ali_store, _ = AliStore.objects.get_or_create(store=instance)
            ali_store.ali_api_key = data['ApiKey']
            ali_store.save()

        return instance

2. 调整ViewSet的update方法 #

确保序列化器能获取到request对象（用于读取外层的类型字段），并调用序列化器的更新逻辑：

from rest_framework import viewsets, mixins
from .models import Store
from .serializers import StoreUpdateSerializer

class StoreViewSet(mixins.CreateModelMixin, mixins.ListModelMixin, mixins.UpdateModelMixin, viewsets.GenericViewSet):
    queryset = Store.objects.all()
    serializer_class = StoreUpdateSerializer

    def update(self, request, *args, **kwargs):
        partial = kwargs.pop("partial", False)
        instance = self.get_object()
        # 将request传入序列化器上下文，供验证和更新逻辑使用
        serializer = self.get_serializer(instance, data=request.data, partial=partial, context={'request': request})
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)
        return Response(serializer.data, status=200)

关键说明 #

• 数据验证：通过validate方法确保请求数据的合法性，包括类型互斥、必填字段检查。
• 关联模型处理：使用get_or_create方法兼容关联模型已存在或未创建的场景，避免更新失败。
• 上下文传递：将request传入序列化器上下文，因为请求的类型字段（AmazonConnectOptions/AliConnectOptions）不在Store的直接字段中，需要从原始请求数据读取。

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