繼續flask的學習之旅。今天介紹flask的登陸管理模組,還記得上一篇的blog小項目麼,登入是咱們自己寫的驗證程式碼,大概有以下幾個步驟:
1、在登入框中輸入使用者名稱和密碼
2、flask view函數取得使用者密碼,然後到資料庫中查詢該使用者信息,進行比對
3、如果成功,就寫入session中,重定向到首頁
4、如果對於特定視圖,必須登入才能訪問,那麼需要在每個視圖函數驗證session裡是否存在該使用者。
今天繼續改造blog項目,介紹的flask-login模組就是替我們來搞定這些業務相關度較少的公用功能,它可以幫助我們:
在會話中儲存目前活躍的使用者 ID,讓你能夠自由地登入和登出。
讓你限制登入(或登出)使用者可以存取的視圖。
處理讓人棘手的 “記住我” 功能。
幫助你保護使用者會話免遭 cookie 被盜的牽連。
可以與以後可能使用的 Flask-Principal 或其它認證擴充整合。
一、如何使用flask-login模組?
1、安裝flask-login
E:workdirdct-server-5055187src>pip install flask-login
2、使用flask-login
2.1) 在/blog2/__init__.py新增:
#引用包 from flask.ext.login import LoginManager #登陆管理 #声明login对象 login_manager = LoginManager() #初始化绑定到应用 login_manager.init_app(app) #声明默认视图函数为login,当我们进行@require_login时,如果没登陆会自动跳到该视图函数处理 login_manager.login_view = "login" #当登陆成功后,该函数会自动从会话中存储的用户 ID 重新加载用户对象。它应该接受一个用户的 unicode ID 作为参数,并且返回相应的用户对象。 @login_manager.user_loader def load_user(userid): return User.query.get(int(userid))
2.2) 修改User模型(紅色部分為新增程式碼)
from flask.ext.login import UserMixin from blog2 import db class 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
該用戶類別必須實作以下幾個方法:
is_authenticated
當使用者通過驗證時,也即提供有效證明時回傳 True(只有經過驗證的使用者會滿足 login_required 的條件。)
is_active
如果這是一個活動用戶且通過驗證,帳戶也已激活,未被停用,也不符合任何你 的應用拒絕一個帳號的條件,返回 True 。不活動的帳號可能不會登入(當然, 是在沒被強制的情況下)。
is_anonymous
如果是一個匿名用戶,返回 True 。 (真實使用者應返回 False 。)
get_id()
回傳一個能唯一識別使用者的,並能用於從 user_loader 回呼中載入使用者的 unicode 。注意著 必須 是一個 unicode —— 如果 ID 原本是 一個 int 或其它類型,你需要把它轉換為 unicode 。
要簡單地實作使用者類,你可以從 UserMixin 繼承,它提供了所有這些方法的預設實作。我們這裡使用UserMixin實作。
2.3) 修改view函數(紅色部分為新增)
from flask.ext.login import login_required, login_user, logout_user from blog2.model.User import User from blog2.model.Category import Category import os from blog2 import app,db from flask import request,render_template,flash,abort,url_for,redirect,session,Flask,g @app.route('/') @login_required def show_entries(): categorys = Category.query.all() return render_template('show_entries.html',entries=categorys) @app.route('/add',methods=['POST']) @login_required def 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_required def 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中login_manager.login_view = "login"控制
login_user(user):傳入一個user物件進行登陸驗證,正確回傳true,否則回傳false
logout_user():登出函數,清空session中使用者資訊
2.4) 範本中引用使用者
{% if current_user.is_authenticated() %} Hi {{ current_user.name }}! {% endif %}
將先前layout.html和show_entries.html範本中判斷使用者是否登陸方式改為flask-login中的方式:
{% if not current_user.is_authenticated() %}
current_user值:使用者沒有登陸時,值為
使用者登陸後,且值為
當然,用戶登陸還可以根據實際情況自己定制,具體不在一一詳述。
【參考文件】
Flask-Login中文版:http://www.pythondoc.com/flask-login/#id1
Flask-Login英文版:http://flask-login.readthedocs.io/en/latest/