python的元类以及应用(二),元类实现ORM

前言

在上一篇文章中https://www.jianshu.com/p/c41373f16064, 介绍了python元类的概念以及几个应用的例子,这次来介绍一下ORM以及解答之前的问题【为什么搜索元类应用,总是出现ORM】

关于ORM

ORM是指对象关系映射(Object Relational Mapping,简称ORM),从全称上可以看出这是处理【对象】和【关系型数据库】之间的映射的技术。
我们先来看看一个数据表:

CREATE TABLE users (  
    id INT AUTO_INCREMENT PRIMARY KEY,  
    username VARCHAR(50) NOT NULL,  
    email VARCHAR(100) NOT NULL,  
    birthdate DATE,  
    is_active BOOLEAN DEFAULT TRUE  
);

当我们进行查询或者插入的时候,需要这么写:

# 查询
SELECT id, username FROM users;
# 插入
INSERT INTO users (id, username) VALUES (1,"Tom");

可以发现,如果要进行数据库操作,需要拼接许多sql语句,这对于代码的维护和更新来说,将会增加许多工作量。
如果可以有一个办法,把面向对象和关系型数据结合起来,那将会方便很多。 比如,上述的操作,可以变成类似这样:

class User:
    id = INT(auto_increment = True, primary_key = True)
    username = VARCHAR(50)
    email =  VARCHAR(100)
    

# 创建数据表
create(User)
# 或者:
User.create()

# 查询
result = User.select().where(id = 1)
# 或者:
result = select(User).where(id = 1)

# 插入
User.insert(id = 1, name = "Tom")
# 或者
insert(User(id = 1, name = "Tom"))

以上是举个例子,实际的ORM类库不一定是这样的风格。 主要是表达出ORM的观点:将对象和关系型数据库进行映射,对象的属性就是数据库的字段,对象的方法就是数据库的操作。
通过这样的映射,可以省去拼接sql语句,也可以进行更多复杂的操作,例如数据校验等等。

* ORM的两种风格

详细介绍元类和ORM之前,先聊一下ORM的两种模式:active record 和 data mapper。
1.Active Record模式:
把数据模型和数据持久化结合,每个描述数据表的模型都包含访问数据库的方法,可以直接操作数据库。例如上面的:

User.create()
result = User.select().where(id = 1)

在python中,Django的ORM,Peewee等就是使用active record模式。

  1. Data Mapper模式:
    这个模式把数据模型和数据持久化分开,由一个独立的数据映射来处理数据持久化,数据模型只是负责业务逻辑。
    例如上面的:
create(User)
result = select(User).where(id = 1)

SQLAlchemy就是使用data mapper模式。

这里不去讨论两种的优劣,只是简单介绍有这两种模式。后面的代码将通过active record来实现ORM.

元类的ORM的关系

在介绍了元类和ORM之后,二者到底有什么关系?
我们看这样一个例子:
在一个user表里面,写入id =1,username="Tom";id = 2, username = "Jack"
如果创建一个函数:

def insert_user(id:int,username:str):
    sql = f'INSERT INTO user (id,username) VALUES ({id},{username})'

这将和拼接sql是没有差别的,并不是orm。 实际上我们是不知道创建表的时候,会有什么字段,这些字段都是使用者自己创建的。 因此,我们要有这样的映射:
【类】——>【数据表】
【类属性】——>【数据表字段】
【对象】——>【数据记录】
【对象属性值】——>【数据表字段值】

我们希望使用的方式类似这样:

Class User:
    # 类属性映射到数据表
    id = IntegerField('id')
    username = VarcharField('username')
    
# 实例化一条数据记录
user1 = User(id = 1, username = 'Tom')
# insert
user1.insert()

user2 = User(id = 2,username = 'Jack')
user2.insert()

可以看到,在创建User类的时候,需要进行字段映射,因此,这里就是使用元类的原因:【拦截和修改类的创建】,让使用者在定义类的时候,完成对数据表的定义;在实例化一个类的时候,完成一条数据记录的定义。

使用元类实现ORM

先完成字段类型的定义:

class Field:  
    def __init__(self, name):  
        self.name = name  
  
  
class IntegerField(Field):  
    def __init__(self, name):  
        super().__init__(name)  
        self.type = 'int'  
  
  
class VarcharField(Field):  
    def __init__(self, name):  
        super().__init__(name)  
        self.type = 'varchar(100)'

元类的定义:

class MetaModel(type):  
    def __new__(cls, name, bases, attrs):
        # 排除Model类
        if name == 'Model':  
            return type.__new__(cls, name, bases, attrs)  
        
        # 将类属性隔离,避免后续实例化被覆盖。 类定义了id=IntegerField(),实例化id = 1会因为同名被覆盖
        mapper = {}  
        for k, v in attrs.items():  
            if isinstance(v, Field):  
                mapper[k] = v  
  
        for k in mapper:  
            attrs.pop(k)  

        attrs['__mapper__'] = mapper  
        if '__table__' not in attrs:  
            attrs['__table__'] = name  

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

Model类的定义:

class Model(metaclass=MetaModel):  
    # 实例化设置具体值
    def __init__(self, **kwargs):  
        for k, v in kwargs.items():  
            self.__setattr__(k, v)  
  
    def insert(self):  
        column_li = []  
        val_li = []  
        # 读取元类设置好的__mapper__
        for k, v in self.__mapper__.items():  
            val = getattr(self, k, None)  
            if val is not None:  
                # 注意这个v.name,这是Field字段的name,实际数据表里面的字段名
                column_li.append(v.name)  
                val_li.append(f'"{val}"')  

        print(column_li)  
        print(val_li)  

        sql = f'INSERT INTO {self.__table__} ({",".join(column_li)}) VALUES ({",".join(val_li)})'  

        print(sql)
        
    @classmethod  
    def create(cls):  
        cloumn_li = []  
        for k, v in cls.__mapper__.items():  
            cloumn_li.append(f'{v.name} {v.type}')  
        sql = f'CREATE {cls.__table__} {",".join(cloumn_li)}'  

        print(sql)

调用情况:

class User(Model):  
    __table__ = 'user'
    id = IntegerField('id')  
    username = VarcharField('username')  
  
User.create()
user = User(id=1, username='tom')  
user.insert()

输出:
CREATE user id int,username varchar(100)
['id']
['"1"']
INSERT INTO user (id) VALUES ("1")

元类主要做了几件事:
1.收集类属性,判断类属性是否是属于File(),也就是是否是数据表字段。将这些字段存入mapper,【避免实例化被具体数值覆盖】。
2.表名设置。通过对类属性的检查,设置表名。 因此,如果需要其他额外属性的设置,也可以在元类定义加入。
这就是核心的把类、对象和数据表进行映射。还可以加上其他操作方法、增加不同的数据库语法、字段检查等等。

总结

使用ORM可以方便的进行关系型数据库库操作,减少开发负担。要实现ORM的重点,就是如何把类和实例与关系型数据库进行映射。 python的元类,可以在拦截和修改类的创建,因此可以通过元类,在类的定义时,进行映射。
回到最初的问题:ORM一定要用元类来实现吗? 通过上述的内容可以得知,只要能够完成映射,就不一定需要用元类。 后续会展示不使用元类实现的ORM。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,544评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,430评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,764评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,193评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,216评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,182评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,063评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,917评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,329评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,543评论 2 332
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,722评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,425评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,019评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,671评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,825评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,729评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,614评论 2 353

推荐阅读更多精彩内容