Flask官方Example分析(二)--blueprintexample

所有例子代码均来自于Flask的 7fca843b5f 版本

为了学习flask框架,我决定开始学习flask在GitHub上给出的官方example来熟悉flask的使用方法,在此版本中包含blueprintexample,flaskr,jqueryexample,minitwit这四个例子,今天分析的是blueprintexample这个例子。

blueprintexample是什么?

如这个项目的名称所说,这是一个blueprint的demo,那什么又是blueprint呢?

其实,blueprint是flask里面的一个概念,它定义了用于某一单一模块的视图(view),模板(templates),静态文件(static),表单(forms)等等资源。举个例子,如果豆瓣有几个用于登录的界面(比如分别用于豆瓣读书,豆瓣电影等等),这种情况就可以定义一个用于登录的蓝图,这个蓝图不仅定义了像/user/books/login/user/movies/login等路由,还包含了所需要的模板(大多数flask项目中用到的是jinja2)和静态文件(图片,css文件等资源)。

蓝图的优势在于工程的模块化,也就是常说的松耦合,将不同的模块分开组织,将一个复杂的工程分解成若干功能单一,扩展性强的蓝图。

目前而言,蓝图大概有两种组织形式:功能式架构和分区式架构。

功能式架构

在功能式架构中,按照每部分代码的功能来组织你的工程,分割蓝图。所有模板放到同一个文件夹中(通常叫做templates),静态文件放在另一个文件夹(通常叫做static)中,而视图放在另外一个文件夹(通常叫做views)中。

下面展示一个功能式架构蓝图的文件结构例子:

app/
    __init__.py
    static/
    templates/
        home/
        user/
        admin/
        books/
        movies/
    views/
        __init__.py
        home.py
        user.py
        admin.py
        books.py
        movies.py
    models.py

分区式架构

在分区式架构中,按照每一业务部分所属的蓝图来组织你的应用。管理面板的所有的模板,视图和静态文件放在一个文件夹中,用户控制面板的则放在另一个文件夹中,数据展示面板的则另外创建一个蓝图。

下面展示一个分区式架构蓝图的文件结构例子:

app/
    __init__.py
    admin/
        __init__.py
        views.py
        static/
        templates/
    user/
        __init__.py
        views.py
        static/
        templates/
    books/
        __init__.py
        views.py
        static/
        templates/
    models.py

这两者组织形式没有对错之分,在实际生产当中,两种蓝图组织都有不小的使用量。

开始分析

首先来看一下这个flask官方的demo的组织形式:

blueprintexample/
    simple_page/
        templates/
            pages/
                hello.html
                index.html
                layout.html
                world.html
           __init__.py
           simple_page.py
       blueprintexample.py
       test_blueprintexample.py

很明显,这里定义了一个叫做simplepage的蓝图,这里没有用到除了templates之外的资源,所有的simplepage资源都在pages文件之下。

我们来首先看一下simple_page.py这个文件:

from flask import Blueprint, render_template, abort
from jinja2 import TemplateNotFound

这里主要从flask和jinja2两个库引入方法,除了熟悉的flask之外,jinja2是flask默认的模板库。

simple_page = Blueprint('simple_page', __name__,template_floder='templates') 

@simple_page.route('/', defaults={'page': 'index'})
@simple_page.route('/<page>')
def show(page):    
    try:        
        return render_template('pages/%s.html' % page)    
    except TemplateNotFound:        
        abort(404)

可以看到,这里处理了两类路由,第一个是 '/' 根路由,另一个是 '/<page>' 的具体页面路由。对于这两类路由,定义了一个handler,即展示对应的模板页面,如果在模板路径下没有找到对应的模板页面,则抛出404错误。需要注意的是,这里的/<page>是动态路由匹配,可以匹配到hello.html,layout.html,world.html等模板文件,更多的路由知识点。

上面就是simp_page.py的全部内容,做了很简单的事,就是针对路由返回相应的模板,但是是一个相对独立的功能模块,还包含有自己的资源。

下面来着重看一下蓝图的注册和使用:

主要需要看的是blueprintexample.py这个文件。

from flask import Flask
from simple_page.simple_page import simple_page

这里将simple_page引入,为下文的蓝图注册引入资源。

app = Flask(__name__)
app.register_blueprint(simple_page)
app.register_blueprint(simple_page, url_prefix='/pages')

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

需要注意的是,这里对simple_page这个蓝图注册了两次,为了区分,后一次制定了url前缀。在flask里面允许对同一个蓝图在同一个文件里注册多次的(虽然大多数时候并没有这个必要)。
蓝图的注册的的确确就需要一行代码,就是app.register_blueprint(blueprint_name)这一行。

总结

我认为这个example主要涉及到以下几点:

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

推荐阅读更多精彩内容