flask 路由请求扩展
一、钩子函数
1、@app.before_request 和 @app.after_request
from flask import Flask
app = Flask(__name__)
@app.before_request
def before1():
print('before1')
@app.before_request
def before2():
print('before2')
return '第二个返回了'
@app.before_request
def before3():
print('before3')
@app.after_request
def after1(response):
print('after1')
return response
@app.after_request
def after2(response):
print('after2')
return response
@app.after_request
def after3(response):
print('after3')
return response
@app.route('/')
def index(): # put application's code here
return '返回了'
if __name__ == '__main__':
app.run()
结果 ：
before_request： 一旦返回了有效值，则后续的 @app.before_request 和视图函数将不在执行，这里 before3() 和 index() 不再执行
after_request：在视图函数处理完成并生成响应后，从下往上依次执行所有的 after_request 函数。这个流程不会中断，所以所有的 after_request 函数都会执行。
2、before_request 的使用场景
before_request 钩子函数在每个请求到达视图函数之前执行。这允许在正式处理请求之前进行一些预处理操作。以下是一些常见的使用场景：
2.1 用户认证与授权：
在访问任何受保护的路由之前检查用户是否已登录。
校验用户是否有权限访问特定资源。
@app.before_request
def check_authentication():
if not is_user_authenticated():
return redirect('/login')
2.2 初始化上下文和资源：
在每个请求开始时，初始化一些全局变量、数据库连接或其他资源。
@app.before_request
def initialize_globals():
g.some_data = load_some_data()
2.3 记录请求的信息用于审计或分析
@app.before_request
def log_request_info():
print(f'Handling request for {request.path}')
2.4 防止CSRF攻击：
验证请求中的CSRF令牌，确保请求是从可信来源发出的。
@app.before_request
def protect_from_csrf():
if request.method == "POST":
token = request.form.get('csrf_token')
if not token or token != session.get('csrf_token'):
abort(403)
3、after_request 的使用场景
after_request 钩子函数在视图函数处理完请求后执行，允许对响应进行附加处理。这可以用来添加全局的后处理逻辑。以下是一些常见的使用场景：
3.1 修改或增强响应：
添加或修改HTTP头
增加默认的响应格式，如增加跨域资源共享（CORS）头
@app.after_request
def add_cors_headers(response):
response.headers['Access-Control-Allow-Origin'] = '*'
return response
3.2 记录响应日志：
记录响应的相关信息，用于监控或分析。
@app.after_request
def log_response_info(response):
print(f'Returned status: {response.status}')
return response
3.3 缓存控制：
修改响应头部以控制缓存策略
@app.after_request
def add_cache_control(response):
if request.endpoint == 'static':
response.headers['Cache-Control'] = 'public, max-age=31536000'
return response
3.4 清理资源：
请求结束后进行资源的清理或释放，例如关闭数据库连接。
@app.after_request
def release_resources(response):
close_database_connection()
return response
3.5 安全增强：
增加安全相关的头部，如内容安全政策（Content Security Policy, CSP）。
@app.after_request
def set_security_headers(response):
response.headers['Content-Security-Policy'] = "default-src 'self'"
return response
4、@app.teardown_request
@app.teardown_request
def jingzhiz(err):
print(err) # 每一个请求之后绑定一个函数，即使遇到了异常。如果视图函数正常顺利运行，err是None的,如果视图函数出错了，err就是错误对象，一般用来做日志记录
print('teardown_request')
5、@app.errorhandler
@app.errorhandler(404)
def error(arg):
print('404测试', arg)
return render_template('404.html')
6、@app.template_global() 和 @app.template_filter()
是Flask中用于模板处理的两个装饰器，它们可以让你在Jinja2模板中定义全局变量和自定义过滤器，帮助你更灵活地处理模板中的数据。
6.1 @app.template_global() from flask import Flask
app = Flask(__name__)
@app.template_global()
def greet(name):
return f"Hello, {name}!"
@app.route('/')
def index():
return render_template('index.html')
在html 页面中使用变量
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
{{ greet('World') }} <!-- 输出：Hello, World! -->
</body>
</html>
6.2 @app.template_filter() 用于创建自定义的Jinja2过滤器。这些过滤器可以在模板中用于格式化数据，类似于内置的过滤器（如 str.upper）。
from flask import Flask
app = Flask(__name__)
@app.template_filter()
def reverse(s):
return s[::-1]
@app.route('/')
def index():
return render_template('index.html')
在 index.html 模板中，该自定义过滤器可以在管道操作中使用：
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Title</title>
</head>
<body>
{{ "Hello, World!" | reverse }} <!-- 输出：!dlroW ,olleH -->
</body>
</html>
- **
@app.template_global()**：用于注册全局函数，便于模板随时调用。适合逻辑较复杂且在多处地方使用的操作。 - **
@app.template_filter()**：用于注册自定义过滤器，在模板中对数据进行处理。适用于需要在模板中重复使用的格式化操作。
