第 5 章：数据库
大部分程序都需要保存数据，所以不可避免要使用数据库。用来操作数据库的数据库管理系统（DBMS）有很多选择，对于不同类型的程序，不同的使用场景，都会有不同的选择。在这个教程中，我们选择了属于关系型数据库管理系统（RDBMS）的 SQLite，它基于文件，不需要单独启动数据库服务器，适合在开发时使用，或是在数据库操作简单、访问量低的程序中使用。
使用 SQLAlchemy 操作数据库
为了简化数据库操作，我们将使用 SQLAlchemy——一个 Python 数据库工具（ORM，即对象关系映射）。借助 SQLAlchemy，你可以通过定义 Python 类来表示数据库里的一张表（类属性表示表中的字段 / 列），通过对这个类进行各种操作来代替写 SQL 语句。这个类我们称之为模型类，类中的属性我们将称之为字段。
首先安装它：
1
(env) $ pip install flask-sqlalchemy
Copied!
大部分扩展都需要执行一个“初始化”操作。你需要导入扩展类，实例化并传入 Flask 程序实例：
1
from flask_sqlalchemy import SQLAlchemy # 导入扩展类
2
3
app = Flask(__name__)
4
5
db = SQLAlchemy(app) # 初始化扩展，传入程序实例 app
Copied!
设置数据库 URI
为了设置 Flask、扩展或是我们程序本身的一些行为，我们需要设置和定义一些配置变量。Flask 提供了一个统一的接口来写入和获取这些配置变量：
Flask.config 字典。配置变量的名称必须使用大写，写入配置的语句一般会放到扩展类实例化语句之前。下面写入了一个
SQLALCHEMY_DATABASE_URI 变量来告诉 SQLAlchemy 数据库连接地址：1
import os
2
3
# ...
4
5
app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:////' + os.path.join(app.root_path, 'data.db')
Copied!
注意 这个配置变量的最后一个单词是 URI，而不是 URL。
对于这个变量值，不同的 DBMS 有不同的格式，对于 SQLite 来说，这个值的格式如下：
1
sqlite:////数据库文件的绝对地址
Copied!
数据库文件一般放到项目根目录即可，
app.root_path 返回程序实例所在模块的路径（目前来说，即项目根目录），我们使用它来构建文件路径。数据库文件的名称和后缀你可以自由定义，一般会使用 .db、.sqlite 和 .sqlite3 作为后缀。另外，如果你使用 Windows 系统，上面的 URI 前缀部分只需要写入三个斜线（即
sqlite:///）。在本书的示例程序代码里，做了一些兼容性处理，另外还新设置了一个配置变量，实际的代码如下：app.py：数据库配置
1
import os
2
import sys
3
4
from flask import Flask
5
from flask_sqlalchemy import SQLAlchemy
6
7
WIN = sys.platform.startswith('win')
8
if WIN: # 如果是 Windows 系统，使用三个斜线
9
prefix = 'sqlite:///'
10
else: # 否则使用四个斜线
11
prefix = 'sqlite:////'
12
13
app = Flask(__name__)
14
app.config['SQLALCHEMY_DATABASE_URI'] = prefix + os.path.join(app.root_path, 'data.db')
15
app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False # 关闭对模型修改的监控
16
# 在扩展类实例化前加载配置
17
db = SQLAlchemy(app)
Copied!
如果你固定在某一个操作系统上进行开发，部署时也使用相同的操作系统，那么可以不用这么做，直接根据你的需要写出前缀即可。
创建数据库模型
在 Watchlist 程序里，目前我们有两类数据要保存：用户信息和电影条目信息。下面分别创建了两个模型类来表示这两张表：
app.py：创建数据库模型
1
class User(db.Model): # 表名将会是 user（自动生成，小写处理）
2
id = db.Column(db.Integer, primary_key=True) # 主键
3
name = db.Column(db.String(20)) # 名字
4
5
class Movie(db.Model): # 表名将会是 movie
6
id = db.Column(db.Integer, primary_key=True) # 主键
7
title = db.Column(db.String(60)) # 电影标题
8
year = db.Column(db.String(4)) # 电影年份
Copied!
模型类的编写有一些限制：
- 模型类要声明继承
db.Model。 - 每一个类属性（字段）要实例化
db.Column，传入的参数为字段的类型，下面的表格列出了常用的字段类。 - 在
db.Column()中添加额外的选项（参数）可以对字段进行设置。比如，primary_key设置当前字段是否为主键。除此之外，常用的选项还有nullable（布尔值，是否允许为空值）、index（布尔值，是否设置索引）、unique（布尔值，是否允许重复值）、default（设置默认值）等。
常用的字段类型如下表所示：
字段类
说明
db.Integer
整型
db.String (size)
字符串，size 为最大长度，比如
db.String(20)db.Text
长文本
db.DateTime
时间日期，Python
datetime 对象db.Float
浮点数
db.Boolean
布尔值
创建数据库表
模型类创建后，还不能对数据库进行操作，因为我们还没有创建表和数据库文件。下面在 Python Shell 中创建了它们：
1
(env) $ flask shell
2
>>> from app import db
3
>>> db.create_all()
Copied!
打开文件管理器，你会发现项目根目录下出现了新创建的数据库文件 data.db。这个文件不需要提交到 Git 仓库，我们在 .gitignore 文件最后添加一行新规则：
1
*.db
Copied!
如果你改动了模型类，想重新生成表模式，那么需要先使用
db.drop_all() 删除表，然后重新创建：1
>>> db.drop_all()
2
>>> db.create_all()
Copied!
提示 上面打开 Python Shell 使用的是flask shell命令，而不是python。使用这个命令启动的 Python Shell 激活了“程序上下文”，它包含一些特殊变量，这对于某些操作是必须的（比如上面的db.create_all()调用）。请记住，后续的 Python Shell 都会使用这个命令打开。
和
flask shell类似，我们可以编写一个自定义命令来自动执行创建数据库表操作：app.py：自定义命令 initdb
1
import click
2
3
@app.cli.command() # 注册为命令
4
@click.option('--drop', is_flag=True, help='Create after drop.') # 设置选项
5
def initdb(drop):
6
"""Initialize the database."""
7
if drop: # 判断是否输入了选项
8
db.drop_all()
9
db.create_all()
10
click.echo('Initialized database.') # 输出提示信息
Copied!
默认情况下，函数名称就是命令的名字，现在执行
flask initdb 命令就可以创建数据库表：1
(env) $ flask initdb
Copied!
使用
--drop 选项可以删除表后重新创建：1
(env) $ flask initdb --drop
Copied!
创建、读取、更新、删除
在前面打开的 Python Shell 里，我们来测试一下常见的数据库操作。你可以跟着示例代码来操作，也可以自由练习。
创建
下面的操作演示了如何向数据库中添加记录：
1
>>> from app import User, Movie # 导入模型类
2
>>> user = User(name='Grey Li') # 创建一个 User 记录
3
>>> m1 = Movie(title='Leon', year='1994') # 创建一个 Movie 记录
4
>>> m2 = Movie(title='Mahjong', year='1996') # 再创建一个 Movie 记录
5
>>> db.session.add(user) # 把新创建的记录添加到数据库会话
6
>>> db.session.add(m1)
7
>>> db.session.add(m2)
8
>>> db.session.commit() # 提交数据库会话，只需要在最后调用一次即可
Copied!
提示 在实例化模型类的时候，我们并没有传入id字段（主键），因为 SQLAlchemy 会自动处理这个字段。
最后一行
db.session.commit() 很重要，只有调用了这一行才会真正把记录提交进数据库，前面的 db.session.add() 调用是将改动添加进数据库会话（一个临时区域）中。读取
通过对模型类的
query 属性调用可选的过滤方法和查询方法，我们就可以获取到对应的单个或多个记录（记录以模型类实例的形式表示）。查询语句的格式如下：1
<模型类>.query.<过滤方法（可选）>.<查询方法>
Copied!
下面是一些常用的过滤方法：
过滤方法
说明
filter()
使用指定的规则过滤记录，返回新产生的查询对象
filter_by()
使用指定规则过滤记录（以关键字表达式的形式），返回新产生的查询对象
order_by()
根据指定条件对记录进行排序，返回新产生的查询对象
group_by()
根据指定条件对记录进行分组，返回新产生的查询对象
下面是一些常用的查询方法：
查询方法
说明
all()
返回包含所有查询记录的列表
first()
返回查询的第一条记录，如果未找到，则返回 None
get(id)
传入主键值作为参数，返回指定主键值的记录，如果未找到，则返回 None
count()
返回查询结果的数量
first_or_404()
返回查询的第一条记录，如果未找到，则返回 404 错误响应
get_or_404(id)
传入主键值作为参数，返回指定主键值的记录，如果未找到，则返回 404 错误响应
paginate()
返回一个 Pagination 对象，可以对记录进行分页处理
下面的操作演示了如何从数据库中读取记录，并进行简单的查询：
1
>>> from app import Movie # 导入模型类
2
>>> movie = Movie.query.first() # 获取 Movie 模型的第一个记录（返回模型类实例）
3
>>> movie.title # 对返回的模型类实例调用属性即可获取记录的各字段数据
4
'Leon'
5
>>> movie.year
6
'1994'
7
>>> Movie.query.all() # 获取 Movie 模型的所有记录，返回包含多个模型类实例的列表
8
[<Movie 1>, <Movie 2>]
9
>>> Movie.query.count() # 获取 Movie 模型所有记录的数量
10
2
11
>>> Movie.query.get(1) # 获取主键值为 1 的记录
12
<Movie 1>
13
>>> Movie.query.filter_by(title='Mahjong').first() # 获取 title 字段值为 Mahjong 的记录
14
<Movie 2>
15
>>> Movie.query.filter(Movie.title=='Mahjong').first() # 等同于上面的查询，但使用不同的过滤方法
16
<Movie 2>
Copied!
提示 我们在说 Movie 模型的时候，实际指的是数据库中的 movie 表。表的实际名称是模型类的小写形式（自动生成），如果你想自己指定表名，可以定义__tablename__属性。
更新
下面的操作更新了
Movie 模型中主键为 2 的记录：1
>>> movie = Movie.query.get(2)
2
>>> movie.title = 'WALL-E' # 直接对实例属性赋予新的值即可
3
>>> movie.year = '2008'
4
>>> db.session.commit() # 注意仍然需要调用这一行来提交改动
Copied!
删除
下面的操作删除了
Movie 模型中主键为 1 的记录：1
>>> movie = Movie.query.get(1)
2
>>> db.session.delete(movie) # 使用 db.session.delete() 方法删除记录，传入模型实例
3
>>> db.session.commit() # 提交改动
Copied!
在程序里操作数据库
经过上面的一番练习，我们可以在 Watchlist 里进行实际的数据库操作了。
在主页视图读取数据库记录
因为设置了数据库，负责显示主页的
index 可以从数据库里读取真实的数据：1
@app.route('/')
2
def index():
3
user = User.query.first() # 读取用户记录
4
movies = Movie.query.all() # 读取所有电影记录
5
return render_template('index.html', user=user, movies=movies)
Copied!
在
index 视图中，原来传入模板的 name 变量被 user 实例取代，模板 index.html 中的两处 name 变量也要相应的更新为 user.name 属性：1
{{ user.name }}'s Watchlist
Copied!
生成虚拟数据
因为有了数据库，我们可以编写一个命令函数把虚拟数据添加到数据库里。下面是用来生成虚拟数据的命令函数：
app.py：创建自定义命令 forge
1
import click
2
3
@app.cli.command()
4
def forge():
5
"""Generate fake data."""
6
db.create_all()
7
8
# 全局的两个变量移动到这个函数内
9
name = 'Grey Li'
10
movies = [
11
{'title': 'My Neighbor Totoro', 'year': '1988'},
12
{'title': 'Dead Poets Society', 'year': '1989'},
13
{'title': 'A Perfect World', 'year': '1993'},
14
{'title': 'Leon', 'year': '1994'},
15
{'title': 'Mahjong', 'year': '1996'},
16
{'title': 'Swallowtail Butterfly', 'year': '1996'},
17
{'title': 'King of Comedy', 'year': '1999'},
18
{'title': 'Devils on the Doorstep', 'year': '1999'},
19
{'title': 'WALL-E', 'year': '2008'},
20
{'title': 'The Pork of Music', 'year': '2012'},
21
]
22
23
user = User(name=name)
24
db.session.add(user)
25
for m in movies:
26
movie = Movie(title=m['title'], year=m['year'])
27
db.session.add(movie)
28
29
db.session.commit()
30
click.echo('Done.')
Copied!
现在执行
flask forge 命令就会把所有虚拟数据添加到数据库里：1
(env) $ flask forge
Copied!
本章小结
本章我们学习了使用 SQLAlchemy 操作数据库，后面你会慢慢熟悉相关的操作。结束前，让我们提交代码：
1
$ git add .
2
$ git commit -m "Add database support with Flask-SQLAlchemy"
3
$ git push
Copied!
进阶提示
- 在生产环境，你可以更换更合适的 DBMS，因为 SQLAlchemy 支持多种 SQL 数据库引擎，通常只需要改动非常少的代码。
- 阅读 SQLAlchemy 官方文档和教程详细了解它的用法。注意我们在这里使用 Flask-SQLAlchemy 来集成它，所以用法和单独使用 SQLAlchemy 有一些不同。作为参考，你可以同时阅读 Flask-SQLAlchemy 官方文档。
Last modified 1yr ago