繼續(xù)flask的學(xué)習(xí)之旅。今天介紹flask的登陸管理模塊，還記得上一篇中的blog小項目么，登錄是咱們自己寫的驗證代碼，大概有以下幾個步驟：
1、在登錄框中輸入用戶名和密碼
2、flask view函數(shù)獲取用戶密碼，然后到數(shù)據(jù)庫中查詢該用戶信息，進(jìn)行匹配
3、如果成功，就寫入session中，重定向到首頁
4、如果對于特定視圖，必須要登錄才能訪問，那么需要在每個視圖函數(shù)驗證session里是否存在該用戶。
今天繼續(xù)改造blog項目，介紹的flask-login模塊就是替我們來搞定這些業(yè)務(wù)相關(guān)度較少的公用功能，它可以幫助我們：
在會話中存儲當(dāng)前活躍的用戶 ID，讓你能夠自由地登入和登出。
讓你限制登入(或者登出)用戶可以訪問的視圖。
處理讓人棘手的 “記住我” 功能。
幫助你保護(hù)用戶會話免遭 cookie 被盜的牽連。
可以與以后可能使用的 Flask-Principal 或其它認(rèn)證擴(kuò)展集成。
一、如何使用flask-login模塊？
1、安裝flask-login
E:\workdir\dct-server-5055187\src>pip install flask-login
2、使用flask-login
2.1) 在/blog2/__init__.py添加：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
#引用包from flask.ext.login import LoginManager#登陸管理#聲明login對象login_manager = LoginManager()#初始化綁定到應(yīng)用login_manager.init_app(app)#聲明默認(rèn)視圖函數(shù)為login，當(dāng)我們進(jìn)行@require_login時，如果沒登陸會自動跳到該視圖函數(shù)處理login_manager.login_view = "login"#當(dāng)?shù)顷懗晒螅摵瘮?shù)會自動從會話中存儲的用戶 ID 重新加載用戶對象。它應(yīng)該接受一個用戶的 unicode ID 作為參數(shù)，并且返回相應(yīng)的用戶對象。@login_manager.user_loaderdef load_user(userid):return User.query.get(int(userid)) |
2.2） 修改User模型（紅色部分為新增代碼）
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
from flask.ext.login import UserMixinfrom blog2 import dbclass User(db.Model, UserMixin): __tablename__ = 'b_user' id = db.Column(db.Integer,primary_key=True) username = db.Column(db.String(10),unique=True) password = db.Column(db.String(16)) def __init__(self,username,password): self.username = username self.password = password def __repr__(self): return '<User %r>' % self.username |
該用戶類必須實現(xiàn)以下幾個方法：
is_authenticated
當(dāng)用戶通過驗證時，也即提供有效證明時返回 True（只有通過驗證的用戶會滿足 login_required 的條件。）
is_active
如果這是一個活動用戶且通過驗證，賬戶也已激活，未被停用，也不符合任何你 的應(yīng)用拒絕一個賬號的條件，返回 True 。不活動的賬號可能不會登入（當(dāng)然， 是在沒被強(qiáng)制的情況下）。
is_anonymous
如果是一個匿名用戶，返回 True 。（真實用戶應(yīng)返回 False 。）
get_id()
返回一個能唯一識別用戶的，并能用于從 user_loader 回調(diào)中加載用戶的 unicode 。注意著 必須 是一個 unicode —— 如果 ID 原本是 一個 int 或其它類型，你需要把它轉(zhuǎn)換為 unicode 。
要簡便地實現(xiàn)用戶類，你可以從 UserMixin 繼承，它提供了對所有這些方法的默認(rèn)實現(xiàn)。我們這里使用UserMixin實現(xiàn)。
2.3） 修改view函數(shù)（紅色部分為新增）
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
|
from flask.ext.login import login_required, login_user, logout_userfrom blog2.model.User import Userfrom blog2.model.Category import Categoryimport osfrom blog2 import app,dbfrom flask import request,render_template,flash,abort,url_for,redirect,session,Flask,g@app.route('/')@login_requireddef show_entries(): categorys = Category.query.all() return render_template('show_entries.html',entries=categorys)@app.route('/add',methods=['POST'])@login_requireddef add_entry(): #—————————————————————————————————————————————— # 第一版登陸方式 # if not session.get('logged_in'): # abort(401) #—————————————————————————————————————————————— title = request.form['title'] content = request.form['text'] category = Category(title,content) db.session.add(category) db.session.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': user = User.query.filter_by(username=request.form['username']).first() #—————————————————————————————————————————————————————————————————————————— #第一版登陸方式 # passwd = User.query.filter_by(password=request.form['password']).first() # # if user is None: # error = 'Invalid username' # elif passwd is None: # error = 'Invalid password' # else: # session['logged_in'] = True # flash('You were logged in') # return redirect(url_for('show_entries')) #—————————————————————————————————————————————————————————————————————————— login_user(user) flash('Logged in successfully.') return redirect(url_for('show_entries')) return render_template('login.html', error=error)@app.route('/logout')@login_requireddef logout(): #—————————————————————————————————————————————— # 第一版登出方式 # session.pop('logged_in', None) #—————————————————————————————————————————————— logout_user() flash('You were logged out') return redirect(url_for('show_entries')) |
通過flask-login管理登陸，代碼非常簡潔簡單：
@login_required：該裝飾器放到需要登陸才能訪問的視圖上，如果沒有登陸訪問有限制的視圖就會跳到login頁面，由__init__.py中l(wèi)ogin_manager.login_view = "login"控制
login_user(user)：傳入一個user對象進(jìn)行登陸驗證，正確返回true，否則返回false
logout_user()：登出函數(shù)，清空session中用戶信息
2.4） 模板中引用用戶
|
1
2
3
|
{% if current_user.is_authenticated() %} Hi {{ current_user.name }}!{% endif %} |
將之前l(fā)ayout.html和show_entries.html模板中判斷用戶是否登陸方式改為flask-login中的方式：
{% if not current_user.is_authenticated() %}
current_user值：在用戶沒有登陸時，值為<flask_login.AnonymousUserMixin object at 0x0000000003DCF550>，也就是匿名用戶
用戶登陸后，值為<User u'admin'>
當(dāng)然，用戶登陸還可以根據(jù)實際情況自己定制，具體不在一一詳述。
【參考文檔】
Flask-Login中文版：http://www.pythondoc.com/flask-login/#id1
Flask-Login英文版：http://flask-login.readthedocs.io/en/latest/
