蓝图(Blueprint)

蓝图的作用是可以把一个应用拆分成多个文件,以便于大型应用的编写。

实现一个简单的蓝图。

本例中,文件目录是这样组织的:

/main.py  # 主函数写在这
/routes  # 按功能拆分路由
    /todo.py
    /user.py

我们根据功能,把和 Todo 功能相关的路由函数写到 todo.py 中,把和 User 相关的路由函数写到 user.py 中。

编写 todo.py

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
todo_routes = Blueprint('todo', __name__)


@todo_routes.route('/')
def index():
    return 'Here is Todo!'

编写 user.py

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
user_routes = Blueprint('user', __name__)


@user_routes.route('/')
def index():
    return 'Here is User!'

编写 main.py

from flask import Flask

# 引入各个路由的蓝图对象
from routes.todo import todo_routes
from routes.user import user_routes


app = Flask(__name__)
# 设置 secret_key 来使用 flask 自带的 session
# 这个字符串随便你设置什么内容都可以
app.secret_key = 'random string'


# 注册蓝图
# 有一个 url_prefix 可以用来给蓝图中的每个路由加一个前缀
# 比如:碰到 "/todo" 开头的 URL,就会用 todo_routes 的函数来处理
app.register_blueprint(todo_routes, url_prefix='/todo')
app.register_blueprint(user_routes, url_prefix='/user')


# 运行代码
if __name__ == '__main__':
    # debug 模式可以自动加载你对代码的变动, 所以不用重启程序
    # host 参数指定为 '0.0.0.0' 可以让别的机器访问你的代码
    config = dict(
        debug=True,
        host='0.0.0.0',
        port=3000,
    )
    app.run(**config)

这时候,打开 "http://127.0.0.1:3000/todo/",“http://127.0.0.1:3000/user/”,就能见到蓝图工作了。

可能我们会对 Blueprint('user', __name__) 中第一个参数的作用有疑问,这类似于 Django URLs 中的 name 参数的作用。

上面例子中,我们可以用 url_for('todo.index') 或者 url_for('user.index') 来找到对应方法的 URL。




下面我们用蓝图来实现 Django 风格的文件目录。

/main.py  # 主函数写在这
/todo_app
    /__init__.py
    /models.py
    /views.py
    /templates  # 属于 todo 的模板文件夹
        /todo_index.html
/user_app
    /__init__.py
    /models.py
    /views.py
    /templates  # 属于 user 的模板文件夹
        /user_index.html

编写 todo_app/views.py

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
todo_routes = Blueprint(
    'todo', 
    __name__, 
    template_folder = 'templates', # 设定模板目录
    url_prefix='/todo' # 设定后缀 url
    )


@todo_routes.route('/')
def index():
    return render_template('todo_index.html')

编写 user_app/views.py

from flask import (
    render_template,
    request,
    redirect,
    url_for,
    Blueprint,
)


# 创建一个 蓝图对象 并且路由定义在蓝图对象中
# 然后在 flask 主代码中「注册蓝图」来使用
# 第一个参数是蓝图的名字, 第二个参数是套路
user_routes = Blueprint(
    'user', 
    __name__, 
    template_folder = 'templates',
    url_prefix='/user'
    )


@user_routes.route('/')
def index():
    return render_template('user_index.html')

编写 main.py

from flask import Flask

# 引入各个路由的蓝图对象
from todo_app.views import todo_routes
from user_app.views import user_routes


app = Flask(__name__)
# 设置 secret_key 来使用 flask 自带的 session
# 这个字符串随便你设置什么内容都可以
app.secret_key = 'random string'


# 注册蓝图
app.register_blueprint(todo_routes)
app.register_blueprint(user_routes)


# 运行代码
if __name__ == '__main__':
    config = dict(
        debug=True,
        host='0.0.0.0',
        port=3000,
    )
    app.run(**config)

本例子的代码:https://github.com/SingleDiego/Flask-Blueprint-Demo

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 205,386评论 6 479
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,939评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,851评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,953评论 1 278
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,971评论 5 369
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,784评论 1 283
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,126评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,765评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,148评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,744评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,858评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,479评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,080评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,053评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,278评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,245评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,590评论 2 343

推荐阅读更多精彩内容