Blueprint
蓝图的基本设想是当它们注册到应用上时,它们记录将会被执行的操作。 当分派请求和生成从一个端点到另一个的 URL 时,Flask 会关联蓝图中的视图函数。
简单来说,Blueprint 是一个存储操作方法的容器,这些操作在这个Blueprint 被注册到一个应用之后就 可以被调用,Flask 可以通过Blueprint来组织URL以及处理请求。
一.蓝图的简介。
Flask 用 蓝图(blueprints) 的概念来在一个应用中或跨应用制作应用组件和支持通用的模式。蓝图很好地简化了大型应用工作的方式,并提供给 Flask 扩展在应用上注册操作的核心方法。一个 Blueprint 对象与 Flask 应用对象的工作方式很像,但它确实不是一个应用,而是一个描述如何构建或扩展应用的 蓝图 。
二.蓝图的使用场景。
①把一个应用分解为一个蓝图的集合。适合大型应用,一个项目可以实例化一个应用对象,初始化几个扩展,并注册一集合的蓝图。
②以 URL 前缀和/或子域名,在应用上注册一个蓝图。 URL 前缀/子域名中的参数即成为这个蓝图下的所有视图函数的共同的视图参数(默认情况下)。
③在一个应用中用不同的 URL 规则多次注册一个蓝图。
④一个蓝图不一定要实现应用或者视图函数,还可通过蓝图提供模板过滤器、静态文件、模板和其它功能。
注:蓝图缺点,不能在应用创建后撤销注册一个蓝图而不销毁整个应用对象。
三.蓝图实现模块化。
蓝图/Blueprint对象用起来和一个应用/Flask对象差不多,最大的区别在于一个 蓝图对象没有办法独立运 行,必须将它注册到一个应用对象上才能生效。
使用蓝图可以分为三个步骤
1,创建一个蓝图对象
admin=Blueprint('admin',__name__)
2,在这个蓝图对象上进行操作,注册路由,指定静态文件夹,注册模版过滤器
@admin.route('/')
def admin_home():
return 'admin_home'
3,在应用对象上注册这个蓝图对象
app.register_blueprint(admin,url\_prefix='/admin')
当这个应用启动后,通过/admin/可以访问到蓝图中定义的视图函数
四.运行机制。
①蓝图是保存了一组将来可以在应用对象上执行的操作,注册路由就是一种操作
②当在应用对象上调用 route 装饰器注册路由时,这个操作将修改对象的url_map路由表 然而,蓝图对象根本没有路由表,当我们在蓝图对象上调用route装饰器注册路由时,它只是在内部 的一个延迟操作记录列表defered_functions中添加了一个项
③ 当执行应用对象的 register_blueprint() 方法时,应用对象将从蓝图对象的 defered_functions 列表中 取出每一项,并以自身作为参数执行该匿名函数,即调用应用对象的 add_url_rule() 方法,这将真 正的修改应用对象的路由表
五.蓝图的url前缀。
①当我们在应用对象上注册一个蓝图时,可以指定一个url_prefix关键字参数(这个参数默认是/)
②在应用最终的路由表 url_map中,在蓝图上注册的路由URL自动被加上了这个前缀,这个可以保证 在多个蓝图中使用相同的URL规则而不会最终引起冲突,只要在注册蓝图时将不同的蓝图挂接到 不同的自路径即可
例如:
#创建蓝图对象
passport_blu = Blueprint("passport",__name__,url_prefix="/passport")#之后在使用passport_blu这个路由的url前面都会加上/passport这个前缀
六.注册静态路由。
和应用对象不同,蓝图对象创建时不会默认注册静态目录的路由。需要我们在 创建时指定 static_folder 参数。
下面的示例将蓝图所在目录下的static_admin目录设置为静态目录
admin = Blueprint("admin",__name__,static_folder='static_admin')
app.register_blueprint(admin,url_prefix='/admin')
现在就可以使用/admin/static_admin/ 访问static_admin目录下的静态文件了 定制静态目录URL规则 :可 以在创建蓝图对象时使用 static_url_path 来改变静态目录的路由。下面的示例将为 static_admin 文件夹 的路由设置为 /lib
admin = Blueprint("admin",__name__,static_folder='static_admin',static_url_path='/l ib')
app.register_blueprint(admin,url_prefix='/admin')
七.设置模版目录
蓝图对象默认的模板目录为系统的模版目录,可以在创建蓝图对象时使用 template_folder 关键字参数 设置模板目录
admin = Blueprint('admin',__name__,template_folder='my_templates')
注:如果在 templates 中存在和 my_templates 同名文件,则系统会优先使用 templates 中的文件