Flask 异常处理

Flask 异常处理

• [使用 `@app.errorhandler` 装饰器](#使用 @app.errorhandler 装饰器)
• [使用 `@app.handle_exception` 装饰器](#使用 @app.handle_exception 装饰器)
• [使用 `register_error_handler`](#使用 register_error_handler)
• 调试模式
• 总结

在 Flask 应用中，异常处理是一个非常重要的部分，它可以帮助你管理运行时错误，提供友好的错误页面，以及记录必要的调试信息。Flask 提供了几种处理异常的方法，以下是一些主要的方法：

使用 @app.errorhandler 装饰器

你可以使用 Flask 的 @app.errorhandler 装饰器来注册一个自定义的错误处理函数。这个函数会在指定的 HTTP 错误发生时被调用。

from flask import Flask, render_template

app = Flask(__name__)

@app.errorhandler(404)
def page_not_found(error):
    return render_template('404.html'), 404

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

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

在这个例子中，我们为 404 错误注册了一个自定义的错误处理函数 page_not_found，它会渲染一个 404.html 模板文件。

使用 @app.handle_exception 装饰器

虽然 @app.errorhandler 装饰器对于 HTTP 错误非常有用，但 Flask 还提供了 @app.handle_exception 装饰器，它允许你处理任何类型的异常，而不仅仅是 HTTP 错误。然而，请注意，使用 @app.handle_exception 装饰器时，你仍然需要返回一个 Flask 响应对象（如 make_response），并且你可能需要手动设置响应状态码。

from flask import Flask, make_response

app = Flask(__name__)

@app.handle_exception
def handle_exception(e):
    # 处理所有异常
    response = make_response(f"An error occurred: {str(e)}", 500)
    return response

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

但是，这种方法有一个缺点：它会在所有异常之后被调用，包括 Flask 内部异常，这可能会导致你错过一些 Flask 默认的异常处理逻辑。

使用 register_error_handler

对于蓝图（Blueprint）中的异常处理，你需要使用 register_error_handler 方法，因为蓝图不能直接使用 @app.errorhandler。

from flask import Blueprint, render_template

bp = Blueprint('my_blueprint', __name__)

@bp.errorhandler(404)
def handle_404(error):
    return render_template('404.html'), 404

# 然后在你的应用中注册这个蓝图
app.register_blueprint(bp)

调试模式

当 Flask 应用在调试模式下运行时（app.run(debug=True)），它会显示一个交互式调试器，这对于开发过程中的错误诊断非常有用。然而，在生产环境中，你应该关闭调试模式，并使用自定义的错误处理页面来保护敏感信息。

总结

在 Flask 中处理异常时，你可以根据需要使用 @app.errorhandler、@app.handle_exception 装饰器或 register_error_handler 方法。务必确保在生产环境中提供友好的错误页面，并关闭调试模式以防止敏感信息泄露。