ORM全称“Object Relational Mapping”,即对象-关系映射,就是把关系数据库的一行映射为一个对象,也就是一个类对应一个表,这样,写代码更简单,不用直接操作SQL语句。
要编写一个ORM框架,所有的类都只能动态定义,因为只有使用者才能根据表的结构定义出对应的类来。
编写底层模块的第一步,就是先把调用接口写出来。比如,使用者如果使用这个ORM框架,想定义一个User类来操作对应的数据库表User,我们期待他写出这样的代码:
class User(Model):
# 定义类的属性到列的映射:
id = IntegerField('id')
name = StringField('username')
email = StringField('email')
password = StringField('password')
# 创建一个实例:
u = User(id=12345, name='Michael', email='test@orm.org', password='my-pwd')
# 保存到数据库:
u.save()
其中,父类Model和属性类型StringField、IntegerField是由ORM框架提供的,剩下的魔术方法比如save()全部由元类metaclass自动完成。虽然元类metaclass的编写会比较复杂,但ORM的使用者用起来却异常简单。
现在,我们就按上面的接口来实现该ORM。
首先来定义Field类,它负责保存数据库表的字段名和字段类型:
# -*- coding:utf-8 -*-
#定义Field类,负责保存数据库表的字段类型和字段名字
class Field(object):
#表的字段包括名字,类型,是否为表的主键或者默认值
def __init__(self, name, column_type):
self.name = name
#当打印数据库表时候,输出表的信息,类名,字段名字,默认值
def __str__(self):
return ('<%s: %s>' % (self.__class__.__name__, self.name))
在Field的基础上,进一步定义各种类型的衍生Field,比如StringField,IntegerField等等,表的不同列的字段的类型不一样
class StringField(Field):
def __init__(self, name'):
super(StringField, self).__init__(name, 'varchar(100)')
class IntegerField(Field):
def __init__(self, name):
super(IntegerField, self).__init__(name, 'bigint')
下一步,就是编写最复杂的Model的元类ModelMetaclass了
所有的元类都继承自type
ModelMetaclass元类定义了所有Model基类(继承ModelMetaclass)的子类实现的操作
-*-ModelMetaclass的工作主要是为一个数据库表映射成一个封装的类做准备:
读取具体子类(user)的映射信息
创造类的时候,排除对Model类的修改
在当前类中查找所有的类属性(attrs),如果找到Field属性,就将其保存到mappings的dict中,同时从类属性中删除Field(防止实例属性遮住类的同名属性)
将数据库表名保存到table中
完成这些工作就可以在Model中定义各种数据库的操作方法
class ModelMetaclass(type):
# __new__控制__init__的执行,所以在其执行之前
# cls:代表要__init__的类,此参数在实例化时由Python解释器自动提供(例如下文的User和Model)
# bases:代表继承父类的集合
# attrs:类的方法集合
def __new__(cls, name, bases, attrs):
#排除Model
if name == 'Model':
return type.__new__(cls, name, bases, attrs)
print('find model; %s' % name)
# 获取Field和主键名
mappings = dict()
# 此处的k是类的一个属性,v是这个属性在数据库中对应的Field列表属性
for k, v in attrs.items():
# Field 属性
if isinstance(v, Field):
print('Found mapping: %s ==> %s' % (k, v))
mappings[k] = v
# 从类属性中删除Field属性
for k in mappings.keys():
attrs.pop(k)
attrs['__mappings__'] = mapping #保存属性和列的映射关系
attrs['__table__'] = name #假设表名和类名一致,保存表名
return type.__new__(cls, name, bases, attrs)
以及基类Model:
# 定义ORM所有映射的基类:Model
# Model类的任意子类可以映射一个数据库表
# Model类可以看作是对所有数据库表操作的基本定义的映射
# 基于字典查询形式
# Model从dict继承,拥有字典的所有功能,同时实现特殊方法__getattr__和__setattr__,能够实现属性操作
# 实现数据库操作的所有方法,定义为class方法,所有继承自Model都具有数据库操作方法
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 hao no attribute '%s'" % key)
def __setattr__(self, key, value):
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))
当用户定义一个class User(Model)时,Python解释器首先在当前类User的定义中查找metaclass,如果没有找到,就继续在父类Model中查找metaclass,找到了,就使用Model中定义的metaclass的ModelMetaclass来创建User类,也就是说,metaclass可以隐式地继承到子类,但子类自己却感觉不到。
在ModelMetaclass中,一共做了几件事情:
排除掉对Model类的修改;
在当前类(比如User)中查找定义的类的所有属性,如果找到一个Field属性,就把它保存到一个mappings的dict中,同时从类属性中删除该Field属性,否则,容易造成运行时错误(实例的属性会遮盖类的同名属性);
把表名保存到table中,这里简化为表名默认为类名。
在Model类中,就可以定义各种操作数据库的方法,比如save(),delete(),find(),update等等。
我们实现了save()方法,把一个实例保存到数据库中。因为有表名,属性到字段的映射和属性值的集合,就可以构造出INSERT语句。
编写代码试试:
u = User(id=12345, name=’Michael’, email=’test@orm.org’, password=’my-pwd’)
u.save()