Flask 学习-16.项目设计与蓝图的使用

Posted 2022-08-29 上海-悠悠

前言

一个最简单的 Flask 应用可以是单个app.py文件, 当项目越来越大的时候，把所有代码放在单个文件中就很难维护了。
我们需要设计一个项目结构，每个目录做对应的事情。

项目结构设计

一个最简单的 Flask 应用可以是单个app.py文件。
app.py

from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'


if __name__ == '__main__':
    app.run()

然而，当项目越来越大的时候，Python 项目使用包(package)来管理代码，把代码分为不同的模块，然后在需要的地方导入模块。

项目名称叫xuexi_flask，布局如下：

D:\\demo\\xuexi_flask
├── apps/
│   ├── __init__.py
│   ├── auth.py
│   ├── blog.py
│   ├── pay.py
├── templates/
│   ├── base.html
│   ├── auth/
│   │   ├── login.html
│   │   └── register.html
│   └── blog/
│       ├── create.html
└── static/
│       └── my.css
│       └── my.js
├── tests/
│   ├── test_auth.py
│   └── test_blog.py
│   └── test_pay.py
├── venv/
├── app.py

教程项目包含如下内容:

• apps/ 项目的applications, 一个项目下可以有多个app
• templates/ 项目模板
• static/ 静态资源文件
• tests/ 一个包含测试模块的文件夹。
• venv/ 一个 Python 虚拟环境，用于安装 Flask 和其他依赖的包。
• app.py/ 项目启动文件

假设使用 git 来进行版本控制，那么使用 .gitignore 来设置应当忽略 的文件，
.gitignore

venv/

*.pyc
__pycache__/

instance/

.pytest_cache/
.coverage
htmlcov/

dist/
build/
*.egg-info/

初始化app

在apps目录 __init__.py 有两个作用：一是包含应用工厂；二是 告诉 Python apps文件夹应当视作为一个包。
apps/__init__.py

import os

from flask import Flask


def create_app(test_config=None):
    # create and configure the app
    app = Flask(__name__, instance_relative_config=True)
    app.config.from_mapping(
        SECRET_KEY='dev',
        DATABASE=os.path.join(app.instance_path, 'apps.sqlite'),
    )

    if test_config is None:
        # load the instance config, if it exists, when not testing
        app.config.from_pyfile('config.py', silent=True)
    else:
        # load the test config if passed in
        app.config.from_mapping(test_config)

    # ensure the instance folder exists
    try:
        os.makedirs(app.instance_path)
    except OSError:
        pass
    return app

create_app 是一个应用工厂函数，后面的教程中会用到。这个看似简单的函数其实 已经做了许多事情
1.app = Flask(__name__, instance_relative_config=True) 创建 Flask 实例。

• __name__ 是当前 Python 模块的名称。应用需要知道在哪里设置路径， 使用 __name__ 是一个方便的方法。
• instance_relative_config=True 告诉应用配置文件是相对于 instance folder 的相对路径。实例文件夹在 apps 包的外面，用于存放本地数据（例如配置密钥和数据库），不应当 提交到版本控制系统。

2.app.config.from_mapping() 设置一个应用的 缺省配置：

• SECRET_KEY 是被 Flask 和扩展用于保证数据安全的。在开发过程中， 为了方便可以设置为 ‘dev’ ，但是在发布的时候应当使用一个随机值来 重载它。
• DATABASE SQLite 数据库文件存放在路径。它位于 Flask 用于存放实例的 app.instance_path 之内。

3.app.config.from_pyfile() 使用 config.py 中的值来重载缺省配置，如果 config.py 存在的话。 例如，当正式部署的时候，用于设置一个正式的 SECRET_KEY 。

• test_config 也会被传递给工厂，并且会替代实例配置。这样可以实现 测试和开发的配置分离，相互独立。

4.os.makedirs() 可以确保 app.instance_path 存在。 Flask 不会自动 创建实例文件夹，但是必须确保创建这个文件夹，因为 SQLite 数据库文件会被 保存在里面。

启动应用
app.py

from apps import create_app

app = create_app()


@app.route('/hello')
def hello():
    return 'Hello, World!'


if __name__ == '__main__':
    app.run()

直接运行 app.py 文件就可以启动项目了

 * Serving Flask app 'apps'
 * Debug mode: off
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on http://127.0.0.1:5000
Press CTRL+C to quit

访问http://127.0.0.1:5000/hello 会出现 ‘hello world’

蓝图

如果一个项目有多个app, 或者分成多个模块的时候，比如apps下有auth.py blog.py pay.py 三个文件，这每个文件里面都可以写视图函数，那么就需要统一管理视图。
Blueprint 是一种组织一组相关视图及其他代码的方式。与把视图及其他 代码直接注册到应用的方式不同，蓝图方式是把它们注册到蓝图，然后在工厂函数中 把蓝图注册到应用。
apps/auth.py

from flask import (
    Blueprint, flash, g, redirect, render_template, request, session, url_for
)


bp = Blueprint('auth', __name__, url_prefix='/auth')


@bp.route('/register', methods=('GET', 'POST'))
def register():
    return "注册视图...."

那么需要在 apps/__init__.py 中使用 app.register_blueprint() 导入并注册 蓝图，新的代码放在工厂函数的尾部返回应用之前。。

def create_app():
    app = Flask(__name__)
    # existing code omitted

    from . import auth
    app.register_blueprint(auth.bp)

    return app

那么访问的时候加上前缀’/auth’,就可以访问了http://127.0.0.1:5000/auth/register

同样在其它的blog.py 和 pay.py 文件也可以对对应代码
apps/blog.py

from flask import (
    Blueprint, flash, g, redirect, render_template, request, session, url_for
)


bp = Blueprint('blog', __name__, url_prefix='/blog')


@bp.route('/edit', methods=('GET', 'POST'))
def edit_blog():
    return "编辑视图...."

在 apps/__init__.py 中使用 app.register_blueprint() 继续导入并blog 蓝图

def create_app():
    app = Flask(__name__)
    # existing code omitted

    from . import auth
    from . import blog
    app.register_blueprint(auth.bp)
    app.register_blueprint(blog.bp)

    return app