[Python之路] ORM（对象关系映射）

一、概念

ORM是Python后端Web框架Django的核心思想，"Object Relational Mapping"，即对象-关系映射，简称ORM。

一句话理解就是：

　　创建一个实例对象，用创建它的类名当做数据表名，用创建它的类属性对应数据表的字段，当对这个实例对象操作时，能够对应MySQL语句。

也就是说，当我们定义了User类，就相当于在数据库中创建了User表。我们使用User类创建一个实例对象，就相当于往表中插入一跳数据。

u = User(uid=123, name="leo", email="[e-mail]", password="")
u.save()

二、ORM的简易实现

# 定义一个元类（继承于type），用于创建User类
class ModelMetaClass(type):
    def __new__(cls, name, bases, attrs):
        mappings = dict()
        for k, v in attrs.items():
            if isinstance(v, tuple):
                print("Found mapping: %s ==> %s" % (k, v))
                mappings[k] = v

        for k in mappings.keys():
            attrs.pop(k)

        # 将attrs中的属性转化为以下形式
        attrs['__mappings__'] = mappings
        attrs['__table__'] = name

        return type.__new__(cls, name, bases, attrs)

# 用户定义User类
class User(metaclass=ModelMetaClass):
    # 用户定义的属性，在元类调用__new__时，会将属性进行变形（如下注释部分代码）
    uid = ('uid', 'int unsigned')
    name = ('name', 'varchar(30)')
    email = ('email', 'varchar(30)')
    password = ('password', 'varchar(30)')

    # 上述属性变形为以下形式
    # __mappings__ = {
    #     "uid": ('uid', 'int unsigned'),
    #     "name": ('name', 'varchar(30)'),
    #     "email": ('email', 'varchar(30)'),
    #     "password": ('password', 'varchar(30)')
    # }
    # __table__ = "User"

    # 在创建示例对象时（表的每条记录），动态设置成员属性，值就是要插入的值
    def __init__(self, **kwargs):
        for name, value in kwargs.items():
            setattr(self, name, value)

    # 调用save，则相当于执行sql语句
    def save(self):
        fields = []
        args = []
        for k, v in self.__mappings__.items():
            # 获取所有字段名
            fields.append(v[0])
            # 获取字段名对应的值
            args.append(getattr(self, k, None))

        # 给args中的值，如果不是数字，则需要加上引号（SQL中需要加引号，这里加单引号）
        args_temp = list()
        for temp in args:
            if isinstance(temp, int):
                args_temp.append(str(temp))
            elif isinstance(temp, str):
                args_temp.append("""'%s'""" % temp)

        # 组合SQL
        sql = """insert into %s (%s) values (%s)""" % (self.__table__, ','.join(fields), ','.join(args_temp))
        print('SQL: %s' % sql)

u = User(uid=1234, name="Leo", email="[e-mail]", password="")
u.save()

如上述代码，我们通过元类的__new__实现了简易的对象-关系映射。Django中的ORM实现要复杂得多，但从这里可以看出一些基本的思想。

我们如果要定义多个表的话，我们可以将构造函数和save方法都抽象到父类里面去：

# 定义一个元类（继承于type），用于创建User类
class ModelMetaClass(type):
    def __new__(cls, name, bases, attrs):
        mappings = dict()
        for k, v in attrs.items():
            if isinstance(v, tuple):
                print("Found mapping: %s ==> %s" % (k, v))
                mappings[k] = v

        for k in mappings.keys():
            attrs.pop(k)

        # 将attrs中的属性转化为以下形式
        attrs['__mappings__'] = mappings
        attrs['__table__'] = name

        return type.__new__(cls, name, bases, attrs)

class Model(object, metaclass=ModelMetaClass):
    def __init__(self, **kwargs):
        for name, value in kwargs.items():
            setattr(self, name, value)

    def save(self):
        fields = []
        args = []
        for k, v in self.__mappings__.items():
            # 获取所有字段名
            fields.append(v[0])
            # 获取字段名对应的值
            args.append(getattr(self, k, None))

        # 给args中的值，如果不是数字，则需要加上引号（SQL中需要加引号，这里加单引号）
        args_temp = list()
        for temp in args:
            if isinstance(temp, int):
                args_temp.append(str(temp))
            elif isinstance(temp, str):
                args_temp.append("""'%s'""" % temp)

        # 组合SQL
        sql = """insert into %s (%s) values (%s)""" % (self.__table__, ','.join(fields), ','.join(args_temp))
        print('SQL: %s' % sql)

# 用户定义User类，继承于Model父类，如果这里没有制定MetaClass，则会到父类去找
class User(Model):
    # 用户定义的属性，在元类调用__new__时，会将属性进行变形（如下注释部分代码）
    uid = ('uid', 'int unsigned')
    name = ('name', 'varchar(30)')
    email = ('email', 'varchar(30)')
    password = ('password', 'varchar(30)')

    # 上述属性变形为以下形式
    # __mappings__ = {
    #     "uid": ('uid', 'int unsigned'),
    #     "name": ('name', 'varchar(30)'),
    #     "email": ('email', 'varchar(30)'),
    #     "password": ('password', 'varchar(30)')
    # }
    # __table__ = "User"

u1 = User(uid=1234, name="Leo", email="[e-mail]", password="")
u1.save()

u2 = User(uid=1235, name="Jone", email="[e-mail]", password="")
u2.save()