Flask框架中的四种请求勾子

喜欢ヅ旅行 2022-10-08 00:50 120阅读 0赞

# Flask框架中的四种请求勾子 #

### 文章目录 ###

*  Flask框架中的四种请求勾子
 *   *  四种勾子详解
     *  场景应用

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

比如：

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

## 四种勾子详解 ##

> 为了让每个视图函数避免编写重复功能的代码，Flask提供了通用设施的功能，即请求钩子。

请求钩子是通过\*\*\*装饰器\*\*\* 的形式实现，Flask支持如下四种请求钩子：

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

代码测试

from flask import Flask
    
    app = Flask(__name__)
    
    # 在第一次请求之前调用，可以在此方法内部做一些初始化操作
    @app.before_first_request 
    def before_first_request(): 
    	print("before_first_request")
    
    # 在每一次请求之前调用，这时候已经有请求了，可能在这个方法里面做请求的校验
    # 如果请求的校验不成功，可以直接在此方法中进行响应，直接return之后那么就不会执行视图函数
    @app.before_request 
    def before_request():
    	print("before_request")
    	if 1: # 条件
    		return "before_request装饰器勾子函数有返回，不会执行真正要访问的视图函数。"
    
    # 在执行完视图函数之后会调用，并且会把视图函数所生成的响应传入,可以在此方法中对响应做最后一步统一的处理
    @app.after_request 
    def after_request(response):
    	print("after_request")
    	response.headers["Content-Type"] = "application/json"
    	return response
    
    # 请每一次请求之后都会调用，会接受一个参数，参数是服务器出现的错误信息
    @app.teardown_request 
    def teardown_request(e):
      print("teardown_request")
      
    @app.route('/') 
    def index():
      print('index')
      return 'index'
    
    if __name__ == '__main__': 
    	app.run(debug=True)

> 输出结果：页面显示“before\_request装饰器勾子函数有返回，不会执行真正要访问的视图函数。”

before\_first\_request  
before\_request  
after\_request  
teardown\_request None

> before\_request的if改成0，页面显示“index”

before\_first\_request  
before\_request  
index  
after\_request  
teardown\_request None

## 场景应用 ##

before\_first\_request：处理第一次请求之前执行。例如以下代码：

@app.before_first_request
      def first_request():
          print 'first time request'

before\_request：在每次请求之前执行。通常可以用这个装饰器来给视图函数增加一些变量。例如以下代码：

from flask import Flask, g
    @app.before_request
      def before_request():
          if not hasattr(g,'user'):
              setattr(g,'user','xxxx')

teardown\_appcontext：不管是否有异常，注册的函数都会在每次请求之后执行。

@app.teardown_appcontext
      def teardown(exc=None):
          if exc is None:
              db.session.commit()
          else:
              db.session.rollback()
          db.session.remove()

template\_filter：在使用`Jinja2`模板的时候自定义过滤器。比如可以增加一个`upper`的过滤器（当然Jinja2已经存在这个过滤器，本示例只是为了演示作用）：

@app.template_filter
      def upper_filter(s):
          return s.upper()

context\_processor：上下文处理器。返回的字典中的键可以在模板上下文中使用。例如：

@app.context_processor
    
      return {
        'current_user':'xxx'}

errorhandler：errorhandler接收状态码，可以自定义返回这种状态码的响应的处理方法。例如：

@app.errorhandler(404)
      def page_not_found(error):
          return 'This page does not exist',404