FastAPI 全局捕获异常

在本文中，我们将介绍如何在 FastAPI 中全局捕获异常，并展示一些示例说明。

阅读更多：FastAPI 教程

什么是 FastAPI

FastAPI 是一个高性能的现代 Web 框架，用于构建 API。它基于 Python 类型提示和异步请求处理的特性，提供了极快的性能。FastAPI 受到了 Flask 和 Django 框架的启发，并结合了其他现代框架的优点。

全局异常处理

在开发 Web 应用程序时，出现异常是常见的情况。为了更好地处理这些异常，我们可以在 FastAPI 中通过定义一个异常处理器来全局捕获异常。

异常处理器的定义

FastAPI 提供了一个装饰器 @app.exception_handler(exception_type)，用于定义异常处理器。通过该装饰器，我们可以指定要处理的异常类型，并在异常发生时执行相应的逻辑。

下面是一个全局异常处理器的示例：

from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.exception_handler(HTTPException)
async def http_exception_handler(request, exc):
    return JSONResponse(status_code=exc.status_code, content={"message": "Server Error"})

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=500, detail="Item not found")
    return {"item_id": item_id}

在上面的示例中，我们定义了一个异常处理器 http_exception_handler()，用于处理 HTTPException 类型的异常。当在 /items/{item_id} 路径下请求一个不存在的商品时，我们会手动抛出一个 HTTPException 异常。

当应用程序运行时，如果发生 HTTPException 异常，FastAPI 会自动调用我们定义的异常处理器，并返回一个自定义的错误响应。在这个例子中，我们返回了一个状态码为 500 的响应，并显示错误消息 “Server Error”。

通用异常处理器

除了特定的异常处理器外，我们还可以定义一个通用的异常处理器来捕获其他类型的异常。

下面是一个全局异常处理器的示例：

from fastapi import FastAPI
from starlette.exceptions import HTTPException
from fastapi.responses import JSONResponse

app = FastAPI()

@app.exception_handler(Exception)
async def generic_exception_handler(request, exc):
    return JSONResponse(status_code=500, content={"message": "Server Error"})

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 0:
        raise ValueError("Item not found")
    return {"item_id": item_id}

在上面的示例中，我们定义了一个通用的异常处理器 generic_exception_handler()，用于处理所有类型的异常。当在 /items/{item_id} 路径下请求一个不存在的商品时，我们会手动抛出一个 ValueError 异常。

当应用程序运行时，如果发生任何类型的异常，FastAPI 会自动调用我们定义的通用异常处理器，并返回一个自定义的错误响应。在这个例子中，我们返回了一个状态码为 500 的响应，并显示错误消息 “Server Error”。

异常处理器的顺序和作用范围

在 FastAPI 中，异常处理器的调用顺序和作用范围是非常重要的。

当一个异常被抛出时，FastAPI 会按照 范围最小 和 定义顺序最靠前 的异常处理器来处理异常。如果匹配到了范围更小的异常处理器，则会调用该处理器并结束异常处理流程。

以下是一个异常处理器顺序的示例：

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse
from starlette.exceptions import HTTPException

app = FastAPI()

@app.exception_handler(Exception)
async def generic_exception_handler(request, exc):
    return JSONResponse(status_code=500, content={"message": "Internal Server Error"})

@app.exception_handler(HTTPException)
async def http_exception_handler(request, exc):
    return JSONResponse(status_code=exc.status_code, content={"message": "Server Error"})

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id == 0:
        raise HTTPException(status_code=404, detail="Item not found")
    elif item_id == 1:
        raise ValueError("Invalid item_id")
    else:
        return {"item_id": item_id}

在上面的示例中，我们定义了两个异常处理器，分别处理 Exception 和 HTTPException。当在 /items/{item_id} 路径下请求一个不存在的商品时，我们会手动抛出一个 HTTPException 异常。

如果 item_id 等于 0，则匹配到 HTTPException，该异常处理器会被调用并返回一个状态码为 404 的响应。

如果 item_id 等于 1，则匹配到 ValueError，由于没有定义对应的异常处理器，将调用通用异常处理器并返回一个状态码为 500 的响应。

如果 item_id 大于 1，则返回一个包含 item_id 的响应。

总结

通过全局异常处理器，我们可以更好地处理异常情况，提供自定义的错误响应。使用 FastAPI 的 @app.exception_handler(exception_type) 装饰器，我们可以针对不同类型的异常定义特定的处理逻辑，或者使用通用异常处理器捕获其他类型的异常。弄清楚异常处理器的顺序和作用范围也是非常重要的。希望本文能为你在 FastAPI 中全局捕获异常提供一些帮助和指导。