蓝图（Blueprint）

蓝图的作用是可以把一个应用拆分成多个文件，以便于大型应用的编写。

实现一个简单的蓝图。

本例中，文件目录是这样组织的：

/main.py  # 主函数写在这
/routes  # 按功能拆分路由
    /todo.py
    /user.py

我们根据功能，把和 Todo 功能相关的路由函数写到 todo.py 中，把和 User 相关的路由函数写到 user.py 中。

编写 todo.py：

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
todo_routes = Blueprint('todo', __name__)


@todo_routes.route('/')
def index():
    return 'Here is Todo!'

编写 user.py：

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
user_routes = Blueprint('user', __name__)


@user_routes.route('/')
def index():
    return 'Here is User!'

编写 main.py：

from flask import Flask

# 引入各个路由的蓝图对象
from routes.todo import todo_routes
from routes.user import user_routes


app = Flask(__name__)
# 设置 secret_key 来使用 flask 自带的 session
# 这个字符串随便你设置什么内容都可以
app.secret_key = 'random string'


# 注册蓝图
# 有一个 url_prefix 可以用来给蓝图中的每个路由加一个前缀
# 比如：碰到 "/todo" 开头的 URL，就会用 todo_routes 的函数来处理
app.register_blueprint(todo_routes, url_prefix='/todo')
app.register_blueprint(user_routes, url_prefix='/user')


# 运行代码
if __name__ == '__main__':
    # debug 模式可以自动加载你对代码的变动, 所以不用重启程序
    # host 参数指定为 '0.0.0.0' 可以让别的机器访问你的代码
    config = dict(
        debug=True,
        host='0.0.0.0',
        port=3000,
    )
    app.run(**config)

这时候，打开 "http://127.0.0.1:3000/todo/"，“http://127.0.0.1:3000/user/”，就能见到蓝图工作了。

可能我们会对 Blueprint('user', __name__) 中第一个参数的作用有疑问，这类似于 Django URLs 中的 name 参数的作用。

上面例子中，我们可以用 url_for('todo.index') 或者 url_for('user.index') 来找到对应方法的 URL。

---

下面我们用蓝图来实现 Django 风格的文件目录。

/main.py  # 主函数写在这
/todo_app
    /__init__.py
    /models.py
    /views.py
    /templates  # 属于 todo 的模板文件夹
        /todo_index.html
/user_app
    /__init__.py
    /models.py
    /views.py
    /templates  # 属于 user 的模板文件夹
        /user_index.html

编写 todo_app/views.py：

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
todo_routes = Blueprint(
    'todo', 
    __name__, 
    template_folder = 'templates', # 设定模板目录
    url_prefix='/todo' # 设定后缀 url
    )


@todo_routes.route('/')
def index():
    return render_template('todo_index.html')

编写 user_app/views.py：

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
user_routes = Blueprint(
    'user', 
    __name__, 
    template_folder = 'templates',
    url_prefix='/user'
    )


@user_routes.route('/')
def index():
    return render_template('user_index.html')

编写 main.py：

from flask import Flask

# 引入各个路由的蓝图对象
from todo_app.views import todo_routes
from user_app.views import user_routes


app = Flask(__name__)
# 设置 secret_key 来使用 flask 自带的 session
# 这个字符串随便你设置什么内容都可以
app.secret_key = 'random string'


# 注册蓝图
app.register_blueprint(todo_routes)
app.register_blueprint(user_routes)


# 运行代码
if __name__ == '__main__':
    config = dict(
        debug=True,
        host='0.0.0.0',
        port=3000,
    )
    app.run(**config)

本例子的代码：https://github.com/SingleDiego/flask-Blueprint