Flask 学习-29.flask_jwt_extended插件jwt_required()中可选项optional=True参数

Posted 2022-09-05 上海-悠悠

前言

在某些情况下，无论请求中是否存在 JWT，您都希望使用相同的路由。在这些情况下，您可以使用 jwt_required() 中optional=True参数。这将允许访问端点，无论是否随请求一起发送 JWT。
如果不存在 JWT，get_jwt()和 get_jwt_header() 将返回一个空字典。 get_jwt_identity(), current_user, 和get_current_user()将返回None。

optional=True参数

如果请求中包含过期或无法验证的 JWT，仍会像往常一样返回错误。
官方文档示例

from flask import Flask
from flask import jsonify
from flask import request

from flask_jwt_extended import create_access_token
from flask_jwt_extended import get_jwt_identity
from flask_jwt_extended import jwt_required
from flask_jwt_extended import JWTManager

app = Flask(__name__)

# Setup the Flask-JWT-Extended extension
app.config["JWT_SECRET_KEY"] = "super-secret"  # Change this!
jwt = JWTManager(app)


@app.route("/login", methods=["POST"])
def login():
    username = request.json.get("username", None)
    password = request.json.get("password", None)
    if username != "test" or password != "test":
        return jsonify("msg": "Bad username or password"), 401

    access_token = create_access_token(identity=username)
    return jsonify(access_token=access_token)


@app.route("/optionally_protected", methods=["GET"])
@jwt_required(optional=True)
def optionally_protected():
    current_identity = get_jwt_identity()
    if current_identity:
        return jsonify(logged_in_as=current_identity)
    else:
        return jsonify(logged_in_as="anonymous user")


if __name__ == "__main__":
    app.run()

@jwt_required() 如果不带参数，用户没带有效token，会返回401
@jwt_required(optional=True) 带上optional=True，不管用户有没登录都可以访问该地址，再根据token解析的内容判断用户访问不同地址