Flask--蓝图

Posted 2020-12-01 hades123

目录

• Flask--蓝图
  • 导入
    • 不使用蓝图，自己进行分文件
  • Blueprint概念
  • 初识蓝图
  • 运行机制
  • 蓝图的url前缀
  • 注册静态路由
  • 设置模版目录
  • 使用实例
    • 中小型系统
    • 大型项目

Flask--蓝图

导入

由于我们现在的项目开发是一个相对于来说非常耗时间和精力的一个工程，如果我们将所有的Flask的请求方法都写在同一个文件下的话，非常的不便于我们的代码的管理和后期的功能代码的添加

当我们在一个文件中写入多个路由，这会使代码维护变得困难。所以就需要进行分文件进行处理

不使用蓝图，自己进行分文件

目录结构

Blueprint概念

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

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

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

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

初识蓝图

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

使用蓝图可以分为三个步骤

1. 创建一个蓝图对象

   from flask import Blueprint
   admin=Blueprint('admin',__name__)

2. 在这个蓝图对象上进行操作,注册路由,指定静态文件夹,注册模版过滤器

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

3. 在应用对象上注册这个蓝图对象

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

当这个应用启动后,通过/admin/可以访问到蓝图中定义的视图函数

运行机制

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

蓝图的url前缀

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

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

• url_for

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

注册静态路由

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

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

admin = Blueprint("admin",__name__,static_folder='static_admin')

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

现在就可以使用/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 关键字参数设置模板目录

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

使用实例

中小型系统

目录结构

flask_pro
  |-- flask_test
  |     |-- __init__.py
  |     |-- static
  |     |-- templates
  |     |-- views
  |     |     |-- order.py
  |     |     |-- user.py
  |-- manage.py 

__init.py__

from flask import  Flask
app=Flask(__name__)

from flask_test.views import user
from flask_test.views import order

app.register_blueprint(user.us)
app.register_blueprint(order.ord)

manage.py

from flask_test import  app

if __name__ == '__main__':
    app.run()

user.py

from flask import Blueprint
us=Blueprint('user',__name__)

@us.route('/login')
def login():
    return 'login'

order.py

from flask import Blueprint
ord=Blueprint('order',__name__)

@ord.route('/test')
def test():
    return 'order test'

大型项目

目录结构

flask_pro
  |-- flask_test
  |     |-- __init__.py
  |     |-- admin
  |     |    |-- __init__.py
  |     |    |-- static
  |     |    |-- templates
  |     |    |-- views.py
  |     |-- web
  |     |    |-- __init__.py
  |     |    |-- static
  |     |    |-- templates
  |     |    |-- views.py
  |-- run.py 

run.py

from pro_flask import app

if __name__ == '__main__':
    app.run()

flask_test/__init__.py

from flask import Flask
from .admin import admin
from .web import web

app = Flask(__name__)
app.debug = True

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

admin/__init__.py

from flask import Blueprint

admin = Blueprint(
    'admin',
    __name__,
    template_folder='templates',
    static_folder='static'
)
from . import views

admin/views.py

from . import admin

@admin.route('/index')
def index():
    return 'Admin.Index'

web/__init__.py

from flask import Blueprint

web = Blueprint(
    'web',
    __name__,
    template_folder='templates',
    static_folder='static'
)
from . import views

web/views.py

from . import web

@web.route('/index')
def index():
    return 'Web.Index'