flask蓝图blueprint详解

简介: Flask 蓝图(Blueprint)使用方式解析 Flask蓝图提供了模块化管理程序路由的功能,使程序结构清晰、简单易懂。

Flask 蓝图(Blueprint)使用方式解析

Flask蓝图提供了模块化管理程序路由的功能,使程序结构清晰、简单易懂。下面分析蓝图的使用方法

假如说我们要为某所学校的每个人建立一份档案,一个很自然的优化方式就是这些档案如果能分类管理,就是说假如分为老师、学生、后勤人员等类别,那么后续查找和管理这些档案就方便清晰许多。Flask的蓝图就提供了类似“分类”的功能。

下面先上一张较大型程序的组织结构图


1

可以看到在app文件夹下有两个文件夹main和auth内含有视图函数,而main和auth就是注册的两个蓝图。

1. 蓝图的创建及注册

在图1中,以main文件夹为例。在main文件夹的__init__.py文件中,可创建蓝图,代码如下:


2

从Flask中导入Blueprint类,再创建一个实例即可。Blueprint接受两个参数实例化,分别为蓝本的名字和蓝本所在的包或模块,大多数情况下第二个参数使用Python 的__name__ 变量即可。


3

在图3中,是在Flask文件夹下的__init__.py文件中注册这两个模块(请结合图1理解文件夹的组织结构)。该__init__.py文件中包含app创建函数,创建app后,即可注册已创立的蓝图。

最后一部是在main文件夹下的view文件中导入创建的蓝图,使用from . import main命令。不要忘记这一步,应为视图函数实在view文件种定义的,不导入蓝图的话,无法用蓝图定义路由。

另请注意在图2中,在main = Blueprint(‘main’, __name__) 命令下有一个from . import views, errors命令。该命令的意思是导入在views和errors整个模块。在此我们发现views模块和__init__模块之间存在相互导入。一定要保证__init__模块中,from . import views, error命令在main = Blueprint(‘main’, __name__)之后,否则会产生依赖循环导入的错误。

2. 使用蓝图创建路由

使用蓝图创建路由的示例如下图:


4

该路由的创建有两点要注意,一是@main.route修饰器,在使用蓝图之前,所有的路由均通过@app.route注册,在此可对比创建蓝图后的不同。二是url_for函数的参数,该参数是一个“端点”名称,就是和在路由中定义的视图函数的名称,此处的‘ .index ’端点名是一种简写的方式,就是表示main蓝图下的index函数。如果我们要指向‘auth’蓝图下的index函数,应该使用‘ auth.index ’ 端点名称

另请注意图4中生成的url和通过@app.route修饰器生成的url没有区别,是因为在注册main蓝图时(见图2)没有加“前缀”。回到图2,对比main蓝图和auth蓝图的注册,会发现auth在注册时多了一个url_prefix=’/auth’ ,这个就是加的前缀。假如我们通过@auth.route(‘/student’)创建了一个路由,那么我们在访问该路由时,要输入www.somehost.com/auth/student 才能行。

3. 从蓝图回到全局

创建蓝本后,会对Flask已定义的一些功能造成改变。例如在Flask中提供了一个before_request 钩子,通过该钩子,可以注册在请求之前必须先完成的函数。在创建蓝本前,当访问通过@app.route修饰器创建的所有路由时,均要先完成在钩子中注册的函数。但注册蓝本后,如果使用@main.before_request钩子,那么我们访问通过别的蓝本注册的路由时,可不用先完成在钩子中注册的函数。如果仍要保持“全局”的功能,应该使用@main.before_app_request钩子。

回到文章的起点,蓝本的使用是程序结构明晰,在后续使用中如果有其他心得,笔者会继续补充。





原文链接: https://www.jianshu.com/p/95b584e4f76e
相关文章
|
2月前
|
前端开发 JavaScript 中间件
七、Flask蓝图使用之七
七、Flask蓝图使用之七
40 0
|
5月前
|
存储 数据库 开发者
Flask中的蓝图与插件应用:构建模块化Web应用的利器
【7月更文挑战第19天】Flask蓝图和插件是构建模块化、可扩展和可维护Web应用的强大工具。蓝图允许你将应用分割成多个独立的部分,提高了代码的组织性和可重用性;而插件则为Flask应用提供了丰富的功能和社区支持,简化了开发过程。通过合理地使用蓝图和插件,你可以更加高效地开发出高质量的Web应用。
|
6月前
|
Python
Flask蓝图(Blueprint)
蓝图是一种将路由、视图函数和静态文件等组织在一起的方法。它将相似功能的路由和视图函数分组,使得应用程序更易于维护和扩展。下面是一个简单的蓝图示例:app.run()在上述示例中,我们创建了一个名为的蓝图,并将路由定义在其中。然后,我们通过方法将蓝图注册到 Flask 应用程序中。这样,当用户访问和/about路径时,Flask 将调用相应的视图函数并返回结果。
65 1
|
7月前
|
存储 缓存 安全
Flask中的Blueprint
【5月更文挑战第15天】在Flask中,Blueprints用于实现Web应用的模块化,帮助组织路由和视图。它们提供模块化组织、路由命名空间和代码可重用性。通过创建和注册蓝图,如`auth_bp`和`blog_bp`,相关功能的代码可以分组,便于管理和维护。蓝图间可通过`session`共享数据,实现更复杂的功能。蓝图还能管理模板和静态文件,与测试框架和文档工具集成,并在部署和扩展时保持应用性能。通过合理利用Blueprints,开发者可以构建易于维护、高性能且安全的大型Web应用。
55 0
|
JSON 安全 数据格式
Flask 高级应用:使用蓝图模块化应用和 JWT 实现安全认证
本文将探讨 Flask 的两个高级特性:蓝图(Blueprints)和 JSON Web Token(JWT)认证。蓝图让我们可以将应用模块化,以便更好地组织代码;而 JWT 认证是现代 Web 应用中常见的一种安全机制。
|
存储 安全 开发者
Flask 蓝图机制及应用
Flask 蓝图机制及应用
|
数据可视化 Python
Python Flask Echarts数据可视化图表实战晋级笔记(3)Blueprint蓝图解决单文件url分发
Python Flask Echarts数据可视化图表实战晋级笔记(3)Blueprint蓝图解决单文件url分发
103 0
|
Python
一分钟快速实现Flask框架的蓝图和视图
一分钟快速实现Flask框架的蓝图和视图
123 0
如何使用flask 中的Blueprint
如何使用flask 中的Blueprint
|
调度 Python
Flask学习与项目实战4:视图高级之蓝图和子域名、类视图
对于大项目,代码都不放在app.py里面,需要分类。 即类似javaspringboot中的分层?每个功能分为一个更小规格的层次。 url_prefix 就是 蓝图的前缀。 和book相关的都在book中,和用户有关的都在user中。
Flask学习与项目实战4:视图高级之蓝图和子域名、类视图