蓝图

需求

在一个Flask 应用项目中，如果业务视图过多，可否将以某种方式划分出的业务单元单独维护，将每个单元用到的视图、静态文件、模板文件等独立分开？
例如从业务角度上，可将整个应用划分为用户模块单元、商品模块单元、订单模块单元，如何分别开发这些不同单元，并最终整合到一个项目应用中？
在Django中这种需求是如何实现的？

蓝图

在Flask中，使用蓝图Blueprint来分模块组织管理。
蓝图实际可以理解为是一个存储一组视图方法的容器对象，其具有如下特点：

  • 一个应用可以具有多个Blueprint
  • 可以将一个Blueprint注册到任何一个未使用的URL下比如 “/user”、“/goods”
  • Blueprint可以单独具有自己的模板、静态文件或者其它的通用操作方法，它并不是必须要实现应用的视图和函数的
  • 在一个应用初始化时，就应该要注册需要使用的Blueprint

但是一个Blueprint并不是一个完整的应用，它不能独立于应用运行，而必须要注册到某一个应用中。

使用方式

使用蓝图可以分为三个步骤

  1. 创建一个蓝图对象

    1. user_bp=Blueprint('user',__name__)

  2. 在这个蓝图对象上进行操作,注册路由,指定静态文件夹,注册模版过滤器

    1. @user_bp.route('/')
    2. def user_profile():
    3.   return 'user_profile'

  3. 在应用对象上注册这个蓝图对象

    1. app.register_blueprint(user_bp)

    单文件蓝图

    可以将创建蓝图对象与定义视图放到一个文件中 。

    目录（包）蓝图

    对于一个打算包含多个文件的蓝图，通常将创建蓝图对象放到Python包的__init__.py文件中

    1. --------- project # 工程目录
    2. |------ main.py # 启动文件
    3. |------ user  #用户蓝图
    4. |  |--- __init__.py  # 此处创建蓝图对象
    5. |  |--- passport.py  
    6. |  |--- profile.py
    7. |  |--- ...
    8. |
    9. |------ goods # 商品蓝图
    10. |  |--- __init__.py
    11. |  |--- ...
    12. |...

    扩展用法

    1 指定蓝图的url前缀

    在应用中注册蓝图时使用url_prefix参数指定

    1. app.register_blueprint(user_bp, url_prefix='/user')
    2. app.register_blueprint(goods_bp, url_prefix='/goods')

    2 蓝图内部静态文件

    和应用对象不同，蓝图对象创建时不会默认注册静态目录的路由。需要我们在 创建时指定 static_folder 参数。
    下面的示例将蓝图所在目录下的static_admin目录设置为静态目录

    1. admin = Blueprint("admin",__name__,static_folder='static_admin')
    2. app.register_blueprint(admin,url_prefix='/admin')

    现在就可以使用/admin/static_admin/<filename>访问static_admin目录下的静态文件了。
    也可通过static_url_path改变访问路径

    1. admin = Blueprint("admin",__name__,static_folder='static_admin',static_url_path='/lib')
    2. app.register_blueprint(admin,url_prefix='/admin')

    3 蓝图内部模板目录

    蓝图对象默认的模板目录为系统的模版目录，可以在创建蓝图对象时使用 template_folder 关键字参数设置模板目录

    1. admin = Blueprint('admin',__name__,template_folder='my_templates')