应用程序的工厂函数

如果您已经开始使用包和蓝图(用蓝图实现模块化的应用)辅助您的应用开发了,那么 这里还有一些非常好的办法可以进一步的提升开发体验。 当蓝图被导入的时候, 一个通用的模板将会负责创建应用程序对象。 但是如果你将这个对象的创建工作 移交给一个函数来完成,那么你就可以在此后创建它的多个实例。

所以,你为什么要这么做?

  1. 测试。 你可以使用多个应用程序的实例,为每个实例分配分配不同的配置, 从而测试每一种不同的情况。
  2. 多个实例。 想象一下你需要运行同一个应用的不同版本。你当然可以在你的Web服务器中配置多个实例并分配不同的配置,但是如果你使用工厂函数, 你就可以在一个随手即得的进程中运行这一个应用的不同实例了!

那么该如何使用他们呢?

基础的工厂函数

这个想法是在一个函数中建立应用。像这样:

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)

    from yourapplication.model import db
    db.init_app(app)

    from yourapplication.views.admin import admin
    from yourapplication.views.frontend import frontend
    app.register_blueprint(admin)
    app.register_blueprint(frontend)

    return app

有得必有失,在导入时,您无法在蓝图中使用这个应用程序对象。 然而您可以在一个 请求中使用他。 如果获取当前配置下的对应的应用程序对象呢? 请使用: current_app 函数:

from flask import current_app, Blueprint, render_template
admin = Blueprint('admin', __name__, url_prefix='/admin')

@admin.route('/')
def index():
    return render_template(current_app.config['INDEX_TEMPLATE'])

在这里我们从配置中查找一个网页模板文件的名字。

工厂函数和扩展

最好创建您的扩展和应用程序工厂,以便扩展对象最初不绑定到应用程序。

使用Flask-SQLAlchemy作为示例,您不应该按照以下这些行做事情:

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)

    db = SQLAlchemy(app)

但是,在model.py(或等价的):

db = SQLAlchemy()

和在您的application.py(或同等):

def create_app(config_filename):
    app = Flask(__name__)
    app.config.from_pyfile(config_filename)

    from yourapplication.model import db
    db.init_app(app)

使用此设计模式,扩展对象上不存储应用程序特定状态,因此一个扩展对象可用于多个应用程序。有关扩展设计的更多信息,请参阅Flask Extension Development

使用应用

所以,要使用这样的一个应用,你必须先在一个单独的文件中创建这个应用,否则flask命令将找不到它。下面是一个示例exampleapp.py,它创建这样的应用︰

from yourapplication import create_app
app = create_app('/path/to/config.cfg')

然后可以与flask命令一起使用:

export FLASK_APP=exampleapp
flask run

工厂函数的改进

前文所提供的工厂函数并不是特别聪明好用,你可以改进它。如下的改变很直接而且可行:

  1. 使得在单元测试中传入配置值成为可行,以使您不必在文件系统中 创建多个配置文件。
  2. 在程序初始时从蓝图中调用一个函数,这样您就有机会修改应用的参数属性了 (就像在在请求处理器前后的调用钩子等)
  3. 如果必要的话,在应用正在被创建时添加 WSGI 中间件。