一、什么是蓝图
Flask 蓝图(Blueprint)是一种组织 Flask 应用的方式,允许将应用拆分为更小、更易于管理的部分。蓝图可以包含路由、视图函数、模板和静态文件等,并且可以在多个应用中重复使用。
在 Flask 中,蓝图允许你创建可重用的应用组件,每个蓝图都可以独立于 Flask 应用创建、注册和使用。通过使用蓝图,可以将应用的功能分成逻辑上相关的模块,使代码结构更加清晰,易于维护和扩展。
之前介绍过,我们有个主程序文件app.py,里面可以写项目的url
和视图函数,但如果项目比较大的话,所有代码都写到app程序文件里面,这显然不是一个合理的结构,此时用上蓝图可以优雅的帮我们实现这种需求。
二、蓝图的使用介绍
以下是一个简单的 Flask 蓝图使用案例:
假设我们有一个简单的博客应用,其中包含用户身份验证、文章管理和评论功能。我们可以使用蓝图来组织这些功能。
1、创建蓝图: 首先,我们可以创建三个蓝图来分别管理用户认证、文章和评论:
# auth.py
from flask import Blueprintauth_bp = Blueprint('auth', __name__)
# article.py
from flask import Blueprintarticle_bp = Blueprint('article', __name__)
# comment.py
from flask import Blueprintcomment_bp = Blueprint('comment', __name__)
2、注册蓝图: 然后,在应用的主文件中注册这些蓝图:
from flask import Flask
from auth import auth_bp
from article import article_bp
from comment import comment_bpapp = Flask(__name__)
app.register_blueprint(auth_bp, url_prefix='/auth')
app.register_blueprint(article_bp, url_prefix='/article')
app.register_blueprint(comment_bp, url_prefix='/comment')
3、定义路由和视图函数: 在每个蓝图中定义相应的路由和视图函数:
# auth.py
@auth_bp.route('/login')
def login():
return 'Login Page'# article.py
@article_bp.route('/')
def articles():
return 'List of Articles'# comment.py
@comment_bp.route('/')
def comments():
return 'List of Comments'
三、子域名在蓝图中的使用
如果在flask项目中需要使用到子域名设置,子域名的实现一般也是通过蓝图来实现。创建蓝图的时候我们知道添加了一个url_prefix=/user作为url前缀,那样我们就可以通过/user/来访问user下的url。但使用子域名则不需要。另外,还需要配置SERVER_NAME,比如app.config[SERVER_NAME]='example.com:9000'。并且在注册蓝图的时候,还需要添加一个subdomain的参数,这个参数就是子域名的名称。
看一下蓝图的实现过程(例如admin.py):
from flask import Blueprint
bp = Blueprint('admin',__name__,subdomain='admin')@bp.route('/')
def admin():
return 'Admin Page'
app的实现:
from flask import Flask
import admin# 配置`SERVER_NAME`
app.config['SERVER_NAME'] = 'example.com:8000'
# 注册蓝图,指定了subdomain
app.register_blueprint(admin.bp)if __name__ == '__main__':
app.run(host='0.0.0.0',port=8000,debug=True)
写完以上两个文件后,还是不能正常的访问admin.example.com:8000这个子域名,因为我们没有在host文件中添加域名解析,你可以在最后添加一行127.0.0.1 admin.example.com,就可以访问到了。另外,子域名不能在127.0.0.1上出现,也不能在localhost上出现