You need to enable JavaScript to run this app. Django REST Framework中外键关联字段的序列化与反序列化实现
优惠活动
大模型
产品
解决方案
定价
更多

Django REST Framework中外键关联字段的序列化与反序列化实现

兼容读写能力的Item序列化器实现方案

你当前编写的category_name = serializers.CharField(source='category.name')仅支持读取的核心原因是,DRF遇到source指向跨模型嵌套属性路径时,会自动将该字段标记为只读,不会自动处理入参的反向解析逻辑——也就是拿到传入的category_name字符串时,DRF不知道要怎么把这个值转换为关联的Category实例,所以没法直接支持写入。
完全可以通过调整序列化器逻辑实现读写双向兼容,以下是两种常用的实现方式:

方案一:单字段双用途(推荐,接口字段命名统一)

这种方案下,接口无论读取还是写入都只用category_name一个字段,没有冗余字段,完全匹配需求:

class ItemSerializer(serializers.ModelSerializer):
    category_name = serializers.CharField()

    class Meta:
        model = Item
        fields = ('id', 'name', 'category_name')

    def to_representation(self, instance):
        # 序列化阶段:从关联的Category实例中取名称返回
        representation = super().to_representation(instance)
        representation['category_name'] = instance.category.name
        return representation

    def create(self, validated_data):
        # 从校验通过的入参中取出分类名,查找对应Category实例
        category_name = validated_data.pop('category_name')
        # 因为Category.name是唯一约束,直接查询即可
        category = Category.objects.get(name=category_name)
        # 组装数据创建Item实例
        return Item.objects.create(category=category, **validated_data)

    def update(self, instance, validated_data):
        # 更新场景:如果传了新的分类名,同步更新关联的Category
        if 'category_name' in validated_data:
            category_name = validated_data.pop('category_name')
            category = Category.objects.get(name=category_name)
            instance.category = category
        # 处理Item本身字段的更新
        instance.name = validated_data.get('name', instance.name)
        instance.save()
        return instance

    # 可选:增加入参校验,避免传入不存在的分类名导致报错
    def validate_category_name(self, value):
        if not Category.objects.filter(name=value).exists():
            raise serializers.ValidationError(f"分类“{value}”不存在")
        return value

方案二:读写字段分离

这种方案适合需要严格区分读返回字段和写入入参字段的场景:

class ItemSerializer(serializers.ModelSerializer):
    # 读取阶段返回的字段:只读,直接映射关联分类的名称
    category_name = serializers.CharField(source='category.name', read_only=True)
    # 写入阶段接收的字段:只写,不参与序列化返回
    category_name_input = serializers.CharField(write_only=True)

    class Meta:
        model = Item
        fields = ('id', 'name', 'category_name', 'category_name_input')

    def create(self, validated_data):
        category_name = validated_data.pop('category_name_input')
        category = Category.objects.get(name=category_name)
        return Item.objects.create(category=category, **validated_data)

    def update(self, instance, validated_data):
        if 'category_name_input' in validated_data:
            category_name = validated_data.pop('category_name_input')
            category = Category.objects.get(name=category_name)
            instance.category = category
        instance.name = validated_data.get('name', instance.name)
        instance.save()
        return instance

注意事项

  • 如果业务允许传入的分类名不存在时自动创建新分类,可以把Category.objects.get(name=category_name)替换为Category.objects.get_or_create(name=category_name)[0],自动处理不存在的分类创建逻辑。
  • 不要试图通过修改原有source='category.name'字段的read_only参数实现写入:DRF对带嵌套点路径的source有内置只读限制,就算手动设置read_only=False,写入时DRF也会试图把字符串值直接赋值给Item的category外键字段,触发类型不匹配的报错。

内容的提问来源于stack exchange,提问作者Nikhil Garg

相关产品推荐
方舟 Agent Plan

超全模态模型 × Harness 升级,最新支持 Deepseek-V4.1-Flash、GLM-5.3 系列、Doubao-Seedream-5.0-pro、Kimi-K3 (部分), 限时 9.9 元起

最近更新时间:2026.11.10 13:06:07