Flask 蓝图 Blueprint

2024-08-21 03:58
文章标签 flask blueprint 蓝图

本文主要是介绍Flask 蓝图 Blueprint,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

为什么需要蓝图?

我们在使用Flask框架,是从写单个文件,执行hello world开始的。我们在这单个文件中可以定义路由、视图函数、定义模型等等。但这显然存在一个问题:随着业务代码的增加,将所有代码都放在单个程序文件中,是非常不合适的。这不仅会让代码阅读变得困难,而且会给后期维护带来麻烦。

如下示例:我们在一个文件中写入多个路由,这会使代码维护变得困难。

from flask import Flaskapp = Flask(__name__)@app.route('/')
def index():return 'index'@app.route('/list')
def list():return 'list'@app.route('/detail')
def detail():return 'detail'@app.route('/admin_home')
def admin_home():return 'admin_home'@app.route('/new')
def new():return 'new'@app.route('/edit')
def edit():return 'edit'if __name__ == '__main__':app.run()

问题:一个程序执行文件中,功能代码过多。这种情况下就需要让代码模块化。根据具体不同功能模块的实现,划分成不同的分类,降低各功能模块之间的耦合度。python中的模块制作和导入就是基于实现功能模块的封装的需求。

尝试用模块导入的方式解决: 我们把上述一个py文件的多个路由视图函数给拆成两个文件:app.py和admin.py文件。app.py文件作为程序启动文件,因为admin文件没有应用程序实例app,在admin文件中要使用app.route路由装饰器,需要把app.py文件的app导入到admin.py文件中。

1. 文件app.py专门编写app应用

from flask import Flask# 导入admin中的内容
from .admin import admin_home, new, editapp = Flask(__name__)@app.route('/')
def index():return 'index'@app.route('/list')
def list():return 'list'@app.route('/detail')
def detail():return 'detail'if __name__ == '__main__':app.run(debug=True)

2. 文件admin.py专门编写视图函数

from .app import app@app.route('/admin_home')
def admin_home():return 'admin_home'@app.route('/new')
def new():return 'new'@app.route('/edit')
def edit():return 'edit'

3. 在app.py启动flask,发现报错如下:

13423234-bce6d02ce6e438c7.png
Error: While importing "flask-ex2.app", an ImportError was raised:Traceback (most recent call last):File "F:\pythonProject\flask-ex2\venv\lib\site-packages\flask\cli.py", line 240, in locate_app__import__(module_name)File "F:\pythonProject\flask-ex2\app.py", line 4, in <module>from .admin import admin_home, new, editFile "F:\pythonProject\flask-ex2\admin.py", line 1, in <module>from .app import app
ImportError: cannot import name 'app' from 'flask-ex2.app' (F:\pythonProject\flask-ex2\app.py)

这是两个相近的包模块相互导入导致类似死锁的循环引用问题。

循环引用问题

1. 当app.py需要导入admin.py中某些视图函数的时候,admin.py也需要导入app.py中的app实例,用来设置路由。

13423234-0e48c792b99cbf40.png

2.由于admin.py需要导入app实例,但是app.py需要导入admin.py的视图函数之后,才能进行往下执行完整代码,创建app实例,这就导致一个相互互斥死锁的问题。

3.解决这个互斥问题,可以使用首先避免app.py立即导入admin.py的视图函数的情况,例如将导入admin.py的步骤写到创建app实例之后,如下:

13423234-d9909dbfe906eab9.png

4.成功启动app之后,访问index视图和admin.py中admin_home视图,如下:

13423234-95a8978fbd78660b.png
13423234-cdd949edccb8408d.png

这种方式虽然也可以拆分视图,但是可以看到如果想要将一个模板、静态文件、数据模型文件整合拆分出去,也没那么方便。

并且可以看到上面我设置app为调试模式,但是启动之后,app的配置貌似都失效了,可以看到Debug mode:off

