Flask官方Example分析(一)--flaskr

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

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

Flaskr是什么

按照这个example给出的说明文档，这是一个 minimal blog application 数据库方面，采用了Python自带的微型数据库sqlite。需要额外说明的是，这并非一个完整的应用，而更像一个微型扩展模块或者说是模板。
接下来看一下他的文件结构(省略了部分无关紧要的文件部分)：

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应该是我们所要主要关注的部分。

开始分析

先来看import部分，简单捋清楚所涉及的点

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

我希望你对以上的部分至少应该是了解的，如果不是，就应该去官方文档了解一下相关的概念。

初始化

程序正式部分的第一行作用是初始化一个flask app:

app = Flask(__name__)

其中__name__变量应该是flaskr，因为flaskr是作为包导入使用的，如果是一个独立的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)

数据库部分

先来看数据库的连接和初始化部分：

#连接部分
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())

从配置项中引入数据库的链接，并创建一个数据库连接，并将这个数据库句柄作为返回值。
初始化部分从schema.sql文件中读取sql语句，并依此执行，记得最后将执行的操作结果提交操作（commit）。


def initdb_command(): 
    init_db()    
    print('Initialized the database.')

接下来利用flask内置的装饰器将命令行中的initdb与initdb_command方法绑定，也就是说在flaskr执行当中，命令行中的initdb将直接调用initdb_command方法。那么这个方法又做了什么呢？很明显，它调用了init_db方法，并输出初始化成功的提示语句。

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

get_db方法主要的作用是获得数据库的操作句柄。当在全局变量g里没有搜索到数据库句柄时，创建一个数据库连接，并把它的操作句柄付给g。

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

close_db在全局变量g中搜索数据库句柄，如果有的话，关闭连接。需要注意的是，这个方法绑定到了tear_appcontext装饰器上，也就是说在app关闭的时候自动调用这个方法，这是一种相对安全的方法，防止忘记关闭数据库连接造成的潜在风险。

正文部分

接下来，来到了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']])             
        
    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'))

让我们从主页开始看，主页主要的功能就是执行查询操作，从数据库中获取所有的title和text，并且按照id降序排列（即按插入的逆序排列），将获取的数据作为参数返回给templates中的show_entries.html文件进行渲染展示。

登陆页面主要实现的功能就是对比请求表单中的name,password是否和数据库当中存储的用户信息匹配，如果两项都匹配，则允许其登陆，否则根据情况抛出错误提示信息。

从以上信息我们不难发现，flaskr对于权限操作的控制：未登录用户仅有阅读已有数据的权限(即r权限)，而只有登录过的用户才有读和写的权限(即rw权限)。