所有例子代碼均來自于Flask的 7fca843b5f 版本
為了學習flask框架叔收,我決定開始學習flask在GitHub上給出的官方example來熟悉flask的使用方法饮醇,在此版本中包含blueprintexample损拢,flaskr,jqueryexample,minitwit這四個例子窄锅,今天分析的是flaskr這個例子。
Flaskr是什么
按照這個example給出的說明文檔缰雇,這是一個 minimal blog application 數(shù)據(jù)庫方面入偷,采用了Python自帶的微型數(shù)據(jù)庫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)
這里的config項包括了database的路徑毯炮,開啟了調(diào)試模式,配置了秘鑰(一般這種在代碼里顯示配置秘鑰的方式被認為是不安全的耸黑,實際當中更常用的方式是將秘鑰放進服務器的一個環(huán)境變量中)桃煎,規(guī)定了用戶名和密碼,剩余部分的config就通過from_envvar函數(shù)從一個叫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()
從配置項中引入數(shù)據(jù)庫的鏈接备禀,并創(chuàng)建一個數(shù)據(jù)庫連接,并將這個數(shù)據(jù)庫句柄作為返回值奈揍。
初始化部分從schema.sql文件中讀取sql語句曲尸,并依此執(zhí)行,記得最后將執(zhí)行的操作結果提交操作(commit)男翰。
@app.cli.command('initdb')
def initdb_command():
init_db()
print('Initialized the database.')
接下來利用flask內(nèi)置的裝飾器將命令行中的initdb與initdb_command方法綁定另患,也就是說在flaskr執(zhí)行當中,命令行中的initdb將直接調(diào)用initdb_command方法蛾绎。那么這個方法又做了什么呢昆箕?很明顯鸦列,它調(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ù)庫的操作句柄薯嗤。當在全局變量g里沒有搜索到數(shù)據(jù)庫句柄時,創(chuàng)建一個數(shù)據(jù)庫連接纤泵,并把它的操作句柄付給g骆姐。
@app.teardown_appcontext
def close_db(error):
if hasattr(g, 'sqlite_db'):
g.sqlite_db.close()
close_db在全局變量g中搜索數(shù)據(jù)庫句柄,如果有的話捏题,關閉連接玻褪。需要注意的是,這個方法綁定到了tear_appcontext裝飾器上公荧,也就是說在app關閉的時候自動調(diào)用這個方法带射,這是一種相對安全的方法,防止忘記關閉數(shù)據(jù)庫連接造成的潛在風險循狰。
正文部分
接下來窟社,來到了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文件進行渲染展示昧识。
add頁面提供了添加操作的接口,,需要注意的是盗扒,由于我們需要在添加之前對執(zhí)行該操作的用戶進行登陸校驗跪楞,如果沒有登陸,則直接返回給一個401錯誤碼侣灶,如果用戶已經(jīng)合法登陸甸祭,則將請求表單中的title,text字段插入數(shù)據(jù)庫,顯示成功插入的提示信息褥影,并且將頁面重定向到展示頁面池户,讓用戶看到添加過新數(shù)據(jù)之后的新的數(shù)據(jù)展示頁面。
登陸頁面主要實現(xiàn)的功能就是對比請求表單中的name,password是否和數(shù)據(jù)庫當中存儲的用戶信息匹配凡怎,如果兩項都匹配校焦,則允許其登陸,否則根據(jù)情況拋出錯誤提示信息统倒。
登出頁面主要的作用是將該用戶的用戶信息從session中移除寨典,并重定向到數(shù)據(jù)展示頁面。
從以上信息我們不難發(fā)現(xiàn)房匆,flaskr對于權限操作的控制:未登錄用戶僅有閱讀已有數(shù)據(jù)的權限(即r權限)耸成,而只有登錄過的用戶才有讀和寫的權限(即rw權限)报亩。
可能有人已經(jīng)注意到了,上面各個路由裝飾器的部分井氢,除了都有路由路徑之外弦追,有的傳了methods參數(shù)而有的沒有,其實methods的默認值是'GET'花竞。常用的還有'POST'骗卜,'DELETE','PUT'左胞。
POST和GET的區(qū)別
總結
我認為這個demo主要涉及到的要點有以下幾個:
- 路由的實現(xiàn)
- 模板對于參數(shù)的處理
- 數(shù)據(jù)庫的鏈接寇仓,初始化及插入、查詢操作
- 配置項的配置及從環(huán)境變量中引入配置項