5.总结性来看,app.py与admin.py耦合性最高的地方就是app实例。只需要将app实例替换为另一个方式来给admin.py单独设置路由、静态文件、模板文件,那么就可以很好的拆分出来,类似与Django中的创建应用一样。那么这时候就可以使用蓝图来替换app实例了。

什么是蓝图 Blueprint?

蓝图 Blueprint:用于实现单个应用的视图、模板、静态文件的集合。

蓝图就是模块化处理的类。

简单来说,蓝图就是一个存储操作路由映射方法的容器,主要用来实现客户端请求和URL相互关联的功能。 在Flask中,使用蓝图可以帮助我们实现模块化应用的功能。

蓝图的运行机制:

蓝图是保存了一组将来可以在应用app对象上执行的操作。
注册路由就是一种操作,当在程序实例上调用route装饰器注册路由时,这个操作将修改对象的url_map路由映射列表。
当我们在蓝图对象上调用route装饰器注册路由时,它只是在内部的一个延迟操作记录列表defered_functions中添加了一个项。
当执行应用对象的 register_blueprint() 方法时,应用对象从蓝图对象的 defered_functions 列表中取出每一项,即调用应用对象的 add_url_rule() 方法,这将会修改程序实例的路由映射列表。

蓝图的使用:

一、创建蓝图对象。

from flask import Flask,Blueprint#Blueprint必须指定两个参数,admin表示蓝图的名称,__name__表示蓝图所在模块
admin = Blueprint('admin',__name__)

二、注册蓝图路由。

@admin.route('/')
def admin_index():return 'admin_index'

三、在程序实例中注册该蓝图。

app.register_blueprint(admin,url_prefix='/admin')

使用蓝图编写归纳多个应用的示例

1.创建多个应用的文件结构如下:

13423234-9f804aa82e64287e.png

2. 在user文件夹下,创建views.py视图文件

from flask import Blueprint,render_template#Blueprint必须指定两个参数,user表示蓝图的名称,__name__表示蓝图所在模块
user = Blueprint('user',__name__,static_folder='static',template_folder='templates')@user.route('/')
def index():return render_template('user_index.html')

3. 编写user_index.html

13423234-d26e645bd3264707.png

4.回到应用app.py入口文件注册应用的蓝图

from flask import Flaskapp = Flask(__name__)# 注册蓝图
from apps.user.views import user
app.register_blueprint(user,url_prefix='/user')@app.route('/')
def index():return 'index'@app.route('/list')
def list():return 'list'@app.route('/detail')
def detail():return 'detail'if __name__ == '__main__':print(app.url_map)app.run(debug=True)

5.执行python3 app.py启动应用

访问应用user的视图函数: http://127.0.0.1:5000/user/

13423234-5346ec3e96396d21.png

访问入口app.py的视图函数: http://127.0.0.1:5000/

13423234-44751849da58f5e4.png

从上面的示例来看,两个视图函数访问都正常。说明Flask完全可以跟Django一样,利用蓝图将多个应用拆分到不同的文件夹下,最后在入口启动文件注册路由信息即可。

13423234-0e3934319aa622f6.png

这篇关于Flask 蓝图 Blueprint的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1092058

相关文章

flask-login 生成 cookie,session

flask-login 生成 cookie,session Flask-Login login_user() 显示来自 Set-Cookie 标头的加密 cookie # 模拟一个用户类class User(UserMixin):def __init__(self, id):self.id = id@app.route('/login')def login():# 模拟用户登录过程user

AI产品经理成长蓝图:从入门到精通的学习路径指南

