Blueprint

模块化

随着flask程序越来越复杂,我们需要对程序进行模块化的处理,之前学习过python的模块化管理,于是针对一个简单的flask程序进行模块化处理

举例来说:

我们有一个博客程序,前台界面需要的路由为:首页,列表,详情等页面

源程序app.py文件:
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'
    
if __name__=='__main__':
    app.run()

如果博主需要编辑博客,要进入后台进行处理:后台主页,编辑,创建,发布博客

改进后程序: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('/')
def admin_home():
    return 'admin_home'
   
   
@app.route('/new')
def new():
    return 'new'
    
@app.route('/edit')
def edit():
    return 'edit'
  
  
 @app.route('/publish')
 def publish():
    return 'publish'
    
 if __name__=='__main__':
    app.run()

这样就使得我们在一个py文件中写入了很多路由,将来维护代码会非常麻烦,此时,同学们就考虑到了模块化的处理方式,将admin相关的路由写到一个admin.py文件中,那我们就顺着这个思路走下去

修改后的代码:
# app.pyfrom 

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'
    
if __name__=='__main__':
    app.run()



#  admin.py

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

发现app.py文件中的app直接报错,代码无法继续写下去,所以在flask程序中,使用传统的模块化是行不通的,需要flask提供一个特有的模块化处理方式,flask内置了一个模块化处理的类,即Blueprint

Blueprint概念

简单来说，Blueprint 是一个存储操作方法的容器，这些操作在这个Blueprint 被注册到一个应用之后就可以被调用，Flask 可以通过Blueprint来组织URL以及处理请求。

Flask使用Blueprint让应用实现模块化，在Flask中，Blueprint具有如下属性：

  • 一个应用可以具有多个Blueprint

  • 可以将一个Blueprint注册到任何一个未使用的URL下比如 “/”、“/sample”或者子域名

  • 在一个应用中，一个模块可以注册多次

  • Blueprint可以单独具有自己的模板、静态文件或者其它的通用操作方法，它并不是必须要实现应用的视图和函数的

  • 在一个应用初始化时，就应该要注册需要使用的Blueprint

但是一个Blueprint并不是一个完整的应用，它不能独立于应用运行，而必须要注册到某一个应用中。

初识蓝图

蓝图/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/可以访问到蓝图中定义的视图函数

蓝图的url前缀

  • 当我们在应用对象上注册一个蓝图时，可以指定一个url_prefix关键字参数（这个参数默认是/）

  • 在应用最终的路由表 url_map中，在蓝图上注册的路由URL自动被加上了这个前缀，这个可以保证在多个蓝图中使用相同的URL规则而不会最终引起冲突，只要在注册蓝图时将不同的蓝图挂接到不同的自路径即可

  • url_for

url_for('admin.index') # /admin/