定义

简单来说，Blueprint 是一个存储视图方法的容器，这些操作在这个Blueprint 被注册到一个app之后就可以被调用，Flask 可以通过Blueprint来组织URL以及处理请求。

在其他地方，这个概念可能叫组路由

功能

蓝图的功能：主要是将大型项目分层解耦，模块化

  • 可以将相同模块的视图函数放在同一蓝图下，同一个文件中，方便管理。
  • 应用URL前缀和子域名在一个蓝图上
  • 应用不同的URL规则多次注册一个蓝图
  • 通过蓝图提供模板过滤器、静态文件、模板和其它功能。（一个蓝图不一定要实现应用或者视图函数）
  • 初始化一个Flask扩展时，在这些情况中注册蓝图

基本语法

  1. 导入蓝图
  2. 定义蓝图
  3. 注册蓝图

示例代码：

  1. # blueprints/user.py
  2. from flask import Blueprint
  5. # 1. 初始化蓝图
  6. user_bp = Blueprint('user', __name__)
  8. # 2. 定义蓝图视图
  9. @user_bp.route('/profile/')
  10. def profile():
  11.     return "个人中心页面"
  14. @user_bp.route('/settings/')
  15. def settings():
  16.     return "个人中心设置页面"
  18. # app.py
  19. app = Flask(__name__)
  20. app.register_blueprint(user_bp)    # 注册蓝图

蓝图源代码

  1. class Blueprint(_PackageBoundObject):
  2.     """Represents a blueprint.  A blueprint is an object that records
  3.     functions that will be called with the
  4.     :class:`~flask.blueprints.BlueprintSetupState` later to register functions
  5.     or other things on the main application.  See :ref:`blueprints` for more
  6.     information.
  8.     .. versionadded:: 0.7
  9.     """
  11.     warn_on_modifications = False
  12.     _got_registered_once = False
  14.     def __init__(self, name, import_name, static_folder=None,
  15.                  static_url_path=None, template_folder=None,
  16.                  url_prefix=None, subdomain=None, url_defaults=None,
  17.                  root_path=None):
  18.         _PackageBoundObject.__init__(self, import_name, template_folder,
  19.                                      root_path=root_path)
  20.         self.name = name
  21.         self.url_prefix = url_prefix
  22.         self.subdomain = subdomain
  23.         self.static_folder = static_folder
  24.         self.static_url_path = static_url_path
  25.         self.deferred_functions = []
  26.         if url_defaults is None:
  27.             url_defaults = {}
  28.         self.url_values_defaults = url_defaults
  31. # name: 蓝图名字
  32. # import_name: 通常是__name__，指定蓝图资源文件夹
  33. # static_folder: 指向fs中的目录，公开一个静态文件的目录（可以使用绝对路径与相对路径）
  34. # template_folder: 公开蓝图模板目录
  35. # subdomain: 使用蓝图实现子域名

蓝图路由前缀

蓝图可以在路由前挂载，即蓝图路由前缀，如以下url中的user前缀

  1. domain/user/settings/
  2. domain/user/profile/

定义方法如下（注意添加前缀时，前缀的斜杠与蓝图函数的路由斜杠问题）：

  1. # blueprints/user.py
  2. from flask import Blueprint
  4. # 1. 初始化蓝图
  5. user_bp = Blueprint('user', __name__, url_prefix="/user") # 添加路由前缀
  7. # 2. 定义蓝图
  8. @user_bp.route('/profile/')
  9. def profile():
  10.     return "个人中心页面"

蓝图资源文件

蓝图模板文件的查询顺序：

  1. 如果 templates 目录中有相应的模板文件，就直接使用
  2. 如果 templates 目录中没有相应的模板文件， 就去定义蓝图时指定的路径中寻找。蓝图中指定的路径可以为相对路径（相对的是当前这个蓝图文件所在的目录： blueprint_name/templates）

蓝图静态文件的查询顺序

  1. 如果使用url_for('static')指定了 static目录，那么只会在app指定的 static目录查找
  2. 如果模板文件指定蓝图的名字url_for('news.static') ，那么就会到 blueprint_name/static_folder目录下查找

构建URLs

当你想要从一个页面链接到另一个页面，你可以像通常一个样使用 url_for() 函数，只是你要在 URL 的末端加上蓝图的名称和一个点(.)作为前缀:

  1. 使用url_for()函数时，需要在endpoint 前加上所调用蓝图的名字

    1. url_for('admin.index')

  2. 即使在同一个蓝图中反转视图函数，也要指定蓝图的名字

    1. url_for('.index')

蓝图实现子域名

使用蓝图实现子域名

  1. 创建蓝图时，传递subdomain=xxxx
  2. 在主app文件中，需要配置SERVER_NAME

子域名的实现也是使用Blueprint来实现的，首先创建一个cms文件

  1. from flask import Blueprint
  3. cms_bp = Blueprint('cms',__name__,subdomain='cms')  # 1. 设置子域名为 cms
  5. @cms_bp.route('/')
  6. def cms_index():
  7.     return '我是cms的管理平台'

到/private/etc/hosts中修改域名对应

  1. 127.0.0.1 test.com
  2. 127.0.0.1 cms.test.com

在主文件中添加蓝图和设置域名

  1. app.register_blueprint(cms_bp)
  3. app.config['SERVER_NAME'] = 'test.com:5000'     # 2. 配置 SERVER_NAME

这样我们就能通过http://cms.test.com:5000/
访问cms.test.com这个字域名下面的视图函数。