定义并访问数据库

该应用程序将使用 SQLite 数据库来存储用户和帖子。Python 在 sqlite3 模块中内置了对 SQLite 的支持。

SQLite 很方便,因为它不需要设置单独的数据库服务器,并且内置于 Python 中。但是,如果并发请求同时尝试写入数据库,它们会变慢,因为每次写入都是按顺序发生的。小型应用程序不会注意到这一点。一旦变得庞大,你可能希望切换到不同的数据库。

本教程不会详细介绍 SQL。如果你不熟悉它,SQLite 文档描述了 语言

连接到数据库

使用 SQLite 数据库(以及大多数其他 Python 数据库库)时要做的第一件事是创建与它的连接。所有查询和操作都是使用连接执行的,在完成工作后关闭连接。

在 Web 应用程序中,此连接通常与请求相关联。它在处理请求的某个时间点创建,并在发送响应之前关闭。

flaskr/db.py
import sqlite3

import click
from flask import current_app, g


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')
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 函数并向用户显示一条成功消息。你可以阅读 命令行界面 以了解有关编写命令的更多信息。

在应用程序中注册

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 命令。

注意

如果你仍在运行上一页的服务器,则可以停止服务器,或在新终端中运行此命令。如果你使用新终端,请记住切换到项目目录并激活 env,如 安装 中所述。

运行 init-db 命令

$ flask --app flaskr init-db
Initialized the database.

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

继续到 蓝图和视图