所有例子代碼均來自于Flask的 7fca843b5f 版本

為了學(xué)習(xí)flask框架，我決定開始學(xué)習(xí)flask在GitHub上給出的官方example來熟悉flask的使用方法，在此版本中包含blueprintexample，flaskr，jqueryexample，minitwit這四個(gè)例子，今天分析的是flaskr這個(gè)例子。

Flaskr是什么

按照這個(gè)example給出的說明文檔，這是一個(gè) minimal blog application 數(shù)據(jù)庫方面，采用了Python自帶的微型數(shù)據(jù)庫sqlite。需要額外說明的是，這并非一個(gè)完整的應(yīng)用，而更像一個(gè)微型擴(kuò)展模塊或者說是模板。
接下來看一下他的文件結(jié)構(gòu)(省略了部分無關(guān)緊要的文件部分)：

• flaskr

 * flaskr
        * static
              * style.css
        * templates
              * layout.html
              * login.html
              * show_entries.html
        * __init__.py
        * flaskr.py
        * schema.sql
 * test
        * test_flaskr.py
 * setup.py

其中flaskr文件夾里的flaskr.py應(yīng)該是我們所要主要關(guān)注的部分。

開始分析

先來看import部分，簡單捋清楚所涉及的點(diǎn)

import os
from sqlite3 import dbapi2 as sqlite3
from flask import Flask, request, session, g,redirect, url_for, abort, render_template, flash

我希望你對以上的部分至少應(yīng)該是了解的，如果不是，就應(yīng)該去官方文檔了解一下相關(guān)的概念。

初始化

程序正式部分的第一行作用是初始化一個(gè)flask app:

app = Flask(__name__)

其中__name__變量應(yīng)該是flaskr，因?yàn)閒laskr是作為包導(dǎo)入使用的，如果是一個(gè)獨(dú)立的app，則__name__就是__main__。

配置部分

接下來就是配置部分的引入:

app.config.update(dict(    
    DATABASE=os.path.join(app.root_path, 'flaskr.db'),    
    DEBUG=True,    
    SECRET_KEY='development key',    
    USERNAME='admin',      
    PASSWORD='default'
))
app.config.from_envvar('FLASKR_SETTINGS', silent=True)

這里的config項(xiàng)包括了database的路徑，開啟了調(diào)試模式，配置了秘鑰（一般這種在代碼里顯示配置秘鑰的方式被認(rèn)為是不安全的，實(shí)際當(dāng)中更常用的方式是將秘鑰放進(jìn)服務(wù)器的一個(gè)環(huán)境變量中），規(guī)定了用戶名和密碼，剩余部分的config就通過from_envvar函數(shù)從一個(gè)叫FLASKR_SETTINGS中引入。

數(shù)據(jù)庫部分

先來看數(shù)據(jù)庫的連接和初始化部分：

#連接部分
def connect_db():
    rv = sqlite3.connect(app.config['DATABASE'])    
    rv.row_factory = sqlite3.Row    
    return rv
#初始化部分
def init_db():    
    db = get_db()    
    with app.open_resource('schema.sql', mode='r') as f:     
        db.cursor().executescript(f.read())    
    db.commit()

從配置項(xiàng)中引入數(shù)據(jù)庫的鏈接，并創(chuàng)建一個(gè)數(shù)據(jù)庫連接，并將這個(gè)數(shù)據(jù)庫句柄作為返回值。
初始化部分從schema.sql文件中讀取sql語句，并依此執(zhí)行，記得最后將執(zhí)行的操作結(jié)果提交操作（commit）。

@app.cli.command('initdb')
def initdb_command(): 
    init_db()    
    print('Initialized the database.')

接下來利用flask內(nèi)置的裝飾器將命令行中的initdb與initdb_command方法綁定，也就是說在flaskr執(zhí)行當(dāng)中，命令行中的initdb將直接調(diào)用initdb_command方法。那么這個(gè)方法又做了什么呢？很明顯，它調(diào)用了init_db方法，并輸出初始化成功的提示語句。

def get_db():   
    if not hasattr(g, 'sqlite_db'):        
        g.sqlite_db = connect_db()    
    return g.sqlite_db

get_db方法主要的作用是獲得數(shù)據(jù)庫的操作句柄。當(dāng)在全局變量g里沒有搜索到數(shù)據(jù)庫句柄時(shí)，創(chuàng)建一個(gè)數(shù)據(jù)庫連接，并把它的操作句柄付給g。

