Flask组件化开发:Blueprint(蓝图)

概述

Blueprint是flask库中的一个模块,作为蓝图,必定有它的道理。它是Flask项目的一种组件式开发,可以在一个应用内或跨越 多个项目共用蓝图。使用蓝图可以极大地简化大型应用的开发难度,也为Flask扩展 提供了一种在应用中注册服务的集中式机制。 模块化管理程序路由是它的特色,它使程序结构清晰、简单易懂。

先回想一下从零开始教你入手Flask项目

我们在管理路由的时候,是直接在app对象上进行的路由设置的,像下面这样:

from flask import Flask
app = Flask(__name__)

@app.route('/')
def index():
    return 'Index Page'

@app.route('/static')
def s():
    return 'static route'

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

显然,如果所有的路由都直接在app应用对象上直接注册,不仅使我们的程序结构十分混乱,而且大大增加了程序的系统内存消耗。至于如何节约,先卖个关子。

那么使用蓝图进行程序路由的模块化管理是如何做到的呢?

还是先来一张结构图
Flask组件化开发:Blueprint(蓝图)_第1张图片
结构图

可以看到在app文件夹下有三个文件夹mainauth以及api内含有视图函数。如果不太清楚flask项目结构的,可以转Flask项目结构

这三个文件夹中的init.py都是进行蓝图的定义的。举main文件夹下的例子

Flask组件化开发:Blueprint(蓝图)_第2张图片
main/__init__.py
1.导入Blueprint
2.创建Blueprint的实例,第一个参数就是蓝本的名字,第二个参数一般为Python的name变量。
Flask组件化开发:Blueprint(蓝图)_第3张图片
app/__init__.py

在应用对象app上 注册 蓝图对象。

参数介绍:

第一个参数是 蓝图对象
随后的都是 可选参数

介绍一下两个常用的:

1.static_folder:
和应用对象不同,蓝图对象创建时不会默认注册静态目录的路由。需要我们在 创建时指定static_folder 参数。如图中我们设置参数为‘static’,也就是项目结构中的static文件夹。

这样我们可以使用地址/static/main/layout.css访问static目录下的css、js、image文件了

2.url_prefix

默认的值为 '/' ######用一个demo.py来解释吧(这个demo也要在虚拟环境下运行

# -*- coding:utf-8 -*-
from flask import Flask,Blueprint

main = Blueprint('main',__name__)
@main.route('/')
def v_index():
    return 'main page'

app = Flask(__name__)
    
app.register_blueprint(shop,url_prefix='/')
app.register_blueprint(admin,url_prefix='/admin')

app.run()    
Flask组件化开发:Blueprint(蓝图)_第4张图片

Flask组件化开发:Blueprint(蓝图)_第5张图片

显而易见,这个参数就是增加相对路径的前缀的
当然也可以不用直接在渲染成模板时自己加上。

中间穿插了这么多,再看一下main/views.py里边的内容吧

Flask组件化开发:Blueprint(蓝图)_第6张图片
main/views.py

这个例子就是直接在views.py里边直接加url前缀。

这个文件下就是在蓝图对象上进行操作即创建路由 ,通过 render_template()方法将页面渲染出来。

接下来说说这个蓝图的endpoint

我一般习惯将前边所有的工作做完之后再去前端HTML文件中去设置路由的跳转。例如:

前端模板中的一个链接
蓝图的endpoint可以理解为: 蓝图名.函数名

url_for是通过endpoint查询url地址,然后找视图函数

最后

根据个人的理解来说一下蓝图的运行机制:

我们在创建 蓝图对象 的时候只是创建了一个空的列表,叫做 延迟操作记录列表 ,里边包含了路由的创建函数add_url_rule().接受的参数是应用对象app。当执行应用对象的** register_blueprint() **方法时,应用对象将从蓝图对象的 这个列表中取出每一项,并以自身 作为参数执行该匿名函数 —— 即调用应用对象的 add_url_rule() 方法,这将真正的 修改应用对象的两张路由表(app.url_map 和 app.view_functions) 所以,这也解释了我前边卖的关子:蓝图之所以为蓝图,是因为它仅仅记录了未来应该发生的操作, 而不是当即实现!

END

愿你们有自己的蓝图,然后大展宏图~ 还是感谢大家支持~ 继续关注更新
Flask组件化开发:Blueprint(蓝图)_第7张图片
持续更新

你可能感兴趣的:(Flask组件化开发:Blueprint(蓝图))