一、抛出异常
Flask中可以主动抛出HTTP异常。
abort方法:
抛出一个给定状态代码的 HTTPException 或者 指定异常。例如用一个页面未找到异常来终止请求,就调用 abort(404)
参数:
1)code,抛出状态码 --> 该状态码必须是HTTP协议的错误状态码;
或 2)Exception,抛出异常对象 --> 能够直接抛出异常对象;
导入:
from werkzeug.exceptions import abort
例:
abort(404)
abort(500)
二、处理异常
针对不同的异常对象或错误状态码,可以进行针对性的处理。
errorhandle装饰器:
作用:注册一个错误处理程序 --> 当程序抛出指定错误状态码时,就会自动调用该装饰器所装饰的方法;
参数:
1)code,HTTP的错误状态码;
或 2)exception,异常对象;
例:
@app.errorhandler(500)
def internal_server_error(e):
return '服务器搬家了'
@app.errorhandler(ZeroDivisionError)
def zero_division_error(e):
return '除数不能为0'
三、请求钩子
客户端和服务器交互的过程中,有效准备工作或扫尾工作需要处理,例:
1)在请求开始时,建立数据库连接;
2)在请求开始时,根据需求进行权限校验;
3)在请求结束时,指定数据的交互格式;
Flask通过“请求钩子”实现上述需求。
请求钩子是通过装饰器的形式实现的,Flask支持如下四种请求钩子:
1)before_first_request:在处理第一个请求前执行;
2)before_request:在每次请求前执行,如果在某修饰的函数中返回了一个响应,视图函数将不再被调用
3)after_request:如果没有抛出错误,在每次请求后执行
接收一个参数:视图函数做出的响应。
在此函数中可以对响应值在返回之前做最后一步修改处理
需要将参数中的响应在此参数中进行返回
4)teardown_request:在每次请求后执行
接受一个参数:错误信息,如果有相关错误抛出
举例代码:
from flask import Flask
from flask import abort
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 请求不符合条件:
# return "laowang"
# 在执行完视图函数之后会调用,并且会把视图函数所生成的响应传入,可以在此方法中对响应做最后一步统一的处理
@app.after_request
def after_request(response):
print("after_request")
response.headers["Content-Type"] = "application/json"
return response
# 请每一次请求之后都会调用,会接受一个参数,参数是服务器出现的错误信息
@app.teardown_request
def teardown_request(response):
print("teardown_request")
@app.route('/')
def index():
return 'index'
if __name__ == '__main__':
app.run(debug=True)
第一次请求时打印:
before_first_request
before_request
after_request
teardown_request
第二次请求时打印:
before_request
after_request
teardown_request
四、上下文
1.上下文管理器
一个类只要实现了_ente_()和_exit_()这两个方法,通过该类创建的对象就称为“上下文管理器”。
_enter_表示上文方法,需要返回文件对象;
_exit_表示下文方法,with语句执行完成会自动执行,即使出现异常也会执行该方法。
上下文管理器可以使用with语句。with语句开始执行时自动调用上文方法,完成执行时(不论是否出现异常)自动调用下文方法。
定义一个File类,实现 _enter_() 和\ _exit_()方法,然后使用 with 语句来完成操作文件,
示例代码:
class File(object):
# 初始化方法
def __init__(self, file_name, file_model):
# 定义变量保存文件名和打开模式
self.file_name = file_name
self.file_model = file_model
# 上文方法
def __enter__(self):
print("进入上文方法")
# 返回文件资源
self.file = open(self.file_name,self.file_model)
return self.file
# 下文方法
def __exit__(self, exc_type, exc_val, exc_tb):
print("进入下文方法")
self.file.close()
if __name__ == '__main__':
# 使用with管理文件
with File("1.txt", "r") as file:
file_data = file.read()
print(file_data)
运行结果:
进入上文方法
hello world
进入下文方法
2.Flask具有两种上下文:请求上下文和应用上下文
1)请求上下文对象
-
request:
封装了HTTP请求的内容,针对的是HTTP请求。请求地址、请求方式、cookie等都可以通过request这个请求上下文对象得到; -
session:
用来记录请求会话中的信息,针对的是用户信息。跟session相关的信息都可以通过session这个请求上下文对象得到;
2)应用上下文
应用上下文,只是请求上下文中的一个对app的代理,所谓local proxy。主要是用来帮助request获取当前的应用,伴request而生,随request而灭。
1.current_app:
应用程序上下文,用于存储应用程序中的变量,可以在current_app中存储一些变量,如:
- 应用的启动脚本是哪个文件,启动时指定了哪些参数
- 加载了哪些配置文件,导入了哪些配置
- 连接了哪个数据库
- 有哪些公用的工具类、常量
- 应用跑在哪个机器上,IP多少,内存多大
current_app 就是当前运行的flask app,在代码不方便直接操作flask的app对象时,可以操作current_app就等价于操作flask app对象
-
g对象:
作为flask程序全局的一个临时变量,充当中间媒介的作用。
--> 可以通过它在一次请求调用的多个函数之间传递一些数据。每次请求都会重设这个变量。
Flask流程:
客户端 --> 发起请求 --> Flask创建request和session上下文对象 ---> 创建g上下文对象--> 进入应用 --> 创建current_app上下文对象 --> 执行对应视图 --> 响应
只有客户端发送请求到服务端,请求到时才会创建上下文对象。没有请求,请求上下文对象和应用上下文对象都将不起作用。
一些代码示例:
from flask import Flask, current_app
app1 = Flask(__name__)
app2 = Flask(__name__)
# 以redis客户端对象为例
# 用字符串表示创建的redis客户端
# 为了方便在各个视图中使用,将创建的redis客户端对象保存到flask app中,
# 后续可以在视图中使用current_app.redis_cli获取
app1.redis_cli = 'app1 redis client'
app2.redis_cli = 'app2 redis client'
@app1.route('/route11')
def route11():
return current_app.redis_cli
@app1.route('/route12')
def route12():
return current_app.redis_cli
@app2.route('/route21')
def route21():
return current_app.redis_cli
@app2.route('/route22')
def route22():
return current_app.redis_cli
from flask import Flask, abort, g
app = Flask(__name__)
@app.before_request
def authentication():
"""
利用before_request请求钩子,在进入所有视图前先尝试判断用户身份
:return:
"""
# TODO 此处利用鉴权机制(如cookie、session、jwt等)鉴别用户身份信息
# if 已登录用户,用户有身份信息
g.user_id = 123
# else 未登录用户,用户无身份信息
# g.user_id = None
def login_required(func):
def wrapper(*args, **kwargs):
if g.user_id is not None:
return func(*args, **kwargs)
else:
abort(401)
return wrapper
@app.route('/')
def index():
return 'home page user_id={}'.format(g.user_id)
@app.route('/profile')
@login_required
def get_user_profile():
return 'user profile page user_id={}'.format(g.user_id)
3)手动开启请求上下文和应用上下文
request_context
-- 为我们提供了请求上下文环境,允许我们在外部使用请求上下文request、session
可以通过with语句进行使用:
>>> from flask import Flask
>>> app = Flask('')
>>> request.args # 错误,没有上下文环境
报错
>>> environ = {'wsgi.version':(1,0), 'wsgi.input': '',
'REQUEST_METHOD': 'GET', 'PATH_INFO': '/',
'SERVER_NAME': 'itcast server', 'wsgi.url_scheme': 'http', 'SERVER_PORT': '80'} # 模拟解析客户端请求之后的wsgi字典数据
>>> with app.request_context(environ): # 借助with语句使用request_context创建请求上下文
... print(request.path)
...
/
app_context
--为我们提供应用上下文语境,允许我们在外部使用应用上下文current_app、g
通过with语句进行使用:
>>> from flask import Flask
>>> app = Flask('')
>>> app.redis_cli = 'redis client'
>>>
>>> from flask import current_app
>>> current_app.redis_cli # 错误,没有上下文环境
报错
>>> with app.app_context(): # 借助with语句使用app_context创建应用上下文
... print(current_app.redis_cli)
...
redis client