Python编写ORM框架

ORM全称“Object Relational Mapping”，即对象-关系映射，就是把关系数据库的一行映射为一个对象，也就是一个类对应一个表，这样，写代码更简单，不用直接操作SQL语句。

要编写一个ORM框架，所有的类都只能动态定义，因为只有使用者才能根据表的结构定义出对应的类来，使用 metaclass 。

编写底层模块的第一步，就是先把调用接口写出来。比如，使用者如果使用这个ORM框架，想定义一个User类来操作对应的数据库表User，我们期待他写出这样的代码，用起来和litepal差不多：

class User(Model):    id = IntegerField("id")    username = StringField("username")    password = StringField("password")    email = StringField("email")# 创建实例u = User(id=1, username= "TaoYuan", password="123456", email="[e-mail]")u.save()  # 保存到数据库

其中，父类Model和属性类型StringField、IntegerField是由ORM框架提供的，剩下的魔术方法比如save()全部由metaclass自动完成。虽然metaclass的编写会比较复杂，但ORM的使用者用起来却异常简单。

实现

首先来定义Field类，它负责保存数据库表的字段名和字段类型：

class Field(object):    def __init__(self, name, column_type):        self.name = name        self.column_type = column_type    def __str__(self,):        return "<%s:%s>" % (self.__class__.__name__, self.name)

在Field的基础上，进一步定义各种类型的Field，比如StringField，IntegerField等等：

class IntegerField(Field):    def __init__(self, name):        super(IntegerField, self).__init__(name, "bigint")class StringField(Field):    def __init__(self, name):        super(StringField, self).__init__(name, "varchar(20)")

就是编写最复杂的ModelMetaclass以及Model了：

class ModelMetaclass(type):    def __new__(mcs, name, bases, attrs):        if name == "Model":            return type.__new__(mcs, name, bases, attrs)        print("Found Model:%s" % name)        mappings = dict()        for k, v in attrs.items():            if isinstance(v, Field):                print("Found mappings:%s --> %s" % (k, v))                mappings[k] = v        for k in mappings.keys():            attrs.pop(k)        attrs['__mappings__'] = mappings  # 保存属性和列的映射关系        attrs['__table__'] = name  # 假设表名和类名一致        return type.__new__(mcs, name, bases, attrs)class Model(dict, metaclass=ModelMetaclass):    def __init__(self, **kw):        super(Model, self).__init__(**kw)    def __getattr__(self, key):  # 属性校验        try:            return self[key]        except KeyError:            raise AttributeError(r"'Model' object has no attribute '%s'" % key)    def __setattr__(self, key, value):  # set        self[key] = value    def save(self):  # 保存        fields = []        params = []        args = []        for k, v in self.__mappings__.items():            fields.append(v.name)            params.append('?')            args.append(getattr(self, k, None))        # 连接数据库驱动即可真正连接        sql = "insert into %s (%s) values (%s)" % (self.__table__, ','.join(fields), ','.join(params))        print('SQL: %s' % sql)        print('ARGS: %s' % str(args))    def delete(self):  # 删        # 连接数据库驱动即可真正连接        sql = "delete from %s" % self.__table__        print('SQL: %s' % sql)    def update(self):  # 改        fields = []        params = []        args = []        for k, v in self.__mappings__.items():            fields.append(v.name)            params.append('?')            args.append(getattr(self, k, None))        # 连接数据库驱动即可真正连接        sql = "update %s set %s=%s" % (self.__table__, ','.join(fields), ','.join(params))        print('SQL: %s' % sql)        print('ARGS: %s' % str(args))    def find(self):  # 查        # 连接数据库驱动即可真正连接        sql = "select * from %s" % self.__table__        print('SQL: %s' % sql)

当用户定义一个class User(Model)时，Python解释器首先在当前类User的定义中查找metaclass，如果没有找到，就继续在父类Model中查找metaclass，找到了，就使用Model中定义的metaclass的ModelMetaclass来创建User类，也就是说，metaclass可以隐式地继承到子类，但子类自己却感觉不到。

在ModelMetaclass中，一共做了几件事情：

1. 排除掉对Model类的修改；
2. 在当前类（比如User）中查找定义的类的所有属性，如果找到一个Field属性，就把它保存到一个__mappings__的dict中，同时从类属性中删除该Field属性，否则，容易造成运行时错误（实例的属性会遮盖类的同名属性）；
3. 把表名保存到__table__中，这里简化为表名默认为类名。

在Model类中，就可以定义各种操作数据库的方法，比如save()，delete()，find()，update等等。

我们实现了save()方法，把一个实例保存到数据库中。因为有表名，属性到字段的映射和属性值的集合，就可以构造出INSERT语句。

得到输出：

Found Model:UserFound mappings:id --> <IntegerField:id>Found mappings:username --> <StringField:username>Found mappings:password --> <StringField:password>Found mappings:email --> <StringField:email>SQL: insert into User (id,username,password,email) values (?,?,?,?)ARGS: [1, 'TaoYuan', '123456', '[e-mail]']------------------------------SQL: delete from User------------------------------SQL: update User set id,username,password,email=?,?,?,?ARGS: [1, 'TaoYuan', '123456', '[e-mail]']------------------------------SQL: select * from User

小结

metaclass是Python中非常具有魔术性的对象，它可以改变类创建时的行为。这种强大的功能使用起来务必小心。

参考：廖雪峰的博客

demo源码