CategoryResourceRepost/极客时间专栏/geek/SQL必知必会/第一章:SQL语法基础篇/18丨SQLAlchemy:如何使用Python ORM框架来操作MySQL?.md
louzefeng bf99793fd0 del
2024-07-09 18:38:56 +00:00

14 KiB
Raw Blame History

上节课我介绍了Python DB API规范的作用以及如何使用MySQL官方的mysql-connector驱动来完成数据库的连接和使用。在项目比较小的时候我们可以直接使用SQL语句通过mysql-connector完成与MySQL的交互但是任何事物都有两面性随着项目规模的增加代码会越来越复杂维护的成本也越来越高这时mysql-connector就不够用了我们需要更好的设计模式。

Python还有另一种方式可以与MySQL进行交互这种方式采用的是ORM框架。我们今天就来讲解如何使用ORM框架操作MySQL那么今天的课程你需要掌握以下几个方面的内容

  1. 什么是ORM框架以及为什么要使用ORM框架
  2. Python中的ORM框架都有哪些
  3. 如何使用SQLAlchemy来完成与MySQL的交互

我们为什么要使用ORM框架

在讲解ORM框架之前我们需要先了解什么是持久化。如下图所示持久化层在业务逻辑层和数据库层起到了衔接的作用它可以将内存中的数据模型转化为存储模型或者将存储模型转化为内存中的数据模型。

你可能会想到我们在讲事务的4大特性ACID时提到过持久性。你可以简单地理解为持久性就是将对象数据永久存储在数据库中。通常我们将数据库的作用理解为永久存储将内存理解为暂时存储。我们在程序的层面操作数据其实都是把数据放到内存中进行处理如果需要数据就会通过持久化层从数据库中取数据如果需要保存数据就是将对象数据通过持久化层存储到数据库中。

那么ORM解决的是什么问题呢它提供了一种持久化模式可以高效地对数据库进行访问。ORM的英文是Object Relation Mapping中文叫对象关系映射。它是RDBMS和业务实体对象之间的一个映射从图中你也能看到它可以把底层的RDBMS封装成业务实体对象提供给业务逻辑层使用。程序员往往关注业务逻辑层面而不是底层数据库该如何访问以及如何编写SQL语句获取数据等等。采用ORM就可以从数据库的设计层面转化成面向对象的思维。

我在开篇的时候提到过随着项目规模的增大在代码层编写SQL语句访问数据库会降低开发效率也会提升维护成本因此越来越多的开发人员会采用基于ORM的方式来操作数据库。这样做的好处就是一旦定义好了对象模型就可以让它们简单可复用从而不必关注底层的数据库访问细节我们只要将注意力集中到业务逻辑层面就可以了。由此还可以带来另一点好处那就是即便数据库本身进行了更换在业务逻辑代码上也不会有大的调整。这是因为ORM抽象了数据的存取同时也兼容多种DBMS我们不用关心底层采用的到底是哪种DBMS是MySQLSQL ServerPostgreSQL还是SQLite。

但没有一种模式是完美的采用ORM当然也会付出一些代价比如性能上的一些损失。面对一些复杂的数据查询ORM会显得力不从心。虽然可以实现功能但相比于直接编写SQL查询语句来说ORM需要编写的代码量和花费的时间会比较多这种情况下直接编写SQL反而会更简单有效。

其实你也能看出来,没有一种方式是一劳永逸的,在实际工作中,我们需要根据需求选择适合的方式。

Python中的ORM框架都有哪些

ORM框架帮我们适配了各种DBMS同时我们也可以选择不同的ORM框架。如果你用Python的话有三种主流的ORM框架。

第一个是Django它是Python的WEB应用开发框架本身走大而全的方式。Django采用了MTV的框架模式包括了Model模型View视图和Template模版。Model模型只是Django的一部分功能我们可以通过它来实现数据库的增删改查操作。

一个Model映射到一个数据表如下图所示


从这张图上你能直观地看到ORM的作用就是建立了对象关系映射。模型的每个属性代表数据表中的一个字段我们通过操作类实例对象对数据表中的数据行进行增删改查等操作。

第二个是SQLALchemy它也是Python中常用的ORM框架之一。它提供了SQL工具包及ORM工具如果你想用支持ORM和支持原生SQL两种方式的工具那么SQLALchemy是很好的选择。另外SQLALchemy的社区更加活跃这对项目实施会很有帮助。

