Flask之旅

存储

存储

大多数Flask应用都将要跟数据打交道。有很多种不同的方法存储数据。至于哪种最优,取决于数据的类型。如果你储存的是关系性数据(比如一个用户有多个邮件,一个邮件对应一个用户),关系型数据库无疑是你的选择。其他类型的数据也许适合储存到NoSQL数据库(比如MongoDB)中。

我不会告诉你如何为你的应用选择数据库。如果有人告诉你,NoSQL是你的唯一选择;那么必然也会有人建议用关系型数据库处理同样的问题。对此我唯一需要说的是,如果你不清楚,关系型数据库(MySQL, PostgreSQL等等)将满足你绝大部分的需求。

另外,当你使用关系型数据库,你就能用到SQLAlchemy,而SQLAlchemy用起来真爽。

SQLAlchemy

SQLAlchemy是一个ORM(对象关系映射)。基于对目标数据库的原生SQL的抽象,它提供了与一长串数据库引擎的一致的API。这一列表中包括MySQL,PostgreSQL,和SQLite。这使得在你的模型和数据库间交换数据变得轻松愉快,同时也使得诸如换掉数据库引擎和迁移数据库模式等其他事情变得没那么繁琐。

存在一个很棒的Flask插件使得在Flask中使用SQLAlchemy更为轻松。它就是Flask-SQLAlchemy。Flask-SQLAlchemy为SQLAlchemy设置了许多合理的配置。它也内置了一些session管理,这样你就不用在应用代码里处理这种基础事务了。

让我们深入看看一些代码。我们将先定义一些模型,接着配置下SQLAchemy。这些模型将位于myapp/models.py,不过首先我们要在myapp/__init__.py定义我们的数据库。

myapp/__init__.py_

from flask import Flask
from flask_sqlalchemy import SQLAlchemy

app = Flask(__name__, instance_relative_config=True)

app.config.from_object('config')
app.config.from_pyfile('config.py')

db = SQLAlchemy(app)

我们首先初始化并配置你的Flask应用,然后用它来初始化你的SQLAlchemy数据库处理程序。我们将为数据库配置使用一个instance文件夹,所以我们应该在初始化应用时加上instance_relative_config选项,然后调用app.config.from_pyfile。现在我们可以定义模型了。

myapp/models.py

from . import db

class Engine(db.Model):

    # Columns

    id = db.Column(db.Integer, primary_key=True, autoincrement=True)

    title = db.Column(db.String(128))

    thrust = db.Column(db.Integer, default=0)

ColumnIntegerStringModel和其他的SQLAlchemy类都可以通过由Flask-SQLAlchemy构造的db对象访问。我们会定义一个储存我们的太空飞船引擎的当前状态的模型。每个引擎有一个ID,一个标题和一个推力等级。

我们需要往我们的配置添加一些数据库信息。我们打算使用一个instance文件夹来避免配置变量被记录进版本控制系统,所以我们要把它们放入instance/config.py

instance/config.py

SQLALCHEMY_DATABASE_URI = "postgresql://user:password@localhost/spaceshipDB"

注意 你的数据库URI将取决于你选择的数据库和它部署的位置。看一下这个相关的SQLAlchemy文档: http://docs.sqlalchemy.org/en/latest/core/engines.html?highlight=database#database-urls

初始化数据库

既然数据库已经配置好了,而模型也定义了,是时候初始化数据库了。这个步骤从由模型定义中创建数据库模式开始。

通常这会是非常痛苦的过程。不过幸运的是,SQLAlchemy提供了一个十分酷的工具帮我们完成了所有的琐事。

让我们在版本库的根目录下打开一个Python终端。

$ pwd
/Users/me/Code/myapp
$ workon myapp
(myapp)$ python
Python 2.7.5 (default, Aug 25 2013, 00:04:04)
[GCC 4.2.1 Compatible Apple LLVM 5.0 (clang-500.0.68)] on darwin
Type "help", "copyright", "credits" or "license" for more information.
>>> from myapp import db
>>> db.create_all()
>>>

现在,感谢SQLAlchemy,你会发现在你配置的数据库中,所需的表格已经被创建出来了。

Alembic迁移工具

数据库的模式并非亘古不变的。举个例子,你可能需要在引擎的表里添加一个last_fired的项。如果这个表是一张白纸,你只需要更新模型并重新运行db.create_all()。然而,如果你在引擎表里记录了六个月的数据,你肯定不会想要从头开始。这时候就需要数据库迁移工具了。

Alembic是专用于SQLAlchemy的数据库迁移工具。它允许你保持你的数据库模式的版本历史,这样你就可以升级到一个新的模式,或者降级到旧的模式。

Alembic有一个可拓展的新手教程,所以我只会大概地说一下并指出一些需要注意的事项。

通过一个初始化的alembic init命令,你将创建一个alembic"迁移环境"。在你的版本库的根目录下执行这个命令,你将得到一个叫alembic的新文件夹。你的版本库将看上去就像Alembic教程中的这个例子一样:

myapp/
    alembic.ini
    alembic/
        env.py
        README
        script.py.mako
        versions/
            3512b954651e_add_account.py
            2b1ae634e5cd_add_order_id.py
            3adcc9a56557_rename_username_field.py
    myapp/
        __init__.py
        views.py
        models.py
          templates/
    run.py
    config.py
    requirements.txt

alembic/文件夹中包括了在版本间迁移数据的脚本。同时会有一个包括配置信息的alembic.ini文件。

注意alembic.ini添加到.gitignore中!在那里会有你的数据库凭证,所以你不应该把它留在版本控制中。

不过你可以把alembic/放进版本控制。它不会包含敏感信息(而且不能从你的源代码中重新生成),并且在版本控制中保存多个副本可以避免你的电脑发生不测。

当数据库模式需要发生变化时,我们需要做一系列事情。首先,运行alembic revision来生成迁移脚本。在myapp/alembic/versions/打开新生成的Python文件并使用Alembic的op对象完成upgradedowngrade函数。

一旦我们的迁移脚本已经准备就绪,我们只需运行alembic upgrade head来迁移我们的数据到最新版本。

参见 想知道更多关于配置Alembic,创建你的迁移脚本和运行你的迁移,请看Alembic教程: http://alembic.readthedocs.org/en/latest/tutorial.html

注意 不要忘记设定数据的备份计划。备份计划的话题已经超出本书的范围,但你应该总是要有一个安全和健壮的方式备份你的数据库。

注意 Flask在NoSQL上的支持较少,但只要有你选择的数据库引擎有对应的Python库,你就能够用上它。这里有一些Flask插件,可以给Flask提供NoSQL引擎的支持。 http://flask.pocoo.org/extensions/

总结

  • 使用SQLAchemy来搭配关系型数据库。
  • 使用Flask-SQLAlchemy来包装SQLAlchemy。
  • Alembic会在数据库模式改变时帮助你管理数据迁移。
  • 你可以用NoSQL搭配Flask,但具体做法取决于具体引擎。
  • 记得备份你的数据!