python之蓝图blueprint浅析

慕城南风

已于 2022-04-14 19:42:53 修改

阅读量9.1k

点赞数 10

分类专栏： flask 文章标签： blueprint python

于 2020-06-11 16:22:36 首次发布

本文链接：https://blog.csdn.net/lovedingd/article/details/106690903

版权

flask 专栏收录该内容

9 篇文章 10 订阅

订阅专栏

背景

由于我们现在的项目开发是一个相对于来说非常耗时间和精力的工程，如果我们将所有的Flask的请求方法都写在同一个文件下的话，非常不便于我们的代码的管理和后期的功能代码的添加。
如下示例：我们在一个文件中写入多个路由，这会使代码维护变得困难。

如图所示，如果我们将所有的请求方法写在同一个处理文件下面的话，会导致我们的代码显得很没有逻辑性，如果我们后期想要修改代码或者添加新的代码的话，就会显得很尴尬，不知道如何的下手，此时就需要我们的所谓的蓝图来解决这个问题了，如果学过django的程序员可能了解过django中的app的作用了，没错，django中的app的主要作用就是将django的项目分成一个个单独的app，然后将所有的app分配不同的处理功能，通过路由分配将它们连接成一个大的django项目，其实Flask中的蓝图和django中的app功能大同小异。

一、python中的蓝图

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

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

一个项目可以具有多个Blueprint
可以将一个Blueprint注册到任何一个未使用的URL下比如 “/”、“/sample”或者子域名
在一个应用中，一个模块可以注册多次
Blueprint可以单独具有自己的模板、静态文件或者其它的通用操作方法，它并不是必须要实现应用的视图和函数的
在一个应用初始化时，就应该要注册需要使用的Blueprint

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

Blueprint对象用起来和一个应用/Flask对象差不多，最大的区别在于一个蓝图对象没有办法独立运行，必须将它注册到一个应用对象上才能生效。

二、创建蓝图

1. 我们首先创建一个主路由配置文件manage.py，该文件主要的作用就是启动整个的Flask框架（项目），如图所示

2. 接着，我们在manage.py的平级的目录下创建两个文件admin.py、user.py，我们大概看一下两个文件中的内容：

这两个文件相当于django中的两个app了，不同是django中的路由分配是将大的路由通过include分配给app的urls.py，而Flask是通过蓝图注册的方式将蓝图添加到主app中，user.py，admin.py中主要是创建蓝图，然后为创建的蓝图可以添加部分的路由配置。

3. 接着我们就可以在主路由文件manage.py中将我们创建的蓝图注册到主app中了。

最后我们配置好了以后，就可以实现我们的路由分层管理了，我们来试一下，运行主程序manage.py

我们在浏览器中访问我们所设置的路由

我们我请求的路由和我们所设置的返回值是一样的，这样我们就大概的完成了一个Flask的蓝图的注册，实现了文件功能的分层次管理了。

三、蓝图的运行机制

蓝图是保存了一组将来可以在应用对象上执行的操作，注册路由就是一种操作
当在app对象上调用 route 装饰器注册路由时，这个操作将修改对象的url_map路由表
然而，蓝图对象根本没有路由表，当我们在蓝图对象上调用route装饰器注册路由时,它只是在内部的一个延迟操作记录列表defered_functions中添加了一个项
当执行app对象的 register_blueprint() 方法时，应用对象将从蓝图对象的 defered_functions 列表中取出每一项，并以自身作为参数执行该匿名函数，即调用应用对象的 add_url_rule() 方法，这将真正的修改应用对象的usr_map路由表

四、蓝图的url前缀

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

在应用最终的路由表 url_map中，在蓝图上注册的路由URL自动被加上了这个前缀，这个可以保证在多个蓝图中使用相同的URL规则而不会最终引起冲突，只要在注册蓝图时将不同的蓝图挂接到不同的自路径即可
url_for在使用时，如果要生成一个蓝图里面的视图对应的路由地址，则需要声明当前蓝图名称+视图名称

url_for('users.home') # /users/home

五、注册蓝图中的静态文件的相关路由

