定义并访问数据库

这个应用将会使用 SQLite 数据库来存储用户和帖子。Python 在自带的 sqlite3 模块内置了对 SQLite 的支持。

SQLite 很方便,因为它不需要设置一个额外的数据库服务器,而且 Python 内置了对它的支持。然而,如果并发的请求试图同时写入数据库,它们会让应用变慢,因为每一个写入操作会依次进行。小的应用不会注意到这一点。当你的应用变大,你也许想要切换到不同的数据库。

这个教程没有详细介绍 SQL。如果你对它不熟悉,SQLite 文档描述了 这个语言

连接数据库

使用 SQLite 数据库(和其他大多数 Python 数据库包)时,要做的第一件事是和它建立一个连接。任何查询和操作都使用这个连接进行,当工作完成后它会被关闭。

在 web 应用中,这个连接通常会绑定到请求上。它会在处理一个请求时被创建,然后在响应发送之前被关闭。

flaskr/db.py
import sqlite3

import click
from flask import current_app, g
from flask.cli import with_appcontext


def get_db():
    if 'db' not in g:
        g.db = sqlite3.connect(
            current_app.config['DATABASE'],
            detect_types=sqlite3.PARSE_DECLTYPES
        )
        g.db.row_factory = sqlite3.Row

    return g.db


def close_db(e=None):
    db = g.pop('db', None)

    if db is not None:
        db.close()

g 是一个特殊的对象,它对每一个请求都是唯一的。它被用来存储在处理请求时可能会被多个函数访问的数据。如果 get_db 在同一个请求中被二次调用,该连接会被存储和复用,而不是创建一个新的连接。

current_app 是另一个特殊的对象,它指向处理请求的 Flask 应用。因为你使用了一个应用工厂,所以当写其他部分代码时没有应用对象。当应用被创建并且正在处理一个请求时,get_db 将会被调用,所以可以使用 current_app

sqlite3.connect() 建立一个连接到配置键 DATABASE 指向的文件。这个文件还不存在,直到你之后初始化数据库才会被创建。

sqlite3.Row 告诉这个连接返回行为和字典一样的行。这允许你通过名称访问列。

close_db 通过判断 g.db 是否被设置来检查一个连接是否被创建。如果连接存在,它将被关闭。接下来,你将会在应用工厂里把 close_db 函数引入你的应用,以便在每个请求之后调用它。

创建表

在 SQLite 中,数据被存储在 中。在你可以存储和获取数据之前,需要先创建它们。Flaskr 将会存储用户到 user 表,存储帖子到 post 表。创建一个文件来存储创建空表所需的 SQL 命令:

flaskr/schema.sql
DROP TABLE IF EXISTS user;
DROP TABLE IF EXISTS post;

CREATE TABLE user (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  username TEXT UNIQUE NOT NULL,
  password TEXT NOT NULL
);

CREATE TABLE post (
  id INTEGER PRIMARY KEY AUTOINCREMENT,
  author_id INTEGER NOT NULL,
  created TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
  title TEXT NOT NULL,
  body TEXT NOT NULL,
  FOREIGN KEY (author_id) REFERENCES user (id)
);

把将会运行这些 SQL 命令的的 Python 函数添加到 db.py 文件:

flaskr/db.py
def init_db():
    db = get_db()

    with current_app.open_resource('schema.sql') as f:
        db.executescript(f.read().decode('utf8'))


@click.command('init-db')
@with_appcontext
def init_db_command():
    """Clear the existing data and create new tables."""
    init_db()
    click.echo('Initialized the database.')

open_resource() 打开一个相对于 flaskr 包的文件,这很有用,因为当后续部署应用的时候你不用知道文件的位置在哪里。get_db 返回一个数据库连接,用来执行从文件中读取的命令。

click.command() 定义了一个名为 init-db 的命令行命令,这个命令会调用 init_db 函数并向用户显示一个成功消息。你可以阅读 Command Line Interface 学习更多关于编写命令的内容。

注册到应用

close_dbinit_db_command 函数需要被注册到应用实例;否则的话,他们不会被应用使用。然而,因为你正在使用工厂函数,该实例没法在这些函数里使用。取而代之的是,写一个函数,接受一个应用作为参数并实现注册。

flaskr/db.py
def init_app(app):
    app.teardown_appcontext(close_db)
    app.cli.add_command(init_db_command)

app.teardown_appcontext() 告诉 Flask在返回响应以后进行清理时调用该函数。

app.cli.add_command() 添加一个新的命令,可以使用 flask 命令调用。

在工厂里导入并调用这个函数。把新的代码放到工厂函数的末尾,在返回应用之前。

flaskr/__init__.py
def create_app():
    app = ...
    # existing code omitted

    from . import db
    db.init_app(app)

    return app

初始化数据库文件

现在 init-db 已经注册到应用,你可以使用 flask 命令调用它,类似上一章的 run 命令。

备注

如果你仍然运行着上一章介绍的服务器,你可以停止服务器,或是在新的终端运行这个命令。如果你使用一个新的终端,记得切换到项目目录,激活在 安装 里描述的虚拟环境。你还将需要设置上一章介绍的 FLASK_APPFLASK_ENV

运行 init-db 命令:

$ flask init-db
Initialized the database.

现在在你项目的 instance 文件夹中会有一个 flaskr.sqlite 文件。

继续阅读 蓝图和视图