新聞中心
本文小編為大家詳細(xì)介紹“怎么使用SQL的Python神器ORM框架”,內(nèi)容詳細(xì),步驟清晰,細(xì)節(jié)處理妥當(dāng),希望這篇“怎么使用SQL的Python神器ORM框架”文章能幫助大家解決疑惑,下面跟著小編的思路慢慢深入,一起來學(xué)習(xí)新知識吧。
成都創(chuàng)新互聯(lián)公司是一家集網(wǎng)站建設(shè),江城企業(yè)網(wǎng)站建設(shè),江城品牌網(wǎng)站建設(shè),網(wǎng)站定制,江城網(wǎng)站建設(shè)報(bào)價(jià),網(wǎng)絡(luò)營銷,網(wǎng)絡(luò)優(yōu)化,江城網(wǎng)站推廣為一體的創(chuàng)新建站企業(yè),幫助傳統(tǒng)企業(yè)提升企業(yè)形象加強(qiáng)企業(yè)競爭力。可充分滿足這一群體相比中小企業(yè)更為豐富、高端、多元的互聯(lián)網(wǎng)需求。同時(shí)我們時(shí)刻保持專業(yè)、時(shí)尚、前沿,時(shí)刻以成就客戶成長自我,堅(jiān)持不斷學(xué)習(xí)、思考、沉淀、凈化自己,讓我們?yōu)楦嗟钠髽I(yè)打造出實(shí)用型網(wǎng)站。
背景
其實(shí)一開始用的是pyMySQL,但是發(fā)現(xiàn)維護(hù)比較麻煩,還存在代碼注入的風(fēng)險(xiǎn),所以就干脆直接用ORM框架。
ORM即Object Relational Mapper,可以簡單理解為數(shù)據(jù)庫表和Python類之間的映射,通過操作Python類,可以間接操作數(shù)據(jù)庫。
sqlalchemy版本: 1.3.15
pymysql版本: 0.9.3
mysql版本: 5.7
初始化工作
一般使用ORM框架,都會有一些初始化工作,比如數(shù)據(jù)庫連接,定義基礎(chǔ)映射等。
以MySQL為例,創(chuàng)建數(shù)據(jù)庫連接只需要傳入DSN字符串即可。其中echo表示是否輸出對應(yīng)的sql語句,對調(diào)試比較有幫助。
from sqlalchemy import create_engine engine = create_engine('mysql+pymysql://$user:$password@$host:$port/$db?charset=utf8mb4', echo=True)
個人設(shè)計(jì)
對于我個人而言,引進(jìn)ORM框架時(shí),我的項(xiàng)目會參考MVC模式做以下設(shè)計(jì)。其中model存儲的是一些數(shù)據(jù)庫模型,即數(shù)據(jù)庫表映射的Python類;model_op存儲的是每個模型對應(yīng)的操作,即增刪查改;調(diào)用方(如main.py)執(zhí)行數(shù)據(jù)庫操作時(shí),只需要調(diào)用model_op層,并不用關(guān)心model層,從而實(shí)現(xiàn)解耦。
├── main.py ├── model │ ├── __init__.py │ ├── base_model.py │ ├── ddl.sql │ └── py_orm_model.py └── model_op ├── __init__.py └── py_orm_model_op.py
映射聲明(Model介紹)
舉個栗子,如果我們有這樣一張測試表。
create table py_orm ( `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '唯一id', `name` varchar(255) NOT NULL DEFAULT '' COMMENT '名稱', `attr` JSON NOT NULL COMMENT '屬性', `ct` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '創(chuàng)建時(shí)間', `ut` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON update CURRENT_TIMESTAMP COMMENT '更新時(shí)間', PRIMARY KEY(`id`) )ENGINE=InnoDB COMMENT '測試表';
在ORM框架中,映射的結(jié)果就是下文這個Python類。
# py_orm_model.py from .base_model import Base from sqlalchemy import Column, Integer, String, TIMESTAMP, text, JSON class PyOrmModel(Base): __tablename__ = 'py_orm' id = Column(Integer, autoincrement=True, primary_key=True, comment='唯一id') name = Column(String(255), nullable=False, default='', comment='名稱') attr = Column(JSON, nullable=False, comment='屬性') ct = Column(TIMESTAMP, nullable=False, server_default=text('CURRENT_TIMESTAMP'), comment='創(chuàng)建時(shí)間') ut = Column(TIMESTAMP, nullable=False, server_default=text('CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP'), comment='更新時(shí)間')
首先,我們可以看到PyOrmModel繼承了Base類,該類是sqlalchemy提供的一個基類,會對我們聲明的Python類做一些檢查,我將其放在base_model中。
# base_model.py # 一般base_model做的都是一些初始化的工作 from sqlalchemy import create_engine from sqlalchemy.ext.declarative import declarative_base Base = declarative_base() engine = create_engine("mysql+pymysql://root:123456@127.0.0.1:33306/orm_test?charset=utf8mb4", echo=False)
其次,每個Python類都必須包含__tablename__屬性,不然無法找到對應(yīng)的表。
第三,關(guān)于數(shù)據(jù)表的創(chuàng)建有兩種方式,第一種當(dāng)然是手動在MySQL中創(chuàng)建,只要你的Python類定義沒有問題,就可以正常操作;第二種是通過orm框架創(chuàng)建,比如下面。
# main.py # 注意這里的導(dǎo)入路徑,Base創(chuàng)建表時(shí)會尋找繼承它的子類,如果路徑不對,則無法創(chuàng)建成功 from sqlachlemy_lab import Base, engine if __name__ == '__main__': Base.metadata.create_all(engine)
創(chuàng)建效果:
... 2020-04-04 10:12:53,974 INFO sqlalchemy.engine.base.Engine CREATE TABLE py_orm ( id INTEGER NOT NULL AUTO_INCREMENT, name VARCHAR(255) NOT NULL DEFAULT '' COMMENT '名稱', attr JSON NOT NULL COMMENT '屬性', ct TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP, ut TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP, PRIMARY KEY (id) )
第四,關(guān)于字段屬性:
1.primary_key和autoincrement比較好理解,就是MySQL的主鍵和遞增屬性。
2.如果是int類型,不需要指定長度,而如果是varchar類型,則必須指定。
3.nullable對應(yīng)的就是MySQL中的NULL 和 NOT NULL
4.關(guān)于default和server_default: default代表的是ORM框架層面的默認(rèn)值,即插入的時(shí)候如果該字段未賦值,則會使用我們定義的默認(rèn)值;server_default代表的是數(shù)據(jù)庫層面的默認(rèn)值,即DDL語句中的default關(guān)鍵字。
Session介紹
在SQLAlchemy的文檔中提到,數(shù)據(jù)庫的增刪查改是通過session來執(zhí)行的。
>>> from sqlalchemy.orm import sessionmaker >>> Session = sessionmaker(bind=engine) >>> session = Session() >>> orm = PyOrmModel(id=1, name='test', attr={}) >>> session.add(orm) >>> session.commit() >>> session.close()
如上,我們可以看到,對于每一次操作,我們都需要對session進(jìn)行獲取,提交和釋放。這樣未免過于冗余和麻煩,所以我們一般會進(jìn)行一層封裝。
1.采用上下文管理器的方式,處理session的異常回滾和關(guān)閉,這部分與所參考的文章是幾乎一致的。
# base_model.py from contextlib import contextmanager from sqlalchemy.orm import sessionmaker, scoped_session def _get_session(): """獲取session""" return scoped_session(sessionmaker(bind=engine, expire_on_commit=False))() # 在這里對session進(jìn)行統(tǒng)一管理,包括獲取,提交,回滾和關(guān)閉 @contextmanager def db_session(commit=True): session = _get_session() try: yield session if commit: session.commit() except Exception as e: session.rollback() raise e finally: if session: session.close()
2.在PyOrmModel中增加兩個方法,用于model和dict之間的轉(zhuǎn)換。
class PyOrmModel(Base): ... @staticmethod def fields(): return ['id', 'name', 'attr'] @staticmethod def to_json(model): fields = PyOrmModel.fields() json_data = {} for field in fields: json_data[field] = model.__getattribute__(field) return json_data @staticmethod def from_json(data: dict): fields = PyOrmModel.fields() model = PyOrmModel() for field in fields: if field in data: model.__setattr__(field, data[field]) return model
3.數(shù)據(jù)庫操作的封裝,與參考的文章不同,我是直接調(diào)用了session,從而使調(diào)用方不需要關(guān)注model層,減少耦合。
# py_orm_model_op.py from sqlachlemy_lab.model import db_session from sqlachlemy_lab.model import PyOrmModel class PyOrmModelOp: def __init__(self): pass @staticmethod def save_data(data: dict): with db_session() as session: model = PyOrmModel.from_json(data) session.add(model) # 查詢操作,不需要commit @staticmethod def query_data(pid: int): data_list = [] with db_session(commit=False) as session: data = session.query(PyOrmModel).filter(PyOrmModel.id == pid) for d in data: data_list.append(PyOrmModel.to_json(d)) return data_list
4.調(diào)用方:
# main.py from sqlachlemy_lab.model_op import PyOrmModelOp if __name__ == '__main__': PyOrmModelOp.save_data({'id': 1, 'name': 'test', 'attr': {}})
讀到這里,這篇“怎么使用SQL的Python神器ORM框架”文章已經(jīng)介紹完畢,想要掌握這篇文章的知識點(diǎn)還需要大家自己動手實(shí)踐使用過才能領(lǐng)會,如果想了解更多相關(guān)內(nèi)容的文章,歡迎關(guān)注創(chuàng)新互聯(lián)行業(yè)資訊頻道。
名稱欄目:怎么使用SQL的Python神器ORM框架
本文鏈接:http://www.ef60e0e.cn/article/jiigep.html