和应用对象不同，蓝图对象创建时不会默认注册静态目录的路由。需要我们在创建时指定 static_folder 参数。

下面的示例将蓝图所在目录下的static_users目录设置为静态目录

# users/__init__.py，代码：
user_blu = Blueprint("users",__name__,static_folder='static_users')

# 启动文件 main.py，代码：
from users import user_blu
app.register_blueprint(user_blu,url_prefix='/users')

现在就可以使用/admin/static_admin/ 访问static_admin目录下的静态文件了定制静态目录URL规则：可以在创建蓝图对象时使用 static_url_path 来改变静态目录的路由。

下面的示例将为 static_admin 文件夹的路由设置为 /lib

admin = Blueprint("admin",__name__,static_folder='static_admin',static_url_path='/lib')
app.register_blueprint(admin,url_prefix='/admin')

六、设置蓝图中模版的目录

蓝图对象默认的模板目录为系统的模版目录，可以在创建蓝图对象时使用 template_folder 关键字参数设置模板目录

创建蓝图中的模板目录template_users :

admin = Blueprint('admin',__name__,template_folder='templates_users')

注:如果在 templates 中存在和 templates_users 有同名模板文件时, 则系统会优先使用 templates 中的文件

七、调整session配置

分析SQLAlachemy的构造方式可以发现，初始化并非一定要传递app应用对象到内部，事实上它提供了init_app方法给我们后续调用。而 init_app 方法是flask框架要求任何的第三方组件都要实现这个方法。

init_app方法内部就是要第三方组件开发者编写一些使用当前组建的默认配置项以及把当前组件设置成一个对象，加载到app对象内部extensions字典才能让开发者在flask框架内部配置和使用当前组件。

我们可以利用这种组件开发机制，那么把配置代码抽离出去。

配置文件中：

import redis
from flask_sqlalchemy import SQLAlchemy
# 创建db对象
db = SQLAlchemy()
class Config(object):
    DEBUG = True
    SECRET_KEY = "*(%#4sxcz(^(#$#8423"
    # 数据库链接配置:
    #数据类型://登录账号:登录密码@数据库主机IP:数据库访问端口/数据库名称
    SQLALCHEMY_DATABASE_URI = "mysql://root:123@127.0.0.1:3306/flask_students"
    # 设置mysql的错误跟踪信息显示
    SQLALCHEMY_TRACK_MODIFICATIONS = True
    # 打印每次模型操作对应的SQL语句
    SQLALCHEMY_ECHO = True

    """把session保存到redis中"""
    # session存储方式为redis
    # SESSION_TYPE="redis"
    # # 如果设置session的生命周期是否是会话期, 为True，则关闭浏览器session就失效
    # SESSION_PERMANENT = False
    # # 是否对发送到浏览器上session的cookie值进行加密
    # SESSION_USE_SIGNER = False
    # # 保存到redis的session数的名称前缀
    # SESSION_KEY_PREFIX = "session:"
    # # session保存数据到redis时启用的链接对象
    # SESSION_REDIS = redis.Redis(host='127.0.0.1', port='6379')  # 用于连接redis的配置

    SESSION_TYPE= 'sqlalchemy'  # session的存储方式为sqlalchemy
    SESSION_SQLALCHEMY= db  # SQLAlchemy对象
    SESSION_SQLALCHEMY_TABLE= 'sessions'  # session要保存的表名称
    SESSION_PERMANENT= True  # 如果设置为True，则关闭浏览器session就失效。
    SESSION_USE_SIGNER= False  # 是否对发送到浏览器上session的cookie值进行加密
    SESSION_KEY_PREFIX= 'session:'  # 保存到session中的值的前缀

启动文件main.py，代码：

from flask import Flask
from config import Config,db
from flask_session import Session

from flask import session

app = Flask(__name__,template_folder='templates')
app.config.from_object(Config)

# 把app加载到db对象中
db.init_app(app)

Session(app)

@app.route("/")
def index():
    return "ok"

@app.route("/set_session")
def set_session():
    """设置session"""
    session["username"] = "小明"
    return "ok"

if __name__ == '__main__':
    # db.create_all()
    print( app.url_map )
    app.run()