前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >27. Flask 蓝图 Blueprint

27. Flask 蓝图 Blueprint

作者头像
Devops海洋的渔夫
发布2020-02-18 17:19:05
7580
发布2020-02-18 17:19:05
举报
文章被收录于专栏:Devops专栏

为什么需要蓝图?

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

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

代码语言:javascript
复制
from flask import Flask

app = 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应用

代码语言:javascript
复制
from flask import Flask

# 导入admin中的内容
from .admin import admin_home, new, edit

app = 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专门编写视图函数

代码语言:javascript
复制
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,发现报错如下:

代码语言:javascript
复制
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, edit
  File "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实例,用来设置路由。

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

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

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

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

并且可以看到上面我设置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() 方法,这将会修改程序实例的路由映射列表。

蓝图的使用:

一、创建蓝图对象。

代码语言:javascript
复制
from flask import Flask,Blueprint

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

二、注册蓝图路由。

代码语言:javascript
复制
@admin.route('/')
def admin_index():
    return 'admin_index'

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

代码语言:javascript
复制
app.register_blueprint(admin,url_prefix='/admin')

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

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

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

代码语言:javascript
复制
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

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

代码语言:javascript
复制
from flask import Flask

app = 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/

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

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

本文参与 腾讯云自媒体同步曝光计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 为什么需要蓝图?
    • 循环引用问题
      • 什么是蓝图 Blueprint?
        • 蓝图的运行机制:
          • 蓝图的使用:
            • 使用蓝图编写归纳多个应用的示例
            相关产品与服务
            容器服务
            腾讯云容器服务(Tencent Kubernetes Engine, TKE)基于原生 kubernetes 提供以容器为核心的、高度可扩展的高性能容器管理服务,覆盖 Serverless、边缘计算、分布式云等多种业务部署场景,业内首创单个集群兼容多种计算节点的容器资源管理模式。同时产品作为云原生 Finops 领先布道者,主导开源项目Crane,全面助力客户实现资源优化、成本控制。
            领券
            问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档