一.请求钩子
在客户端和服务器交互的过程中,有些准备工作或扫尾工作需要处理,比如:
在请求开始时,建立数据库连接;
在请求开始时,根据需求进行权限校验;
在请求结束时,指定数据的交互格式;
为了让每个视图函数避免编写重复功能的代码,Flask提供了通用设置的功能,即请求钩子。
请求钩子是通过装饰器的形式实现,Flask支持如下四种请求钩子:
before_first_request
在处理第一个请求前执行[项目初始化时的钩子]
before_request
在每次请求前执行
如果在某修饰的函数中返回了一个响应,视图函数将不再被调用
after_request
如果没有抛出错误,在每次请求后执行
接受一个参数:视图函数作出的响应
在此函数中可以对响应值在返回之前做最后一步修改处理
需要将参数中的响应在此参数中进行返回
teardown_request
在每次请求后执行
接受一个参数:错误信息,如果有相关错误抛出
需要设置flask的配置DEBUG=False,teardown_request才会接受到异常对象。
config.py
# 声明一个配置类 class Config(object): SECRET_KEY = "DD434O7HQ2131!@#edn#hu!@!g@uWO1NS"
main.py
from flask import Flask from config import Config app = Flask(__name__) # 项目配置 app.config.from_object(Config) @app.before_first_request def before_first_request(): print("----before_first_request----") print("系统初始化的时候,执行这个钩子方法") print("会在接收到第一个客户端请求时,执行这里的代码") @app.before_request def before_request(): print("----before_request----") print("每一次接收到客户端请求时,执行这个钩子方法") print("一般可以用来判断权限,或者转换路由参数或者预处理客户端请求的数据") @app.after_request def after_request(response): print(" ----after_request----") print("在处理请求以后,执行这个钩子方法") print("一般可以用于记录会员/管理员的操作历史,浏览历史,清理收尾的工作") response.headers["Content-Type"] = "application/json" # 必须返回response参数 return response @app.teardown_request def teardown_request(exc): """ 这个debug 模式为False 才能进行使用 :param exc: :return: """ print("----teardown_request----") print("在每一次请求以后,执行这个钩子方法,如果有异常错误,则会传递错误异常对象到当前方法的参数中") print(exc) # division by zero @app.route("/") def index(): print("----视图函数----") print("视图函数被运行了") # 1 / 0 # 错误的语法触发; teardown_request 而且: debug=False return "视图函数被运行了" if __name__ == '__main__': app.run(host="0.0.0.0", port=5000, debug=True)
第一次请求打印:
系统初始化的时候,执行这个钩子方法
GET / HTTP/1.1会在接收到第一个客户端请求时,执行这里的代码
" 200 -
----before_request----
每一次接收到客户端请求时,执行这个钩子方法
一般可以用来判断权限,或者转换路由参数或者预处理客户端请求的数据
----视图函数----
视图函数被运行了
----after_request----
在处理请求以后,执行这个钩子方法
一般可以用于记录会员/管理员的操作历史,浏览历史,清理收尾的工作
----teardown_request----
在每一次请求以后,执行这个钩子方法,如果有异常错误,则会传递错误异常对象到当前方法的参数中
None
第二次请求打印:
每一次接收到客户端请求时,执行这个钩子方法
一般可以用来判断权限,或者转换路由参数或者预处理客户端请求的数据
----视图函数----
视图函数被运行了
GET / HTTP/1.1----after_request----
在处理请求以后,执行这个钩子方法
" 200 -
一般可以用于记录会员/管理员的操作历史,浏览历史,清理收尾的工作
----teardown_request----
在每一次请求以后,执行这个钩子方法,如果有异常错误,则会传递错误异常对象到当前方法的参数中
None
如果使用debug = False ,将1 / 0 的注释打开出发语法错误访问打印,触发的teardown_request方法,会打印报错的内容如下:
----teardown_request----
在每一次请求以后,执行这个钩子方法,如果有异常错误,则会传递错误异常对象到当前方法的参数中
division by zero
二.上下文
上下文:即语境,语意,在程序中可以理解为在代码执行到某一时刻时,根据之前代码所做的操作以及下文即将要执行的逻辑,可以决定在当前时刻下可以使用到的变量,或者可以完成的事情。
Flask中有两种上下文,请求上下文(request context)和应用上下文(application context)。
Flask中上下文对象:相当于一个容器,保存了 Flask 程序运行过程中的一些信息[变量、函数、类与对象等信息]。
1. *application* 指的就是当你调用`app = Flask(__name__)`创建的这个对象`app`;
2. *request* 指的是每次`http`请求发生时,`WSGI server`(比如gunicorn)调用`Flask.__call__()`之后,在`Flask`对象内部创建的`Request`对象;
3. *application* 表示用于响应WSGI请求的应用本身,*request* 表示每次http请求;
4. *application*的生命周期大于*request*,一个*application*存活期间,可能发生多次http请求,所以,也就会有多个*request*
三.异常捕获
1.主动抛出HTTP异常
bort 方法
抛出一个给定状态代码的 HTTPException 或者 指定响应,例如想要用一个页面未找到异常来终止请求,你可以调用 abort(404)。
参数:
code – HTTP的错误状态码
from flask import Flask from flask import abort app = Flask(__name__) @app.route("/") def index(): abort(400) return "ok" if __name__ == '__main__': app.run(port=5000, host='0.0.0.0', debug=True)
abort(500)
根据不同的状态码返回不同的页面信息。
2.捕获错误
errorhandler 装饰器
注册一个错误处理程序,当程序抛出指定错误状态码的时候,就会调用该装饰器所装饰的方法
参数:
code_or_exception – HTTP的错误状态码或指定异常
例如统一处理状态码为500的错误给用户友好的提示:
@app.errorhandler(500)
def internal_server_error(e):
return '服务器搬家了'
捕获指定异常类型
@app.errorhandler(ZeroDivisionError)
def zero_division_error(e):
return '除数不能为0'
例子:
from flask import Flask from flask import abort app = Flask(__name__) @app.errorhandler(401) def error_401(e): return "401 对不起您没有登录" @app.errorhandler(ZeroDivisionError) def zero_division_error(e): return '除数不能为0' @app.route("/") def index(): abort(500) return "ok" @app.route("/401") def index_401(): abort(401) return "ok" @app.route("/0") def index_0(): 1 / 0 return "ok" if __name__ == '__main__': app.run(port=5000, host='0.0.0.0', debug=True)
返回截图如下:
返回截图如下:
四.请求上下文(request context)
思考:在视图函数中,如何取到当前请求的相关数据?比如:请求地址,请求方式,cookie等等
在 flask 中,可以直接在视图函数中使用 request这个对象进行获取相关数据,而 request 就是请求上下文的对象,保存了当前本次请求的相关数据,请求上下文对象有:request、session。
request
封装了HTTP请求的内容,针对的是http请求。举例:user = request.args.get('user'),获取的是get请求的参数。
session
用来记录请求会话中的信息,针对的是用户信息。举例:session['name'] = user.id,可以记录用户信息。还可以通过session.get('name')获取用户信息。
五.应用上下文(application context)
它的字面意思是 应用上下文,但它不是一直存在的,它只是request context 中的一个对 app 的代理(人),所谓local proxy。它的作用主要是帮助 request 获取当前的应用,它是伴 request 而生,随 request 而灭的。
应用上下文对象有:current_app(相当于js中的this),g
1.current_app
应用程序上下文,用于存储应用程序中的变量,可以通过current_app.name打印当前app的名称,也可以在current_app中存储一些变量,例如:
应用的启动脚本是哪个文件,启动时指定了哪些参数
加载了哪些配置文件,导入了哪些配置
连接了哪个数据库
有哪些可以调用的工具类、常量
当前flask应用在哪个机器上,哪个IP上运行,内存多大
例子:
from flask import Flask from flask import current_app from flask import g app = Flask(__name__) @app.route("/") def app_context(): """ app 为打印运行的主文件名 :return: """ print(app," ") print(current_app) # 一般在视图中使用current_app来代替app return "ok" if __name__ == '__main__': app.run(port=5000, host='0.0.0.0', debug=True)
2.g变量
g 作为 flask 程序全局的一个临时变量,充当者中间媒介的作用,我们可以通过它传递一些数据,g 保存的是当前请求的全局变量,不同的请求会有不同的全局变量,通过不同的thread id区别
例:
from flask import Flask from flask import g app = Flask(__name__) @app.route("/") def app_context(): """ g 保存的是当前请求的全局变量 :return: """ g.name = "hsz" print("视图被执行了") # g 变量的作用就是定义一个全局变量 func1() return "ok" def func1(): func() def func(): print("username=%s" % g.name) if __name__ == '__main__': app.run(port=5000, host='0.0.0.0', debug=True)
用于多层函数调用,有点像global
注意:不同的请求,会有不同的全局变量g,g变量也会被重置
两者区别:
请求上下文:保存了客户端和服务器交互的数据。
应用上下文:flask 应用程序运行过程中,保存的一些配置信息,比如程序名、数据库连接、应用信息等。