MongoEngine使用时如何避免空EmbeddedDocumentList字段存入MongoDB

方案1：修改字段默认属性（最简单） #

• MongoEngine 中EmbeddedDocumentListField的默认值是空列表[]，所以即使你没有主动赋值，也会将空列表写入数据库。将字段的default设为None、null设为True后，未赋值的字段值为None，MongoEngine 不会将值为None的字段持久化到数据库。

示例代码：

from mongoengine import Document, EmbeddedDocument, EmbeddedDocumentListField, StringField

# 子文档定义
class SubItem(EmbeddedDocument):
    content = StringField()

# 父文档定义
class ParentDoc(Document):
    name = StringField(required=True)
    # 核心配置：default=None, null=True
    sub_items = EmbeddedDocumentListField(SubItem, default=None, null=True)

方案2：重写save方法（适配保留空列表默认值的场景） #

如果你需要保留空列表作为字段默认值，不想修改默认属性，可以重写父文档的save方法，保存前自动删除空的列表字段：

示例代码：

class ParentDoc(Document):
    name = StringField(required=True)
    sub_items = EmbeddedDocumentListField(SubItem, default=list)

    def save(self, *args, **kwargs):
        # 子文档列表为空时删除该字段，避免存入空列表
        if not self.sub_items:
            del self.sub_items
        return super().save(*args, **kwargs)

注意事项 #

• 采用方案1时，读取不存在该字段的文档时，取值会返回None，业务逻辑判断时要同时兼容None和空列表两种场景，避免抛出属性错误。
• 批量更新操作时，不要将空的子文档列表字段放入更新参数中，否则依然会写入空列表到数据库。

内容的提问来源于stack exchange，提问作者Gabriel García Garrido