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('/')
def show(page):    
    try:        
        return render_template('pages/%s.html' % page)    
    except TemplateNotFound:        
        abort(404)

可以看到，这里处理了两类路由，第一个是 '/' 根路由，另一个是 '/' 的具体页面路由。对于这两类路由，定义了一个handler，即展示对应的模板页面，如果在模板路径下没有找到对应的模板页面，则抛出404错误。需要注意的是，这里的/是动态路由匹配，可以匹配到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主要涉及到以下几点：

• 蓝图的定义
• 蓝图的分区原则（两种架构类型）
• 蓝图的注册和使用