【flask】请求钩子、上下文、综合认证

谁践踏了优雅 2022-11-21 09:59 200阅读 0赞

#### 1.请求钩子 ####

请求钩子就是就是在客户端发起请求的时候，对各个阶段进行监听和处理，这可以完成一些统一的处理，减少代码冗余。类似于中间件或前后置

主要有以下四种请求钩子

**before\_first\_request**

*  web应用被第一次请求前调用
 *  可以进行web应用初始化处理

**before\_request**

*  每次执行视图函数之前调用，可以对请求进行一些准备处理
 *  如果在该函数中返回了一个响应，视图函数将不再被调用

**after\_request**

*  如果没有抛出错误，每次执行视图函数之后(已经包装为响应对象)调用
 *  接受一个参数：包装好的响应对象，且需要将修改后的响应对象返回

**teardown\_request：**

*  每次执行视图函数之后调用，无论是否出现异常都会执行, 一般用于请求收尾
 *  接受一个参数：错误信息，如果有相关错误抛出

钩子举例

from flask import Flask
    
    app = Flask(__name__)
    
    @app.route("/")
    def index():
        print("index")
        # a=1/0 为了测试，故意制造错误
        return "index"
    
    @app.route("/login")
    def login():
        print("login")
        return "login"
    
    # 第一次请求前会被执行
    @app.before_first_request
    def initial():
        # 一般用于做初始化的工作，不要写return
        print("before_first_request")
    
    # 每次请求前都会调用
    @app.before_request
    def process_request():
        # 用于权限认证等前置操作，不要写return
        print("before_request")
    
    # 每次响应之前都会调用
    @app.after_request
    def process_response(response):  # 参数是响应对象
        print("after_request")
        return response
    
    # 每次响应之前都会调用
    @app.teardown_request
    def request_handle(error):  # 参数是异常信息
        if error:
            print("error: ", error)
        print("teardown_request")
    
    if __name__ == '__main__':
        app.run()

#### 2.上下文 ####

**上下文**：就是一个数据容器，将Flask运行过程中的一些信息保存起来  
**使用范围**：从请求开始到请求结束，在范围之外使用会报错  
**分类**：请求上下文、应用上下文

##### 2.1 请求上下文 #####

请求上下文记录一些跟请求有关的数据，包括request和session

##### 2.2 应用上下文 #####

应用上下文记录一些跟应用有关的数据，包括current\_app和g

**current\_app** ：指向当前Flask对象，在项目的其他文件中使用app时应该通过使用current\_app获取，减少循环导入的问题

**g** ：flask给开发者预留的一个容器，用于记录自定义数据，比如说钩子函数与视图函数之间传值、函数嵌套传值等。但是要注意，g变量在每次请求会重置数据

from flask import Flask, request, session, current_app, g
    
    app = Flask(__name__)
    app.secret_key = "afjpoajpg"
    app.config["JSON_AS_ASCII"] = False
    
    @app.before_request
    def process_request():
        username = "pan"
        g.username = username  # 使用g变量容器传递数据
    
    @app.route("/")
    def index():
        # =====请求上下文=====
        print(request.remote_addr)
        session["user"] = "pan"
        print(session.get("user"))
    
        # =====应用上下文=====
        print(app.config["JSON_AS_ASCII"])
        print(current_app.config["JSON_AS_ASCII"])
        print(g.username)  # 通过g获取钩子函数的变量
        return "index"
    
    if __name__ == '__main__':
        app.run()

#### 3.综合认证 ####

访问限制举例，如果用户还没登录，不能访问评论页面

from flask import Flask, session, g, abort
    import functools
    
    app = Flask(__name__)
    app.secret_key = "asfjpsfasfjoa"
    
    @app.before_request
    def process_user():
        user_name = session.get("user_name")
        user_id = session.get("user_id")
        g.user_id = user_id
        g.user_name = user_name
    
    @app.route("/")
    def index():
        print(g.user_name)
        print(g.user_id)
        if g.user_name and g.user_id:
            return f"您好，{g.user_name}"
        else:
            return "<a href='/login'>登录</a>"
    
    @app.route("/login")
    def login():
        session["user_name"] = "pan"
        session["user_id"] = 15
        return "login success"
    
    def login_required(view_func):
        @functools.wraps(view_func)
        def wrapper(*args, **kwargs):
            if g.user_name and g.user_id:
                return view_func(*args, **kwargs)
            else:
                abort(401)
        return wrapper
    
    @app.route("/logout")
    def logout():
        session.clear()
        return "退出登录成功"
    
    @app.route("/comment")
    @login_required
    def comment():
        return "评论"
    
    if __name__ == '__main__':
        app.run(debug=True)