怎么在flask中實現一個token機制

這篇文章給大家介紹怎么在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中實現一個token機制就分享到這里了，希望以上內容可以對大家有一定的幫助，可以學到更多知識。如果覺得文章不錯，可以把它分享出去讓更多的人看到。