flask 實現token機制

token 的生成

用token校驗身份，是先後端交互的經常使用方式。
它有如下特性：

• 會失效
• 加密
• 能夠根據它拿到用戶的信息

生成方式（ 內部配置的私鑰+有效期+用戶的id ）

#導入依賴包
from flask import request,jsonify,current_app
from itsdangerous import TimedJSONWebSignatureSerializer as Serializer

def create_token(api_user):
    ''' 生成token :param api_user:用戶id :return: token '''
    
    #第一個參數是內部的私鑰，這裏寫在共用的配置信息裏了，若是隻是測試能夠寫死
    #第二個參數是有效期(秒)
    s = Serializer(current_app.config["SECRET_KEY"],expires_in=3600)
    #接收用戶id轉換與編碼
    token = s.dumps({"id":api_user}).decode("ascii")
    return token
複製代碼

token的校驗

校驗接收到的token，若是成功返回用戶信息，不然返回None

#基於上面的基礎再導入用戶的模型類
from app.model import User

def verify_token(token):
    ''' 校驗token :param token: :return: 用戶信息 or None '''
    
    #參數爲私有祕鑰，跟上面方法的祕鑰保持一致
    s = Serializer(current_app.config["SECRET_KEY"])
    try:
        #轉換爲字典
        data = s.loads(token)
    except Exception:
        return None
    #拿到轉換後的數據，根據模型類去數據庫查詢用戶信息
    user = User.query.get(data["id"])
    return user
複製代碼

用裝飾器寫一個必須攜帶token的校驗

有不少接口是必須登陸才能操做的，最好的方式就是在寫一個裝飾器，添加在須要的api上

#在上面的基礎上導入
import functools

def login_required(view_func):
    @functools.wraps(view_func)
    def verify_token(*args,**kwargs):
        try:
            #在請求頭上拿到token
            token = request.headers["z-token"]
        except Exception:
            #沒接收的到token,給前端拋出錯誤
            #這裏的code推薦寫一個文件統一管理。這裏爲了看着直觀就先寫死了。
            return jsonify(code = 4103,msg = '缺乏參數token')
        
        s = Serializer(current_app.config["SECRET_KEY"])
        try:
            s.loads(token)
        except Exception:
            return jsonify(code = 4101,msg = "登陸已過時")

        return view_func(*args,**kwargs)

    return verify_token
複製代碼

使用案例

生成token(案例)

#此處的api是藍圖的對象
from . import api
from app.model import User,db
from flask import request,jsonify
#導入剛剛寫的文件方法
from app.utils.common import create_token,login_required,verify_token

@api.route("/login",methods=["POST"])
def login():
    ''' 用戶登陸 :return:token '''
    res_dir = request.get_json()
    if res_dir is None:
        #這裏的code，依然推薦用一個文件管理狀態
        return jsonify(code = 4103,msg = "未接收到參數")
    
    #獲取前端傳過來的參數
    phone = res_dir.get("phone")
    password = res_dir.get("password")
    
    #校驗參數
    if not all([phone,password]):
        return jsonify(code=4103, msg="請填寫手機號或密碼")

    if not re.match(r"1[23456789]\d{9}",phone):
        return jsonify(code=4103,msg="手機號有誤")

    try:
        user = User.query.filter_by(phone=phone).first()
    except Exception:
        return jsonify(code=4004,msg="獲取信息失敗")

    if user is None or not user.check_password(password):
        return jsonify(code=4103,msg="手機號或密碼錯誤")
    
    #獲取用戶id，傳入生成token的方法，並接收返回的token
    token = create_token(user.id)
    
    #把token返回給前端
    return jsonify(code=0,msg="成功",data=token)
複製代碼

必須登陸的校驗與根據token拿到用戶信息(案例)

@api.route("/user/detail")
@login_required #必須登陸的裝飾器校驗
def userInfo():
    ''' 用戶信息 :return:data '''
    token = request.headers["z-token"]
    #拿到token，去換取用戶信息
    user = verify_token(token)

    data = {
        "phone":user.phone,
        "name":user.name,
        "head_portrait":user.head_portrait,
        "intro":user.intro,
        "level":user.level
    }

    return jsonify(code=0,msg="成功",data=data)
複製代碼

相關flask文章

flask多圖片儲存優化