1. 程式人生 > 程式設計 >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,data=data)

以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支援我們。