详解MongoDB的add_son_manipulator()函数：添加一个子文档处理器

MongoDB的add_son_manipulator()函数

功能

add_son_manipulator() 函数是 MongoDB 中的一个函数，其作用是给每个 insert 操作添加一些额外的 Json 字段，或者对已存在的 Json 字段进行修改，达到一些特定的目的。

方法

在 Python 中，可以通过 add_son_manipulator() 方法，对所有 MongoEngine 使用的 Collection 添加额外的 Json 字段，或对已存在的 Json 字段进行修改。

该方法的参数是 name 和 manipulator，其中，name 参数为字符串类型，表示想要添加的 Json 字段的名称，而 manipulator 参数是一个类，这个类需要实现一个名为 transform_incoming() 的方法，用于处理传入的 Json。

以下是一个简单的示例：使用 add_son_manipulator() 方法，在 people 集合中添加一个 birth_year 字段，字段值为 2015 减去 age：

from mongoengine import Document, StringField, IntField
from datetime import datetime, timedelta


class Person(Document):
    name = StringField()
    age = IntField()

    def __init__(self, *args, **kwargs):
        self.birthday = kwargs.pop('birthday', None)
        super(Person, self).__init__(*args, **kwargs)


class AgeAddManipulator(object):
    def transform_incoming(self, son, collection):
        if 'age' in son:
            son['birth_year'] = datetime.now().year - son['age']
        return son


Person.register_add_son_manipulator('birth_year', AgeAddManipulator())

在上面的示例中，首先定义了一个 Person 类，然后定义了一个 AgeAddManipulator 类，这个类实现了 transform_incoming() 方法，这个方法将 age 转换成出生年份，并将其添加到输入的 Json 数据中，最后使用 Person.register_add_son_manipulator() 方法将 AgeAddManipulator 类添加到 Person 类中。

为了验证 AgeAddManipulator 类实现的是正确的，我们可以为 Person 创建一个新实例并保存到数据库中：

person = Person(name='John', age=25)
person.save()

示例

下面提供两个示例来说明 add_son_manipulator() 方法的使用：

示例一：添加一个日志字段

在这个示例中，我们假设你想为每个 insert 操作添加日志记录，你可以在每次插入数据时，自动添加一个名为 insert_time 的字段，表示插入数据的时间。

代码示例如下：

from mongoengine import Document, StringField, IntField
from datetime import datetime


class InsertTimeMangipulator(object):
    def transform_incoming(self, son, collection):
        if not son.get('insert_time'):
            son['insert_time'] = datetime.now()
        return son


class People(Document):
    name = StringField(required=True)
    age = IntField(required=True)

    # 注册上面实现的插入时间的manipulator
    People.register_add_son_manipulator('insert_time', InsertTimeMangipulator())

这个示例中，我们实现了一个名为 InsertTimeManipulator 的类，这个类实现了 transform_incoming() 方法，用于为每个 insert 操作添加一个 insert_time 字段，该字段的值为当前时间。

接下来，我们使用 register_add_son_manipulator() 方法将 InsertTimeManipulator 类注册到 People 类中，以便 MongoDB 使用。

示例二：根据数据自动生成一个索引字段

在这个示例中，我们假设你想为某个 Collection 中的每条记录添加一个索引字段，以便于快速进行数据查询。

代码示例如下：

from mongoengine import Document, StringField, IntField


class IndexMangipulator(object):
    def transform_incoming(self, son, collection):
        count = collection.find().count()
        son['index'] = count + 1
        return son


class People(Document):
    name = StringField(required=True)
    age = IntField(required=True)

    # 注册上面实现的插入时间的manipulator
    People.register_add_son_manipulator('index', IndexMangipulator())

这个示例中，我们实现了一个名为 IndexManipulator 的类，这个类实现了 transform_incoming() 方法，用于为每个 insert 操作添加一个 index 字段，该字段的值为当前 Collection 中记录数加一。

同样地，我们使用 register_add_son_manipulator() 方法将 IndexManipulator 类注册到 People 类中，以便 MongoDB 使用。

以上就是 MongoDB 的 add_son_manipulator() 函数的作用与使用方法的完整攻略。