FastAPI 中如何使用 Starlette 的异常处理？

推荐答案

在 FastAPI 中，你可以直接使用 Starlette 的异常处理机制来处理异常。以下是一个示例代码，展示了如何在 FastAPI 中使用 Starlette 的异常处理：

// www.javascriptcn.com code example
from fastapi import FastAPI, HTTPException
from starlette.exceptions import HTTPException as StarletteHTTPException
from starlette.responses import JSONResponse

app = FastAPI()

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

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

在这个示例中，我们定义了一个自定义的异常处理器 http_exception_handler，它处理所有 StarletteHTTPException 类型的异常。当请求的 item_id 为 42 时，会抛出一个 HTTPException，并由我们定义的异常处理器捕获并返回一个 JSON 响应。

本题详细解读

1. 异常处理器的定义

在 FastAPI 中，异常处理器是通过 @app.exception_handler 装饰器来定义的。这个装饰器接受一个异常类作为参数，并指定当该异常发生时应该调用的处理函数。

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

在这个例子中，我们定义了一个处理 StarletteHTTPException 的异常处理器。当 FastAPI 捕获到 StarletteHTTPException 异常时，它会调用 http_exception_handler 函数，并传入请求对象 request 和异常对象 exc。

2. 抛出异常

在 FastAPI 中，你可以使用 HTTPException 来抛出 HTTP 相关的异常。HTTPException 是 Starlette 提供的一个异常类，FastAPI 对其进行了封装。

raise HTTPException(status_code=404, detail="Item not found")

在这个例子中，当 item_id 为 42 时，我们抛出了一个 HTTPException，并指定了状态码为 404，错误信息为 "Item not found"。

3. 异常处理器的响应

异常处理器需要返回一个响应对象。在这个例子中，我们返回了一个 JSONResponse，它包含了状态码和错误信息。

return JSONResponse(
    status_code=exc.status_code,
    content={"message": exc.detail},
)

exc.status_code 是异常对象中的状态码，exc.detail 是异常对象中的错误信息。我们将这些信息封装在一个 JSON 对象中，并返回给客户端。

4. 使用场景

这种异常处理机制非常适合在 API 开发中使用，特别是当你需要自定义错误响应时。通过定义自己的异常处理器，你可以确保所有的异常都以一致的方式返回给客户端，从而提高 API 的可用性和可维护性。

5. 其他异常处理

除了 StarletteHTTPException，你还可以定义其他类型的异常处理器。例如，你可以处理 ValidationError 或其他自定义异常。

from pydantic import ValidationError

@app.exception_handler(ValidationError)
async def validation_exception_handler(request, exc):
    return JSONResponse(
        status_code=422,
        content={"message": "Validation error", "errors": exc.errors()},
    )

在这个例子中，我们定义了一个处理 ValidationError 的异常处理器，当请求参数验证失败时，会返回一个包含验证错误信息的 JSON 响应。