Flask 中如何使用 `after_request` 装饰器？

推荐答案

在 Flask 中，after_request 装饰器用于注册一个函数，该函数会在每个请求处理完成后执行。这个函数通常用于修改响应对象或执行一些清理操作。

// www.javascriptcn.com code example
from flask import Flask, request, jsonify

app = Flask(__name__)

@app.after_request
def add_custom_header(response):
    # 在每个响应中添加自定义的 HTTP 头
    response.headers['X-Custom-Header'] = 'Custom Value'
    return response

@app.route('/')
def index():
    return jsonify(message="Hello, World!")

if __name__ == '__main__':
    app.run()

在这个示例中，add_custom_header 函数会在每个请求处理完成后执行，并在响应中添加一个自定义的 HTTP 头 X-Custom-Header。

本题详细解读

after_request 的作用

after_request 装饰器用于注册一个函数，该函数会在每个请求处理完成后执行。这个函数接收一个参数 response，即 Flask 的响应对象。你可以在函数中修改这个响应对象，例如添加 HTTP 头、修改响应内容等。

使用场景

• 添加 HTTP 头：可以在每个响应中添加自定义的 HTTP 头，如示例中的 X-Custom-Header。
• 修改响应内容：可以在函数中修改响应的内容，例如添加一些额外的信息。
• 执行清理操作：可以在请求处理完成后执行一些清理操作，例如关闭数据库连接、释放资源等。

注意事项

• after_request 函数必须接收一个参数 response，并且必须返回这个 response 对象。如果不返回 response，Flask 会抛出异常。
• after_request 函数会在每个请求处理完成后执行，因此要确保函数中的操作不会对性能产生显著影响。
• 如果有多个 after_request 函数，它们会按照注册的顺序依次执行。

示例代码解析

@app.after_request
def add_custom_header(response):
    response.headers['X-Custom-Header'] = 'Custom Value'
    return response

在这个示例中，add_custom_header 函数会在每个请求处理完成后执行。它接收一个 response 对象，并在响应头中添加一个自定义的 X-Custom-Header，然后返回修改后的 response 对象。

总结

after_request 装饰器是 Flask 中一个非常有用的工具，允许你在请求处理完成后执行一些操作。通过合理使用 after_request，你可以轻松地修改响应对象或执行一些清理操作。