Django Rest Framework Mongoengine中PUT/PATCH与GET处理ReferenceField的疑问

我来帮你理清楚在DRF-Mongoengine里，ReferenceField在不同请求类型下的正确处理方式，分GET（序列化输出）和PUT/PATCH（反序列化更新）两部分来说：

一、GET请求：控制ReferenceField的输出格式 #

默认情况下，Doc2Serializer序列化doc2_field1时，只会返回关联Doc1对象的_id（ObjectId字符串）。如果想要返回更丰富的关联数据，或者自定义输出格式，有两种常见做法：

1. 输出完整的关联文档数据 #

直接嵌套Doc1Serializer，这样返回的doc2_field1就是Doc1的完整字段内容：

class Doc2Serializer(serializers.DocumentSerializer):
    # 嵌套关联模型的序列化器，输出完整Doc1数据
    doc2_field1 = Doc1Serializer()
    
    class Meta:
        model = Doc2
        fields = '__all__'

返回的响应示例：

{
  "_id": "60d21b4667d0d8992e610c86",
  "doc2_field1": {
    "_id": "60d21b4667d0d8992e610c85",
    "doc1_field1": "测试值1",
    "doc1_field2": "测试值2"
  },
  "doc2_field2": "原始字段值"
}

2. 仅输出关联文档的ID（默认行为） #

如果只需要返回Doc1的_id，默认的序列化器就可以做到，也可以显式指定StringField来明确：

class Doc2Serializer(serializers.DocumentSerializer):
    doc2_field1 = serializers.StringField()
    
    class Meta:
        model = Doc2
        fields = '__all__'

返回的响应示例：

{
  "_id": "60d21b4667d0d8992e610c86",
  "doc2_field1": "60d21b4667d0d8992e610c85",
  "doc2_field2": "原始字段值"
}

二、PUT/PATCH请求：处理ReferenceField的更新逻辑 #

PUT用于全量更新，PATCH用于部分更新，两者在ReferenceField的处理逻辑上基本一致，核心是把客户端传入的数据转换成Mongoengine能识别的Doc1实例。

1. 默认处理方式（通过ID关联） #

DRF-Mongoengine的ReferenceField序列化器默认支持接收关联对象的_id字符串，客户端只需传入正确的Doc1的_id，序列化器会自动查询对应的Doc1实例并完成关联：

客户端PUT请求的JSON示例：

{
  "doc2_field1": "60d21b4667d0d8992e610c85",
  "doc2_field2": "更新后的字段值"
}

客户端PATCH请求的JSON示例（只更新需要修改的字段）：

{
  "doc2_field1": "60d21b4667d0d8992e610c85"
}

如果传入的_id对应的Doc1不存在，序列化器会自动抛出ValidationError，返回400错误，这是合理的异常处理。

2. 自定义关联逻辑（通过其他字段关联） #

如果业务需求是通过Doc1的其他字段（比如doc1_field1）来关联，而不是_id，可以自定义一个字段来实现：

class Doc1ReferenceField(serializers.Field):
    def to_representation(self, value):
        # 序列化输出时，返回完整的Doc1数据（可按需调整）
        return Doc1Serializer(value).data
    
    def to_internal_value(self, data):
        # 反序列化时，根据客户端传入的data查找对应的Doc1对象
        try:
            # 这里假设客户端传的是doc1_field1的值，可根据业务修改查询条件
            return Doc1.objects.get(doc1_field1=data)
        except Doc1.DoesNotExist:
            raise serializers.ValidationError("对应的Doc1记录不存在，请检查输入")

然后在Doc2Serializer中使用这个自定义字段：

class Doc2Serializer(serializers.DocumentSerializer):
    doc2_field1 = Doc1ReferenceField()
    
    class Meta:
        model = Doc2
        fields = '__all__'

此时客户端可以通过doc1_field1的值来关联更新：

{
  "doc2_field1": "测试值1",
  "doc2_field2": "更新后的字段值"
}

总结 #

• GET请求：根据业务需求选择默认输出ID，或者嵌套序列化器输出完整关联文档；
• PUT/PATCH请求：默认支持通过ID关联更新，如需自定义关联规则，编写自定义字段即可实现。

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