第三个是peewee这是一个轻量级的ORM框架简单易用。peewee采用了Model类、Field实例和Model实例来与数据库建立映射关系从而完成面向对象的管理方式。使用起来方便学习成本也低。

如何使用SQLAlchemy来操作MySQL

下面我们来看下如何使用SQLAlchemy工具对player数据表进行增删改查在使用前你需要先安装相应的工具包

pip install sqlalchemy
初始化数据库连接
from sqlalchemy import create_engine
# 初始化数据库连接,修改为你的数据库用户名和密码
engine = create_engine('mysql+mysqlconnector://root:password@localhost:3306/wucai')

create_engine的使用方法类似我们在上篇文章中提到的mysql.connector都需要提供数据库+数据库连接框架,即对应的是mysql+mysqlconnector,后面的是用户名:密码@IP地址:端口号/数据库名称

创建模型

我们已经创建了player数据表这里需要创建相应的player模型。

# 定义Player对象:
class Player(Base):
    # 表的名字:
    __tablename__ = 'player'
 
    # 表的结构:
    player_id = Column(Integer, primary_key=True, autoincrement=True)
    team_id = Column(Integer)
    player_name = Column(String(255))
    height = Column(Float(3,2))

这里需要说明的是,__tablename__ 指明了模型对应的数据表名称即player数据表。同时我们在Player模型中对采用的变量名进行定义变量名需要和数据表中的字段名称保持一致否则会找不到数据表中的字段。在SQLAlchemy中我们采用Column对字段进行定义常用的数据类型如下


除了指定Column的数据类型以外我们也可以指定Column的参数这些参数可以帮我们对对象创建列约束


这里需要说明的是如果你使用相应的数据类型那么需要提前在SQLAlchemy中进行引用比如

from sqlalchemy import Column, String, Integer, Float

对数据表进行增删改查

假设我们想给player表增加一名新球员姓名为“约翰·科林斯”球队ID为1003即亚特兰大老鹰身高为2.08。代码如下:

# 创建DBSession类型:
DBSession = sessionmaker(bind=engine)
# 创建session对象:
session = DBSession()


# 创建Player对象:
new_player = Player(team_id = 1003, player_name = "约翰-科林斯", height = 2.08)
# 添加到session:
session.add(new_player)
# 提交即保存到数据库:
session.commit()
# 关闭session:
session.close()

这里我们首先需要初始化DBSession相当于创建一个数据库的会话实例session。通过session来完成新球员的添加。对于新球员的数据我们可以通过Player类来完成创建在参数中指定相应的team_id, player_name, height即可。

然后把创建好的对象new_player添加到session中提交到数据库即可完成添加数据的操作。

接着,我们来看一下如何查询数据。

添加完插入的新球员之后,我们可以查询下身高 ≥ 2.08m的球员都有哪些,代码如下:

#增加to_dict()方法到Base类中
def to_dict(self):
    return {c.name: getattr(self, c.name, None)
            for c in self.__table__.columns}
#将对象可以转化为dict类型
Base.to_dict = to_dict
# 查询身高>=2.08的球员有哪些
rows = session.query(Player).filter(Player.height >= 2.08).all()
print([row.to_dict() for row in rows])

运行结果:

[{'player_id': 10003, 'team_id': 1001, 'player_name': '安德烈-德拉蒙德', 'height': Decimal('2.1100000000')}, {'player_id': 10004, 'team_id': 1001, 'player_name': '索恩-马克', 'height': Decimal('2.1600000000')}, {'player_id': 10009, 'team_id': 1001, 'player_name': '扎扎-帕楚里亚', 'height': Decimal('2.1100000000')}, {'player_id': 10010, 'team_id': 1001, 'player_name': '乔恩-洛伊尔', 'height': Decimal('2.0800000000')}, {'player_id': 10011, 'team_id': 1001, 'player_name': '布雷克-格里芬', 'height': Decimal('2.0800000000')}, {'player_id': 10015, 'team_id': 1001, 'player_name': '亨利-埃伦森', 'height': Decimal('2.1100000000')}, {'player_id': 10023, 'team_id': 1002, 'player_name': '多曼塔斯-萨博尼斯', 'height': Decimal('2.1100000000')}, {'player_id': 10024, 'team_id': 1002, 'player_name': '迈尔斯-特纳', 'height': Decimal('2.1100000000')}, {'player_id': 10032, 'team_id': 1002, 'player_name': 'TJ-利夫', 'height': Decimal('2.0800000000')}, {'player_id': 10033, 'team_id': 1002, 'player_name': '凯尔-奥奎因', 'height': Decimal('2.0800000000')}, {'player_id': 10037, 'team_id': 1002, 'player_name': '伊凯·阿尼博古', 'height': Decimal('2.0800000000')}, {'player_id': 10038, 'team_id': 1003, 'player_name': '约翰-科林斯', 'height': Decimal('2.0800000000')}]

