Python的Flask框架中實(shí)現(xiàn)簡(jiǎn)單的登錄功能的教程,登錄是各個(gè)web框架中的基礎(chǔ)功能,需要的朋友可以參考下
回顧
在前面的系列章節(jié)中，我們創(chuàng)建了一個(gè)數(shù)據(jù)庫(kù)并且學(xué)著用用戶和郵件來(lái)填充，但是到現(xiàn)在我們還沒(méi)能夠植入到我們的程序中。 兩章之前，我們已經(jīng)看到怎么去創(chuàng)建網(wǎng)絡(luò)表單并且留下了一個(gè)實(shí)現(xiàn)完全的登陸表單。
在這篇文章中，我們將基于我門所學(xué)的網(wǎng)絡(luò)表單和數(shù)據(jù)庫(kù)來(lái)構(gòu)建并實(shí)現(xiàn)我們自己的用戶登錄系統(tǒng)。教程的最后我們小程序會(huì)實(shí)現(xiàn)新用戶注冊(cè)，登陸和退出的功能。
為了能跟上這章節(jié)，你需要前一章節(jié)最后部分，我們留下的微博程序。請(qǐng)確保你的程序已經(jīng)正確安裝和運(yùn)行。
在前面的章節(jié)，我們開(kāi)始配置我們將要用到的Flask擴(kuò)展。為了登錄系統(tǒng),我們將使用兩個(gè)擴(kuò)展,Flask-Login 和 Flask-OpenID. 配置如下所示 (fileapp__init__.py):
import os
from flaskext.login import LoginManager
from flaskext.openid import OpenID
from config import basedir
lm = LoginManager()
lm.setup_app(app)
oid = OpenID(app, os.path.join(basedir, 'tmp'))
Flask-OpenID 擴(kuò)展為了可以存儲(chǔ)臨時(shí)文件，需要一個(gè)臨時(shí)文件夾路徑。為此,我們提供了它的位置。
重訪我們的用戶模型
Flask-Login擴(kuò)展需要在我們的User類里實(shí)現(xiàn)一些方法。除了這些方法以外，類沒(méi)有被要求實(shí)現(xiàn)其它方法。
下面是我們的User類 (fileapp/models.py):
class User(db.Model):
id = db.Column(db.Integer, primary_key = True)
nickname = db.Column(db.String(64), unique = True)
email = db.Column(db.String(120), unique = True)
role = db.Column(db.SmallInteger, default = ROLE_USER)
= db.relationship('Post', backref = 'author', lazy = 'dynamic')
def is_authenticated(self):
return True
def is_active(self):
return True
def is_anonymous(self):
return False
def get_id(self):
return unicode(self.id)
def __repr__(self):
return '<User %r>' % (self.name)
is_authenticated方法是一個(gè)誤導(dǎo)性的名字的方法，通常這個(gè)方法應(yīng)該返回True，除非對(duì)象代表一個(gè)由于某種原因沒(méi)有被認(rèn)證的用戶。
is_active方法應(yīng)該為用戶返回True除非用戶不是激活的，例如，他們已經(jīng)被禁了。
is_anonymous方法應(yīng)該為那些不被獲準(zhǔn)登錄的用戶返回True。
最后，get_id方法為用戶返回唯一的unicode標(biāo)識(shí)符。我們用數(shù)據(jù)庫(kù)層生成唯一的id。
用戶加載回調(diào)
現(xiàn)在我們通過(guò)使用Flask-Login和Flask-OpenID擴(kuò)展來(lái)實(shí)現(xiàn)登錄系統(tǒng)
首先，我們需要寫一個(gè)方法從數(shù)據(jù)庫(kù)加載到一個(gè)用戶。這個(gè)方法會(huì)被Flask-Login使用(fileapp/views.py)：
@lm.user_loader
def load_user(id):
return User.query.get(int(id))
記住Flask-Login里的user id一直是unicode類型的，所以在我們把id傳遞給Flask-SQLAlchemy時(shí)，有必要把它轉(zhuǎn)化成integer類型。
登錄視圖函數(shù)
接下來(lái)我們要更新登錄視圖函數(shù)(fileapp/views.py)：
from flask import render_template, flash, redirect, session, url_for, request, g
from flaskext.login import login_user, logout_user, current_user, login_required
from app import app, db, lm, oid
from forms import LoginForm
from models import User, ROLE_USER, ROLE_ADMIN
@app.route('/login', methods = ['GET', 'POST'])
@oid.loginhandler
def login():
if g.user is not None and g.user.is_authenticated():
return redirect(url_for('index'))
form = LoginForm()
if form.validate_on_submit():
session['remember_me'] = form.remember_me.data
return oid.try_login(form.openid.data, ask_for = ['nickname', 'email'])
return render_template('login.html',
title = 'Sign In',
form = form,
providers = app.config['OPENID_PROVIDERS'])
注意到我們導(dǎo)入了一些新的模塊，其中有些后面會(huì)用到。
跟上個(gè)版本的變化很小。我們給視圖函數(shù)添加了一個(gè)新的裝飾器：oid.loginhandler。它告訴Flask-OpenID這是我們的登錄視圖函數(shù)。
在方法體的開(kāi)頭，我們檢測(cè)是是否用戶是已經(jīng)經(jīng)過(guò)登錄認(rèn)證的，如果是就重定向到index頁(yè)面。這兒的思路是如果一個(gè)用戶已經(jīng)登錄了，那么我們不會(huì)讓它做二次登錄。
全局變量g是Flask設(shè)置的，在一個(gè)request生命周期中，用來(lái)存儲(chǔ)和共享數(shù)據(jù)的變量。所以我猜你已經(jīng)想到了，我們將把已經(jīng)登錄的用戶放到g變量里。
我們?cè)谡{(diào)用redirect()時(shí)使用的url_for()方法是Flask定義的從給定的view方法獲取url。如果你想重定向到index頁(yè)面，你h很可能使用redirect('/index')，但是我們有很好的理由讓Flask為你構(gòu)造url。
當(dāng)我們從登錄表單得到返回?cái)?shù)據(jù)，接下來(lái)要運(yùn)行的代碼也是新寫的。這兒我們做兩件事。首先我們保存remember_me的布爾值到Flask的session中，別和Flask-SQLAlchemy的db.session混淆了。我們已經(jīng)知道在一個(gè)request的生命周期中用Flask的g對(duì)象來(lái)保存和共享數(shù)據(jù)。沿著這條線路Flask的session提供了更多，更復(fù)雜的服務(wù)。一旦數(shù)據(jù)被保存到session中，它將在同一客戶端發(fā)起的這次請(qǐng)求和這次以后的請(qǐng)求中永存而不會(huì)消亡。數(shù)據(jù)將保持在session中直到被明確的移除。為了做到這些，F(xiàn)lask為每個(gè)客戶端建立各自的session。
下面的oid.try_login是通過(guò)Flask-OpenID來(lái)執(zhí)行用戶認(rèn)證。這個(gè)方法有兩個(gè)參數(shù)，web表單提供的openid和OpenID provider提供的我們想要的list數(shù)據(jù)項(xiàng)。由于我們定義了包含nickname和email的User類，所以我們要從找nickname和email這些項(xiàng)。
基于OpenID的認(rèn)證是異步的。如果認(rèn)證成功，F(xiàn)lask-OpenID將調(diào)用有由oid.after_login裝飾器注冊(cè)的方法。如果認(rèn)證失敗那么用戶會(huì)被重定向到login頁(yè)面。
Flask-OpenID登錄回調(diào)
這是我們實(shí)現(xiàn)的after_login方法(app/views.py)
@oid.after_login
def after_login(resp):
if resp.email is None or resp.email == "":
flash('Invalid login. Please try again.')
redirect(url_for('login'))
user = User.query.filter_by(email = resp.email).first()
if user is None:
nickname = resp.nickname
if nickname is None or nickname == "":
nickname = resp.email.split(]
user = User(nickname = nickname, email = resp.email, role = ROLE_USER)
db.session.add(user)
db.session.commit()
remember_me = False
if 'remember_me' in session:
remember_me = session['remember_me']
session.pop('remember_me', None)
login_user(user, remember = remember_me)
return redirect(request.args.get('next') or url_for('index'))
傳給after_login方法的resp參數(shù)包含了OpenID provider返回的一些信息。
第一個(gè)if聲明僅僅是為了驗(yàn)證。我們要求一個(gè)有效的email，所以一個(gè)沒(méi)有沒(méi)提供的email我們是沒(méi)法讓他登錄的。
接下來(lái)，我們將根據(jù)email查找數(shù)據(jù)庫(kù)。如果email沒(méi)有被找到我們就認(rèn)為這是一個(gè)新的用戶，所以我們將在數(shù)據(jù)庫(kù)中增加一個(gè)新用戶，做法就像我們從之前章節(jié)學(xué)到的一樣。注意我們沒(méi)有處理nickname，因?yàn)橐恍㎡penID provider并沒(méi)有包含這個(gè)信息。
做完這些我們將從Flask session中獲取remember_me的值，如果它存在，那它是我們之前在login view方法中保存到session中的boolean類型的值。
然后我們調(diào)用Flask-Login的login_user方法，來(lái)注冊(cè)這個(gè)有效的登錄。
最后，在最后一行我們重定向到下一個(gè)頁(yè)面，或者如果在request請(qǐng)求中沒(méi)有提供下個(gè)頁(yè)面時(shí)，我們將重定向到index頁(yè)面。
跳轉(zhuǎn)到下一頁(yè)的這個(gè)概念很簡(jiǎn)單。比方說(shuō)我們需要你登錄才能導(dǎo)航到一個(gè)頁(yè)面，但你現(xiàn)在并未登錄。在Flask-Login中你可以通過(guò)login_required裝飾器來(lái)限定未登錄用戶。如果一個(gè)用戶想連接到一個(gè)限定的url，那么他將被自動(dòng)的重定向到login頁(yè)面。Flask-Login將保存最初的url作為下一個(gè)頁(yè)面，一旦登錄完成我們便跳轉(zhuǎn)到這個(gè)頁(yè)面。
做這個(gè)工作Flask-Login需要知道用戶當(dāng)前在那個(gè)頁(yè)面。我們可以在app的初始化組件里配置它(app/__init__.py)：
lm = LoginManager()
lm.setup_app(app)
lm.login_view = 'login'
全局變量g.user
如果你注意力很集中，那么你應(yīng)該記得在login view方法中我們通過(guò)檢查g.user來(lái)判斷一個(gè)用戶是否登錄了。為了實(shí)現(xiàn)這個(gè)我們將使用Flask提供的before_request事件。任何一個(gè)被before_request裝飾器裝飾的方法將會(huì)在每次request請(qǐng)求被收到時(shí)提前與view方法執(zhí)行。所以在這兒來(lái)設(shè)置我們的g.user變量(app/views.py)：
@app.before_request
def before_request():
g.user = current_user
這就是它要做的一切，current_user全局變量是被Flask-Login設(shè)定的，所以我們只需要把它拷貝到更容易被訪問(wèn)的g變量就OK了。這樣，所有的請(qǐng)求都能訪問(wèn)這個(gè)登錄的用戶，甚至于內(nèi)部的模板。
index視圖
在之前的章節(jié)中我們用假代碼遺留了我們的index視圖，因?yàn)槟莻€(gè)時(shí)候我們系統(tǒng)里并沒(méi)有用戶和博客文章。現(xiàn)在我們有用戶了，所以，讓我們來(lái)完成它吧：
@app.route('/')
@app.route('/index')
@login_required
def index():
user = g.user
= [
{
'author': { 'nickname': 'John' },
'body': 'Beautiful day in Portland!'
},
{
'author': { 'nickname': 'Susan' },
'body': 'The Avengers movie was so cool!'
}
]
return render_template('index.html',
title = 'Home',
user = user,
= )
在這個(gè)方法中只有兩處變動(dòng)。首先，我們?cè)黾恿薼ogin_required裝飾器。這樣表明了這個(gè)頁(yè)面只有登錄用戶才能訪問(wèn)。
另一個(gè)改動(dòng)是把g.user傳給了模板，替換了之間的假對(duì)象。
現(xiàn)在可以運(yùn)行我們的應(yīng)用了。
當(dāng)我們連接到你將會(huì)看到登陸頁(yè)面。記著如果你通過(guò)OpenID登錄那么你必須使用你的提供者提供的OpenID URL。你可以下面URL中的任何一個(gè)OpenID provider來(lái)為你產(chǎn)生一個(gè)正確的URL。
作為登錄進(jìn)程的一部分，你將會(huì)被重定向到OpenID提供商的網(wǎng)站，你將在那兒認(rèn)證和授權(quán)你共享給我們應(yīng)用的一些信息(我們只需要email和nickname，放心，不會(huì)有任何密碼或者其他個(gè)人信息被曝光)。
一旦登錄完成你將作為已登錄用戶被帶到index頁(yè)面。
試試勾選remember_me復(fù)選框。有了這個(gè)選項(xiàng)當(dāng)你在瀏覽器關(guān)閉應(yīng)用后重新打開(kāi)時(shí)，你還是已登錄狀態(tài)。
注銷登錄
我們已經(jīng)實(shí)現(xiàn)了登錄，現(xiàn)在是時(shí)候來(lái)實(shí)現(xiàn)注銷登錄了。
注銷登錄的方法灰常簡(jiǎn)單(file app/views.py)：
@app.route('/logout')
def logout():
logout_user()
return redirect(url_for('index'))
但我們?cè)谀０逯羞€沒(méi)有注銷登錄的鏈接。我們將在base.html中的頂部導(dǎo)航欄添加這個(gè)鏈接(file app/templates/base.html):
<html>
<head>
{% if title %}
<title>{{title}} - microblog</title>
{% else %}
<title>microblog</title>
{% endif %}
</head>
<body>
<div>Microblog:
<a href="{{ url_for('index') }}">Home</a>
{% if g.user.is_authenticated() %}
| <a href="{{ url_for('logout') }}">Logout</a>
{% endif %}
</div>
<hr>
{% with messages = get_flashed_messages() %}
{% if messages %}
<ul>
{% for message in messages %}
<li>{{ message }} </li>
{% endfor %}
</ul>
{% endif %}
{% endwith %}
{% block content %}{% endblock %}
</body>
</html>
這是多么多么簡(jiǎn)單啊，我們只需要檢查一下g.user中是否有一個(gè)有效的用戶，如果有我們就添加注銷鏈接。在我們的模板中我們?cè)僖淮问褂昧藆rl_for方法。