2020-12-11

SQLAlchemy-ORM 介绍

ORM 介绍

随着项目越来越大，采用原生 SQL 的方式在代码中会出现大量的SQL语句，对项目的进展非常不利。

• SQL 语句重复利用率不高，越复杂的SQL语句条件越多，代码越长。会出现很多相近似的SQL语句。
• 很多SQL语句是在业务逻辑中拼写出来的，如果有数据需要更改，就要去修改这些逻辑，很容易漏掉某些SQL语句的修改。
• 写 SQL 时容易忽略 web 安全问题。

ORM：Objiect Relationship Mapping，对象关系映射，通过ORM 我们可以通过类的方式去操作数据库，而不用写原生的 SQL 语句。通过把表映射成类，把行作为实例，把字段作为属性，ORM 在执行对象操作时候最终还是会把对应的操作转换为数据库原生语句。

使用 ORM 的优点：

• 易用性：使用 ORM 做数据库的开发可以有效的减少 SQL 语句，写出来的模型也更加直观。
• 性能损耗小
• 设计灵活：可以轻松写出复杂的查询
• 可移植性：SQLAlchemy 封装了底层的数据库实现，支持多个关系型数据库，包括 MySQL、SQLite。

使用 SQLAlchemy

要使用 ORM 来操作数据库，首先需要创建一个类来与对应的表进行映射。现在以 User 表来做为例子，它有自增长的 id、name、fullname、password这些字段，那么对应的类为：

from sqlalchemy import Column,Integer,String
from constants import DB_URI
from sqlalchemy import create_engine
from sqlalchemy.ext.declarative import declarative_base

engine=create_engine(DB_URI,echo=True)
# 所有的类都要继承自 'declarative_base' 这个函数生成的基类
Base=declarative_base(engine)
class User(Base):
    # 定义表名为users
    __tablename__='users'
   # 将 id 设置为主键，并且默认是自增长的
   id=Column(Integer,primary_key=True)
   # 将 name 字段，字段类型，最大的长度的50个字符。
   name=Column(String(50))
   fullname=Column(String(50))   
   password=Column(String(100))

   # 让打印出来的数据更好看，可选的
   def __repr__(self):
       return "<User(id='%s',name='%s',fullname='%s',password='%s')>" % (self.id,self.name,self.fullname,self.password)

SQLAlchemy 会自动的设置第一个 Integer 的主键并且没有被标记为外键的字段添加自增长的属性。因此以上例子中的 id 自动的变成自增长的。以上创建完和表映射的类后，还没有真正的映射到数据库当中，执行以下代码将类映射到数据库中。

Base.metadata.create_all()

在创建完数据表，并且做完和数据库的映射后，接下来让我们添加数据进去。

ed_user=User(name='ed',fullname='Ed Jone',password='edspassword')

# 打印名字
print(ed_user.name)

# 打印密码
print(ed_user.password)

# 打印id
print(ed_user.id)

可以看到，name 和 password 都能正常的打印，唯独 id 为 None,这是因为 id 是一个自增长的主键，还未插入到数据库中,id 是不存在的。接下来我们把创建的数据插入到数据库中。和数据库打交道的，是一个叫做 Session 的对象。

from sqlalchemy.orm import sessionmaker
Session=sessionmaker(nind=engine)

# 或者
# Session=sessionmaker()
# Session.configure(bind=engine)

session=Session()
ed_user=User(name='ed',fullname='Ed Jones',password='edpassword')
session.add(ed_user)

现在只是把数据添加到 session 中，但是并没有真正的把数据存储到数据库中。如果需要把书库存储到数据库中，还要做一次 commit 操作。

session.commit()

# 打印 ed_user 的 id
print(ed_user.id)

这时候，ed_user就已经有id。说明已经插入到数据库中了。已经插入到数据库中了。有人肯定有疑问了，为什么添加到 session 中后还要做一次commit 操作呢，这是因为，在SQLALchemy 的ORM 实现中，在做commit 操作之前，所有的操作都是在事物中进行的，因此如果你要将事物中的操作真正的映射到数据库中，还需要做 commit 操作。既然用到了事物，这里就并不能避免的提到一个回滚操作了，那么看以下代码展示了如何使用回滚。

# 修改ed_user 的用户名
ed_user.name='Edwardo'

# 创建一个新的用户
fake_user=User(name="fakeuser",fullname="Invalid",password="12345")

# 将新创建的 fake_user 添加到 session 中
session.add(fake_user)

# 判断 'fake_user' 是否在 'session' 中存在
print(fake_user in session)

# 从数据库中查找 name=Edwardo 的用户
tmp_user=session.query(User).filter_by(name='Edwardo')

# 打印 tmp_user 的 name
print(tmp_user)

# 打印出查找到的 tmp_user 对象，注意这个对象的 name 属性已经在事物中被修改为 Edwardo 了。
> <User(name='Edwardo',fullname='Ed Jones',password='edspassword')>

# 刚刚所有的操作都是在事物中进行的，现在来做回滚操作。
session.rollback()

# 在打印 tmp_user
print(tmp_user)

# 再看 fake_user 是否还在 session 中
print(fake_user in session)

接下来看下如何进行查找操作，查找操作是通过session.query()方法实现的，这个方法会返回一个Query 对象，Query 对象相当于一个数组，装载了查找出来的数据，并且可以进行迭代。具体里面装的什么数据，就要看向 session.query() 方法传的什么参数了，如果只是传入一个 ORM 的类名作为参数，那么提取出来的数据就是都是这个类的实例。

for instance in session.query(User).oeder_by(User.id):
    print(instance)

如果传递了两个及其两个以上的对象，或者是传递的是 ORM 类的属性，那么查找出来的就是元组。

for instance in session.query(User.name):
    print(instance)

以及：

for instance in session.query(User.name,User.fullname):
    print(instance)

或者是：

for instance in session.query(User,User.name).all():
    print(instance)

另外，还可以对查找的结果（Query）做切片 操作

for instance in session.query(User).order_by(User.id)[1:3]
    instance

如果想对结果进行过滤，可以使用 filter_by 和 filter 两个方法，这两个方法都是用来做过滤的，区别在于，filter_by 是传入关键字参数，filter 是传入条件判断，并且 filter 能够传入的条件更多灵活。

# 第一种：使用 filter_by 过滤：
for name in session.query(User.name).filter_by(fullname='Ed Jone'):
    print(name)

# 第二种：使用 filter 过滤：
for name in session.query(User.name).filter(User.fullname=='Ed Jones'):
    print(name)