@app.teardown_appcontext
def close_db(error):    
    if hasattr(g, 'sqlite_db'):        
        g.sqlite_db.close()

close_db在全局變量g中搜索數(shù)據(jù)庫句柄，如果有的話，關(guān)閉連接。需要注意的是，這個(gè)方法綁定到了tear_appcontext裝飾器上，也就是說在app關(guān)閉的時(shí)候自動(dòng)調(diào)用這個(gè)方法，這是一種相對安全的方法，防止忘記關(guān)閉數(shù)據(jù)庫連接造成的潛在風(fēng)險(xiǎn)。

正文部分

接下來，來到了route-handler的正文部分

#主頁部分
@app.route('/')
def show_entries():    
    db = get_db()    
    cur = db.execute('select title, text from entries order by id desc')    
    entries = cur.fetchall()    
    return render_template('show_entries.html',entries=entries)

#add頁面
@app.route('/add', methods=['POST'])
def add_entry():    
    if not session.get('logged_in'):        
        abort(401)    
    db = get_db()    
    db.execute('insert into entries (title, text) values (?, ?)',[request.form['title'], request.form['text']])             
    db.commit()    
    flash('New entry was successfully posted')    
    return redirect(url_for('show_entries'))

#登陸頁面
@app.route('/login', methods=['GET', 'POST'])
def login():    
    error = None    
    if request.method == 'POST':        
        if request.form['username'] != app.config['USERNAME']:            
            error = 'Invalid username'        
        elif request.form['password'] != app.config['PASSWORD']:            
            error = 'Invalid password'        
        else:            
            session['logged_in'] = True            
            flash('You were logged in')            
            return redirect(url_for('show_entries'))    
    return render_template('login.html', error=error)

#登出頁面
@app.route('/logout')
def logout():    
    session.pop('logged_in', None)    
    flash('You were logged out')    
    return redirect(url_for('show_entries'))

讓我們從主頁開始看，主頁主要的功能就是執(zhí)行查詢操作，從數(shù)據(jù)庫中獲取所有的title和text，并且按照id降序排列（即按插入的逆序排列），將獲取的數(shù)據(jù)作為參數(shù)返回給templates中的show_entries.html文件進(jìn)行渲染展示。

add頁面提供了添加操作的接口,，需要注意的是，由于我們需要在添加之前對執(zhí)行該操作的用戶進(jìn)行登陸校驗(yàn)，如果沒有登陸，則直接返回給一個(gè)401錯(cuò)誤碼，如果用戶已經(jīng)合法登陸，則將請求表單中的title,text字段插入數(shù)據(jù)庫，顯示成功插入的提示信息，并且將頁面重定向到展示頁面，讓用戶看到添加過新數(shù)據(jù)之后的新的數(shù)據(jù)展示頁面。

登陸頁面主要實(shí)現(xiàn)的功能就是對比請求表單中的name,password是否和數(shù)據(jù)庫當(dāng)中存儲的用戶信息匹配，如果兩項(xiàng)都匹配，則允許其登陸，否則根據(jù)情況拋出錯(cuò)誤提示信息。

登出頁面主要的作用是將該用戶的用戶信息從session中移除，并重定向到數(shù)據(jù)展示頁面。

從以上信息我們不難發(fā)現(xiàn)，flaskr對于權(quán)限操作的控制：未登錄用戶僅有閱讀已有數(shù)據(jù)的權(quán)限(即r權(quán)限)，而只有登錄過的用戶才有讀和寫的權(quán)限(即rw權(quán)限)。

可能有人已經(jīng)注意到了，上面各個(gè)路由裝飾器的部分，除了都有路由路徑之外，有的傳了methods參數(shù)而有的沒有，其實(shí)methods的默認(rèn)值是'GET'。常用的還有'POST'，'DELETE'，'PUT'。
POST和GET的區(qū)別

總結(jié)

我認(rèn)為這個(gè)demo主要涉及到的要點(diǎn)有以下幾個(gè)：

• 路由的實(shí)現(xiàn)
• 模板對于參數(shù)的處理
• 數(shù)據(jù)庫的鏈接，初始化及插入、查詢操作
• 配置項(xiàng)的配置及從環(huán)境變量中引入配置項(xiàng)