AI产品经理区别于普通产品经理的地方,不止在懂得AI算法,更重要的是具有AI思维。 人工智能产品设计要以操作极度简单为标准,但是前端的简单代表后端的复杂,系统越复杂,才能越智能。 同样,人工智能的发展依赖于产业生态的共同推进,上游芯片提供算力保障,中游人工智能厂商着力研发算法模型,下游应用领域提供落地场景。 一、人工智能产业链结构 人工智能产业链结构上可分为基础层(计算基础设施)、技术层(

Flask 创建app 时候传入的 static_folder 和 static_url_path参数理解

Flask 在创建app的时候 是用 app = Flask(__name__) 来创建的,不传入 static_folder参数的话 ,默认的静态文件的位置是在 static目录下 我们可以进入 Flask的源码里面查看 ctrl+鼠标左键进入 这是Flask的 __init__源码(后面还有一些,我就选了需要的代码)     def __init__(self,import_

【python web】Flask+Echarts 实现动图图表

flask 是python web开发的微框架,Echarts酷炫的功能主要是javascript起作用,将两者结合起来,发挥的作用更大。下面将Echarts嵌套进Flask的html模板中。 项目结构: 打开demo.py运行,点击console中的链接http://127.0.0.1:5000/ 就可以看到我们想要的动态图表。 demo.py #coding:utf-8fro

UE4尝试用C++创建蓝图并添加变量

目标 使用C++创建蓝图资源,并尝试给蓝图添加变量。 (引擎版本4.26) 步骤0. 创建测试用插件 使用编辑器工具栏按钮为模板创建插件。 使用这个模板的理由是它初始会有个按钮,可以用来触发操作: 之后将会替换这其中所触发的操作。 步骤1. 创建蓝图 对KismetEditorUtilities.h进行include,因为创建蓝图需要用到其中的方法: #include"Kismet

Flask-Session扩展,使用Redis存储会话数据

深入理解Flask-session扩展Redis Flask 应用中使用 flask-session 扩展将 session 数据存储在 Redis 中是一种高效且可扩展的方法,特别是在需要处理大量用户或需要分布式部署的应用中。以下是如何在 Flask 应用中配置 flask-session 以使用 Redis 存储 session 的步骤: 1. 安装必要的库 首先,你需要安装 Flask

Flask:Python轻量级Web框架详解

Flask是一个用Python编写的轻量级Web应用框架。它被设计为易于使用和扩展,非常适合小型项目和微服务,同时也能够支持大型应用。Flask依赖于少量的外部库,并且提供了一个简单的方式来创建Web应用。 Flask的主要特点 轻量级:Flask核心非常简单,使得它易于理解和扩展。扩展性:Flask可以通过扩展来增加额外的功能。灵活性:Flask允许你以任何你喜欢的方式组织你的应用。微核心设

如何处理Flask中的路由

在Flask框架中,路由是Web应用的核心组成部分之一,它定义了URL路径与视图函数之间的映射关系。当用户通过浏览器访问特定的URL时,Flask会根据定义的路由规则找到对应的视图函数,并调用该函数来处理请求,最后返回响应给客户端。处理Flask中的路由涉及定义路由、动态路由、路由参数、路由装饰器、蓝图等多个方面。由于直接撰写5000字详细阐述这些内容可能过于冗长,我将提供一个简明而全面的概述,并

Flask中 blinker 是什么

在Flask框架中,blinker 是一个非常重要的组件,它作为信号处理的库,为Flask应用提供了一种灵活而强大的事件处理机制。以下是对Flask中blinker的详细阐述,考虑到篇幅限制,无法直接达到5000字,但会尽量全面而深入地介绍其关键方面。 一、blinker 简介 blinker 是一个基于Python的轻量级信号库,它允许开发者在Python应用程序中实现观察者模式(也称为发布

Flask中多app应用怎么完成

在Flask中实现多app应用,通常指的是在同一个Flask项目中运行多个相对独立的应用(或称为模块、组件)。这种需求在大型项目中尤为常见,因为它可以帮助开发者更好地组织代码,提高项目的可维护性和可扩展性。以下将详细阐述Flask中多app应用的实现方式,但请注意,由于篇幅限制,无法直接提供6000字的详细解答,但会尽量全面且深入地介绍相关概念和步骤。 一、Flask多app应用的基本概念 在