如何让只读的StringRelatedField外键支持POST请求？

核心思路 #

保留外键约束的同时，让序列化器分别处理**序列化（GET返回全名）和反序列化（POST接收全名并关联外键）**逻辑，以下是两种常用实现方式：

方式一：拆分两个字段（直观易理解） #

适合新手快速上手，分别定义只读字段用于返回全名，只写字段用于接收全名并查询外键。

1. 模型示例（参考） #

# models.py
from django.db import models

class Customer(models.Model):
    first_name = models.CharField(max_length=100)
    last_name = models.CharField(max_length=100)

    def __str__(self):
        return f"{self.first_name} {self.last_name}"  # 确保这里返回的是你要显示的全名格式

class Contract(models.Model):
    insurance_holder = models.ForeignKey(Customer, on_delete=models.CASCADE)
    contract_number = models.CharField(max_length=50)
    # 其他业务字段...

2. 序列化器实现 #

# serializers.py
from rest_framework import serializers
from .models import Contract, Customer

class ContractSerializer(serializers.ModelSerializer):
    # GET请求时返回客户全名（只读）
    insurance_holder_name = serializers.StringRelatedField(source='insurance_holder', read_only=True)
    # POST请求时接收客户全名（只写）
    insurance_holder_full_name = serializers.CharField(write_only=True)

    class Meta:
        model = Contract
        fields = ['id', 'contract_number', 'insurance_holder_name', 'insurance_holder_full_name']

    def create(self, validated_data):
        # 取出传入的全名，移除字典中该字段
        full_name = validated_data.pop('insurance_holder_full_name')
        # 拆分全名（注意和Customer.__str__的格式对应，比如如果是"姓, 名"就调整分割逻辑）
        try:
            first_name, last_name = full_name.split(' ', 1)
            # 查询对应的客户实例
            customer = Customer.objects.get(first_name=first_name, last_name=last_name)
        except ValueError:
            raise serializers.ValidationError("客户全名格式错误，请输入'名 姓'格式")
        except Customer.DoesNotExist:
            raise serializers.ValidationError("该客户不存在")
        except Customer.MultipleObjectsReturned:
            raise serializers.ValidationError("存在多个同名客户，请使用唯一标识")
        
        # 创建合同并关联客户
        return Contract.objects.create(insurance_holder=customer, **validated_data)

方式二：自定义关联字段（更简洁） #

通过自定义RelatedField，让同一个字段同时处理序列化和反序列化逻辑，代码更紧凑。

序列化器实现 #

# serializers.py
from rest_framework import serializers
from .models import Contract, Customer

class FullNameForeignKeyField(serializers.RelatedField):
    def to_representation(self, value):
        # 序列化：返回客户全名
        return str(value)

    def to_internal_value(self, data):
        # 反序列化：根据全名查询客户
        try:
            first_name, last_name = data.split(' ', 1)
            return Customer.objects.get(first_name=first_name, last_name=last_name)
        except ValueError:
            raise serializers.ValidationError("客户全名格式错误，请输入'名 姓'格式")
        except Customer.DoesNotExist:
            raise serializers.ValidationError("该客户不存在")
        except Customer.MultipleObjectsReturned:
            raise serializers.ValidationError("存在多个同名客户，请使用唯一标识")

class ContractSerializer(serializers.ModelSerializer):
    insurance_holder = FullNameForeignKeyField(queryset=Customer.objects.all())

    class Meta:
        model = Contract
        fields = ['id', 'contract_number', 'insurance_holder']

关键注意事项 #

• 全名格式一致性：确保POST传入的全名格式和Customer.__str__返回的格式完全匹配，否则查询会失败。
• 重名处理：如果业务中存在同名客户，建议在Customer模型中添加唯一约束（比如unique_together），或者改用其他唯一标识（如手机号、邮箱）来查询，避免MultipleObjectsReturned异常。
• 验证逻辑：可以根据业务需求添加额外验证，比如判断当前用户是否有权限操作该客户。

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