1. FastAPI中的错误处理
在编写Web应用程序时，错误处理是不可避免的。遇到错误时，我们需要向用户提供友好的错误提示，同时记录错误日志，以便开发人员去调试。
FastAPI提供了多种错误处理方式，适用于不同的场景。本文将介绍以下错误处理方法：
- 全局异常处理
- 自定义异常处理
- HTTPException和status_code
1.1 全局异常处理
在FastAPI中，我们可以使用装饰器@app.exception_handler()定义全局异常处理函数。当应用程序抛出任何异常时，都会调用这个函数。
下面的例子演示了如何定义一个全局异常处理程序：
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": exc.detail},
)
@app.get("/")
async def read_root():
raise HTTPException(status_code=418, detail="I'm a teapot")
在上面的例子中，我们定义了一个HTTPException的异常处理器。它会处理所有HTTPException类型的异常。
如果我们在路由函数中抛出HTTPException异常，全局异常处理器将会捕获这个异常，然后返回一个错误响应。在本例中，我们抛出了HTTP状态码为418（I'm a teapot）的异常。
1.2 自定义异常处理
除了全局异常处理器外，我们还可以定义自定义异常处理器来处理特定类型的异常。这可以帮助我们更细粒度地控制错误处理逻辑。
下面的代码演示了如何定义一个自定义异常处理器：
from fastapi import FastAPI, HTTPException
from starlette.exceptions import HTTPException as StarletteHTTPException
class MyException(Exception):
pass
app = FastAPI()
@app.exception_handler(MyException)
async def my_exception_handler(request, exc):
return JSONResponse(
status_code=500,
content={"message": "Something went wrong"},
)
@app.exception_handler(StarletteHTTPException)
async def starlette_http_exception_handler(request, exc):
return JSONResponse(
status_code=exc.status_code,
content={"message": exc.detail},
)
@app.get("/")
async def read_root():
raise MyException()
@app.get("/http_exception")
async def read_http_exception():
raise HTTPException(status_code=404, detail="Not found")
@app.get("/starlette_http_exception")
async def read_starlette_http_exception():
raise StarletteHTTPException(status_code=403, detail="Forbidden")
在上面的例子中，我们定义了两个自定义异常处理器。第一个处理器处理MyException类型的异常，将会返回一个HTTP状态码为500，内容为"Something went wrong"的响应。第二个处理器处理StarletteHTTPException类型的异常，会返回对应的HTTP状态码和detail属性。
在路由函数中，我们演示了如何分别抛出三种类型的异常：MyException、HTTPException和StarletteHTTPException。如果我们访问路由"/"，将会抛出MyException，并由my_exception_handler处理。如果我们访问"/http_exception"，将会抛出HTTPException，并由starlette_http_exception_handler处理。如果我们访问"/starlette_http_exception"，将会抛出StarletteHTTPException，并由starlette_http_exception_handler处理。
上述例子说明了全局异常处理器和自定义异常处理器的区别。全局异常处理器处理所有类型的异常，而自定义异常处理器只处理指定类型的异常。
1.3 HTTPException和status_code
HTTPException类是FastAPI中的一个内置异常类，用于返回HTTP错误响应。它包含一个status_code属性和一个detail属性。当抛出HTTPException异常时，FastAPI将自动返回一个包含这两个属性的错误响应。
下面的代码演示了如何使用HTTPException抛出异常：
from fastapi import FastAPI, HTTPException
app = FastAPI()
@app.get("/")
async def read_root():
raise HTTPException(status_code=404, detail="Not found")
在上面的例子中，当我们访问路由"/"时，将会抛出HTTP状态码为404，内容为"Not found"的异常。
在HTTPException类中，还包含了一些内置的状态码。如果我们希望使用这些状态码，可以直接使用相应的类属性。例如，HTTPException(status_code=HTTP_404_NOT_FOUND)将会抛出HTTP状态码为404，内容为"Not Found"的异常。
2. 自定义异常
除了内置的HTTPException异常外，我们还可以自定义异常，并在路由函数中抛出这些异常。在实际开发中，我们经常会自定义一些异常，以便在应用程序中处理特定的错误情况。
下面的代码演示了如何自定义一个异常类：
class MyException(Exception):
def __init__(self, message: str):
self.message = message
app = FastAPI()
@app.get("/")
async def read_root():
raise MyException("Something went wrong")
在上面的例子中，我们定义了一个MyException异常类，它包含一个message属性。在访问路由"/"时，我们抛出一个MyException异常，并将"Something went wrong"作为message属性的值。
当抛出自定义的异常时，我们可以自定义异常处理器来处理这些异常。例如，上面的例子中，我们可以定义如下的异常处理器：
@app.exception_handler(MyException)
async def my_exception_handler(request, exc):
return JSONResponse(
status_code=500,
content={"message": exc.message},
)
在上面的例子中，我们定义了一个my_exception_handler函数，它将返回一个HTTP状态码为500，内容为异常message属性的值的响应。
总结
在本文中，我们介绍了FastAPI中的错误处理机制，包括全局异常处理、自定义异常处理、HTTPException和status_code。我们还演示了如何自定义一个异常类，并定义一个异常处理器来处理这个异常。
错误处理在Web应用程序开发中至关重要。通过使用FastAPI提供的错误处理机制，我们可以更好地控制错误情况，提供更友好的错误提示，同时记录错误日志，以便开发人员进行调试。