Mongoengine如何实现对其他文档内EmbeddedDocument元素的引用？

你现有通过父文档引用+路径定位的核心思路是完全可行的，我们只需要将其封装为MongoEngine原生的自定义字段类型，就能大幅简化业务侧的使用复杂度，无需手动调用get()/set()方法，用法和普通ReferenceField完全一致。

自定义字段实现 #

from mongoengine import BaseField, ReferenceField, ListField, StringField, ValidationError
from mongoengine.base import BaseDocument

class EmbeddedDocumentReferenceField(BaseField):
    """
    用于引用其他Document中存储的EmbeddedDocument实例的自定义字段
    数据库存储结构为: {"parent": <父文档ObjectId>, "path": ["list_of_embedded_documents", "5"]}
    """
    def __init__(self, embedded_doc_class, **kwargs):
        self.embedded_doc_class = embedded_doc_class
        super().__init__(**kwargs)

    def __get__(self, instance, owner):
        if not instance:
            return self
        stored_val = instance._data.get(self.name)
        if not stored_val:
            return None
        parent = stored_val["parent"]
        path = stored_val["path"]
        # 递归解析路径
        current = parent
        for seg in path:
            # 自动转换数字索引适配列表场景
            if isinstance(current, list) and seg.isdigit():
                seg = int(seg)
            current = getattr(current, seg) if hasattr(current, seg) else current[seg]
        # 类型校验
        if not isinstance(current, self.embedded_doc_class):
            raise ValidationError(f"路径指向的实例不是{self.embedded_doc_class.__name__}类型")
        return current

    def __set__(self, instance, value):
        # 赋值格式要求：(父文档实例, 路径序列)
        if not isinstance(value, (tuple, list)) or len(value) != 2:
            raise ValidationError("赋值需传入格式为 (父文档实例, 路径序列)")
        parent, path = value
        if not isinstance(parent, Document):
            raise ValidationError("父文档必须是Document类型实例")
        # 路径统一转字符串存储
        path_str = [str(seg) for seg in path]
        instance._data[self.name] = {
            "parent": parent,
            "path": path_str
        }

    def to_mongo(self, value):
        return {
            "parent": value["parent"].to_mongo(),
            "path": value["path"]
        }

    def to_python(self, value):
        parent = ReferenceField(Document).to_python(value["parent"])
        return {
            "parent": parent,
            "path": value["path"]
        }

业务代码使用示例 #

你原有业务逻辑几乎不需要修改，仅调整test2_document的字段定义即可：

class test2_document(Document):
    reference_to_embedded_documents = EmbeddedDocumentReferenceField(test_embedded_document)
    
    def bar(self, value):
        # 直接调用方法，和普通ReferenceField用法完全一致
        self.reference_to_embedded_documents.foo(value)

赋值示例 #

# 取已有test1_document实例
t1 = test1_document.objects.first()
t2 = test2_document()
# 赋值传入父文档实例和对应路径即可，此处路径对应你需要的list_of_embedded_documents第5项
t2.reference_to_embedded_documents = (t1, ["list_of_embedded_documents", 5])
t2.save()

# 直接调用bar方法即可正常执行
t2.bar("测试参数")

可选稳定性优化 #

如果存在嵌入式列表元素顺序调整导致索引偏移的场景，可以给test_embedded_document增加唯一标识字段，将路径改为按唯一标识查找，避免索引变化导致引用失效：

class test_embedded_document(EmbeddedDocument):
    # 新增父文档范围内唯一的id字段
    item_id = StringField(required=True, unique_with="_parent")
    some_value = StringField(max_length=150)

    def foo(self, value):
        print(value, self.some_value)

仅需调整自定义字段中的路径解析逻辑，支持按item_id过滤列表即可，引用不会受列表顺序变化影响。

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