请求钩子

在客户端和服务器交互的过程中,有些准备工作或扫尾工作需要处理,比如:

  • 在请求开始时,建立数据库连接;
  • 在请求开始时,根据需求进行权限校验;
  • 在请求结束时,指定数据的交互格式;

为了让每个视图函数避免编写重复功能的代码,Flask提供了通用设施的功能,即请求钩子。
请求钩子是通过装饰器的形式实现,Flask支持如下四种请求钩子:

  • before_first_request
    • 在处理第一个请求前执行
  • before_request
    • 在每次请求前执行
    • 如果在某修饰的函数中返回了一个响应,视图函数将不再被调用
  • after_request
    • 如果没有抛出错误,在每次请求后执行
    • 接受一个参数:视图函数作出的响应
    • 在此函数中可以对响应值在返回之前做最后一步修改处理
    • 需要将参数中的响应在此参数中进行返回
  • teardown_request:

    • 在每次请求后执行
    • 接受一个参数:错误信息,如果有相关错误抛出

      代码测试

      1. from flask import Flask
      2. from flask import abort
      3. app = Flask(__name__)
      4. # 在第一次请求之前调用,可以在此方法内部做一些初始化操作
      5. @app.before_first_request
      6. def before_first_request():
      7. print("before_first_request")
      8. # 在每一次请求之前调用,这时候已经有请求了,可能在这个方法里面做请求的校验
      9. # 如果请求的校验不成功,可以直接在此方法中进行响应,直接return之后那么就不会执行视图函数
      10. @app.before_request
      11. def before_request():
      12. print("before_request")
      13. # if 请求不符合条件:
      14. # return "laowang"
      15. # 在执行完视图函数之后会调用,并且会把视图函数所生成的响应传入,可以在此方法中对响应做最后一步统一的处理
      16. @app.after_request
      17. def after_request(response):
      18. print("after_request")
      19. response.headers["Content-Type"] = "application/json"
      20. return response
      21. # 请每一次请求之后都会调用,会接受一个参数,参数是服务器出现的错误信息
      22. @app.teardown_request
      23. def teardown_request(response):
      24. print("teardown_request")
      25. @app.route('/')
      26. def index():
      27. return 'index'
      28. if __name__ == '__main__':
      29. app.run(debug=True)
  • 在第1次请求时的打印:

    1. before_first_request
    2. before_request
    3. after_request
    4. teardown_request
  • 在第2次请求时的打印:

    1. before_request
    2. after_request
    3. teardown_request