MongoEngine嵌套文档解引用：如何填充引用对象而非ID

这个问题其实是MongoEngine序列化时的常见需求——默认的to_mongo()会返回数据库存储的原始结构，所以引用字段只会显示ObjectId，而我们需要把关联的完整文档数据展开出来。下面给你一套通用的解决方案，不管模型有多复杂都能适用：

1. 理解核心问题 #

select_related()确实帮你预加载了关联的Role文档，但to_mongo()的设计是输出和数据库存储一致的格式，所以它不会自动展开引用。我们需要自己实现序列化逻辑，把预加载的关联文档转换成嵌套的字典结构。

2. 通用递归序列化方案 #

最灵活的方式是给所有Document模型添加一个自定义的to_dict()方法，自动展开所有引用字段：

方法一：自定义基础Document类（推荐）

我们可以继承MongoEngine的Document，添加一个通用的序列化方法，这样所有模型都能直接使用：

from mongoengine import Document as BaseDocument, StringField, ReferenceField, DENY, connect

connect('test_database')

# 自定义抽象Document基类，添加通用序列化方法
class Document(BaseDocument):
    meta = {'abstract': True}
    
    def to_dict(self, include_id=True):
        serialized = {}
        # 遍历模型的所有字段
        for field_name, field in self._fields.items():
            # 处理ID字段，可选是否包含
            if field_name == '_id':
                if include_id:
                    serialized['_id'] = str(self.id)
                continue
            
            value = getattr(self, field_name)
            
            # 处理引用字段：递归序列化关联文档
            if isinstance(field, ReferenceField):
                if value is not None:
                    serialized[field_name] = value.to_dict(include_id=include_id)
                else:
                    serialized[field_name] = None
            # 处理包含引用的列表字段：逐个序列化列表中的文档
            elif isinstance(field, ListField) and isinstance(field.field, ReferenceField):
                serialized[field_name] = [item.to_dict(include_id=include_id) for item in value] if value else []
            # 处理其他字段：转换为Python原生类型
            else:
                # 针对MongoEngine字段的特殊处理，比如DateTimeField等
                serialized[field_name] = value.to_python() if hasattr(value, 'to_python') else value
        return serialized

# 你的模型继承自定义的Document
class Role(Document):
    name = StringField(required=True)
    description = StringField(required=True)

class User(Document):
    role = ReferenceField(Role, reverse_delete_rule=DENY)

使用方式

保存数据后，直接调用to_dict()方法即可：

# 初始化测试数据
r = Role(name='test', description='foo').save()
User(role=r).save()

# 查询并序列化
user = User.objects().select_related()[0]
print(user.to_dict())

输出结果就是你期望的：

{'_id': '5c769af4e98fc24f4a82fd99', 'role': {'name': 'test', 'description': 'foo'}}

3. 关键注意事项 #

• 必须配合select_related()：这个方法会预加载所有关联的文档，避免序列化时触发N+1查询（每序列化一个引用就查一次数据库），大幅提升性能。如果你的模型有多层嵌套引用，可以用select_related('role.another_ref')这样的语法深度预加载。
• 灵活控制ID显示：调用to_dict(include_id=False)可以去掉输出中的_id字段，适合不需要ID的场景。
• 支持复杂嵌套：这个方案会递归处理所有层级的引用字段，不管你的模型有多复杂（比如Role里还有其他引用，或者User有列表类型的引用字段），都能正确展开。

4. 替代方案：单独工具函数 #

如果不想修改Document基类，也可以写一个独立的工具函数来处理序列化：

def serialize_doc(doc, include_id=True):
    data = {}
    for field_name, field in doc._fields.items():
        if field_name == '_id':
            if include_id:
                data['_id'] = str(doc.id)
            continue
        
        value = getattr(doc, field_name)
        
        if isinstance(field, ReferenceField):
            data[field_name] = serialize_doc(value, include_id=include_id) if value else None
        elif isinstance(field, ListField) and isinstance(field.field, ReferenceField):
            data[field_name] = [serialize_doc(item, include_id=include_id) for item in value] if value else []
        else:
            data[field_name] = value.to_python() if hasattr(value, 'to_python') else value
    return data

# 使用方式
user = User.objects().select_related()[0]
print(serialize_doc(user))

这个函数和上面的to_dict()逻辑完全一致，只是作为独立函数使用，适合不想修改基类的场景。

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