Django Rest Framework下关联多模型的ModelSerializer定义与使用问题

核心疑问解答 #

1. 如何通过已存在的ModelB和ModelC实例生成ModelASerializer实例？ #

分两种场景：

• 序列化已有ModelA实例：直接将ModelA实例作为instance参数传入序列化器即可，关联字段会自动解析：

  model_a = ModelA.objects.create(field_b=model_b, field_c=model_c, other_field="test")
  serializer = ModelASerializer(instance=model_a)
  

• 反序列化创建新ModelA实例：需要为外键字段提供可写的输入通道，推荐使用读写分离的字段定义方式，参考下文序列化器修正代码。

2. ModelASerializer的序列化结果中是否会包含field_b和field_c的序列化表示？ #

只要在序列化器的Meta.fields中声明了field_b、field_c，且为其指定了对应的嵌套序列化器，序列化输出时就会包含这两个关联对象的完整序列化内容。

3. 调用.is_valid()方法时，是否会自动校验ModelA中定义的UniqueConstraint约束？ #

不会。DRF的ModelSerializer目前仅会自动识别模型层面的unique_together约束生成对应校验器，对于Django 2.2+引入的UniqueConstraint定义的联合唯一约束，无法自动识别，必须手动添加校验器，你代码中添加UniqueTogetherValidator的做法是正确的。

序列化器修正方案 #

你当前序列化器的核心问题是field_b、field_c仅设置了只读属性，没有可写的输入通道，导致反序列化时无法接收关联实例的信息，修正后代码如下：

class ModelASerializer(serializers.ModelSerializer):
    # 输出用嵌套序列化字段，只读
    field_b = ModelBSerializer(read_only=True)
    field_c = ModelCSerializer(read_only=True)
    # 输入用主键关联字段，只写，自动查找已存在的对应实例
    field_b_id = serializers.PrimaryKeyRelatedField(
        queryset=ModelB.objects.all(),
        source='field_b',
        write_only=True
    )
    field_c_id = serializers.PrimaryKeyRelatedField(
        queryset=ModelC.objects.all(),
        source='field_c',
        write_only=True
    )
    other_field = serializers.CharField(required=False)

    class Meta:
        model = ModelA
        fields = ('field_b', 'field_c', 'field_b_id', 'field_c_id', 'other_field',)
        validators = [
            UniqueTogetherValidator(
                queryset=ModelA.objects.all(),
                fields=['field_b', 'field_c'],
                message='该ModelB和ModelC的组合对应的ModelA实例已存在。'
            )
        ]

    def create(self, validated_data):
        return ModelA.objects.create(**validated_data)

    def update(self, instance, validated_data):
        instance.other_field = validated_data.get('other_field', instance.other_field)
        instance.save()
        return instance

正确的序列化器创建方式 #

# 已存在的ModelB、ModelC实例
model_b = ModelB()
model_c = ModelC()
model_b.save()
model_c.save()
other_field = "Dummy content"

# 构造输入数据，仅需传入关联实例的主键
data = {
    'field_b_id': model_b.pk,
    'field_c_id': model_c.pk,
    'other_field': other_field
}

model_a_serializer = ModelASerializer(data=data)
if model_a_serializer.is_valid():
    # 保存时不会新建ModelB、ModelC实例，仅关联已有实例
    model_a_instance = model_a_serializer.save()

原有尝试报错原因说明 #

• 第一次尝试错误：序列化器第一个位置参数为待序列化的实例，第二个为输入数据，直接传入三个字段值不符合参数规范，因此报错。
• 第二次尝试错误：传入data的是序列化器实例而非原始可序列化数据，且field_b、field_c为只读字段，DRF不会解析输入的这两个字段值，反而会因为数据格式异常触发错误的实例创建逻辑。

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