掌握FastAPI异常捕获：轻松应对API运行中的问题

引言

在开发API时，异常处理是保证API稳定性和可靠性的关键环节。FastAPI作为Python中一个高性能的Web框架，提供了强大的异常处理机制。本文将详细介绍如何在FastAPI中捕获和处理异常，以确保API的健壮性。

异常处理概述

在FastAPI中，异常处理可以通过以下几种方式进行：

使用@app.exception_handler装饰器定义全局异常处理器。
在具体的路由处理函数中捕获并处理异常。
使用FastAPI提供的异常类来创建自定义异常。

使用`@app.exception_handler`装饰器

@app.exception_handler装饰器可以用来定义全局异常处理器，它可以捕获特定类型的异常，并返回相应的响应。

from fastapi import FastAPI, HTTPException app = FastAPI() @app.exception_handler(HTTPException) async def http_exception_handler(request: Request, exc: HTTPException): return JSONResponse( status_code=exc.status_code, content={"message": exc.detail}, )

在上面的代码中，我们定义了一个全局异常处理器，用于捕获HTTPException类型的异常，并返回一个包含错误信息的JSON响应。

在路由处理函数中捕获异常

除了全局异常处理器，你还可以在具体的路由处理函数中捕获并处理异常。

from fastapi import FastAPI, HTTPException app = FastAPI() @app.get("/items/{item_id}") async def read_item(item_id: int): if item_id <= 0: raise HTTPException(status_code=400, detail="Item ID must be positive") return {"item_id": item_id}

在这个例子中，如果item_id不是正数，我们抛出一个HTTPException，FastAPI会自动捕获这个异常并返回相应的HTTP状态码和错误信息。

自定义异常

FastAPI允许你创建自定义异常类，以提供更具体的错误信息。

from fastapi import FastAPI, HTTPException app = FastAPI() class CustomException(Exception): pass @app.get("/items/{item_id}") async def read_item(item_id: int): if item_id <= 0: raise CustomException("Item ID must be positive") return {"item_id": item_id} @app.exception_handler(CustomException) async def custom_exception_handler(request: Request, exc: CustomException): return JSONResponse( status_code=400, content={"message": exc.args[0]}, )

在这个例子中，我们创建了一个名为CustomException的自定义异常类，并在路由处理函数中抛出它。我们还定义了一个异常处理器来捕获并处理这个自定义异常。