如果我们对整个数据行进行查询,采用的是session.query(Player)相当于使用的是SELECT *。这时如果我们想要在Python中对query结果进行打印可以对Base类增加to_dict()方法相当于将对象转化成了Python的字典类型。

在进行查询的时候我们使用的是filter方法对应的是SQL中的WHERE条件查询。除此之外filter也支持多条件查询。

如果是AND的关系比如我们想要查询身高 ≥ 2.08,同时身高 ≤ 2.10的球员,可以写成下面这样:

rows = session.query(Player).filter(Player.height >=2.08, Player.height <=2.10).all()

如果是OR的关系比如我们想要查询身高 ≥ 2.08,或者身高 ≤ 2.10的球员,可以写成这样:

rows = session.query(Player).filter(or_(Player.height >=2.08, Player.height <=2.10)).all()

这里我们使用了SQLAlchemy的or_操作符在使用它之前你需要进行引入from sqlalchemy import or_

除了多条件查询SQLAlchemy也同样支持分组操作、排序和返回指定数量的结果。

比如我想要按照team_id进行分组同时筛选分组后数据行数大于5的分组并且按照分组后数据行数递增的顺序进行排序显示team_id字段以及每个分组的数据行数。那么代码如下

from sqlalchemy import func
rows = session.query(Player.team_id, func.count(Player.player_id)).group_by(Player.team_id).having(func.count(Player.player_id)>5).order_by(func.count(Player.player_id).asc()).all()
print(rows)

运行结果:

[(1001, 20), (1002, 17)]

这里有几点需要注意:

  1. 我们把需要显示的字段Player.team_id, func.count(Player.player_id)作为query的参数其中我们需要用到sqlalchemy的func类它提供了各种聚集函数比如func.count函数。
  2. 在query()后面使用了group_by()进行分组参数设置为Player.team_id字段再使用having对分组条件进行筛选参数为func.count(Player.player_id)>5
  3. 使用order_by进行排序参数为func.count(Player.player_id).asc(),也就是按照分组后的数据行数递增的顺序进行排序,最后使用.all()方法需要返回全部的数据。

你能看到SQLAlchemy使用的规则和使用SELECT语句的规则差不多只是封装到了类中作为方法进行调用。

接着我们再来看下如何删除数据。如果我们想要删除某些数据需要先进行查询然后再从session中把这些数据删除掉。

比如我们想要删除姓名为约翰·科林斯的球员首先我们需要进行查询然后从session对象中进行删除最后进行commit提交代码如下

row = session.query(Player).filter(Player.player_name=='约翰-科林斯').first()
session.delete(row)
session.commit()
session.close()

需要说明的是,判断球员姓名是否为约翰·科林斯,这里需要使用(==)。

同样如果我们想要修改某条数据也需要进行查询然后再进行修改。比如我想把球员索恩·马克的身高改成2.17那么执行完之后直接对session对象进行commit操作代码如下

row = session.query(Player).filter(Player.player_name=='索恩-马克').first()
row.height = 2.17
session.commit()
session.close()

总结

今天我们使用SQLAlalchemy对MySQL进行了操作你能看到这些实现并不复杂只是需要事先掌握一些使用方法尤其是如何创建seesion对象以及如何通过session对象来完成对数据的增删改查等操作。建议你把文章里的代码都跑一遍在运行的过程中一定会有更深入的体会。

当然除了学习掌握SQLAlalchemy这个Python ORM工具以外我还希望你能了解到ORM的价值和不足。如果项目本身不大那么自己动手写SQL语句会比较简单你可以不使用ORM工具而是直接使用上节课讲到的mysql-connector。但是随着项目代码量的增加为了在业务逻辑层与数据库底层进行松耦合采用ORM框架是更加适合的。


我今天讲解了SQLAlalchemy工具的使用为了更好地让你理解我出一道练习题吧。还是针对player数据表请你使用SQLAlalchemy工具查询身高为2.08米的球员并且将这些球员的身高修改为2.09。

欢迎你在评论区写下你的答案,也欢迎把这篇文章分享给你的朋友或者同事,一起交流。