FastAPI入门教程：自定义异常处理器

欢迎来到FastAPI的世界！如果你是Python初学者，没有Web开发经验，别担心，本教程将带你轻松上手。今天，我们学习如何自定义异常处理器——就像给应用添加一个智能的“错误处理小助手”。

什么是异常处理器？

想象一下，你在家里设置了一个自动报警系统。当发生意外（比如漏水或火灾），系统会自动通知你并采取行动。在Web开发中，异常处理器就是这样的系统：当应用运行时遇到错误（异常），它可以自定义如何处理和响应，而不是让用户看到复杂的错误信息。

准备工作

首先，确保你已经安装了Python。然后，在终端运行以下命令来安装FastAPI和服务器：

pip install fastapi uvicorn

第一步：快速创建你的第一个自定义异常处理器

让我们立即动手，创建一个简单的FastAPI应用，并添加一个自定义异常处理器。

1. 创建一个新文件 app.py，并复制粘贴以下代码：

from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse
from pydantic import BaseModel

app = FastAPI()

# 定义一个自定义异常类
class MyCustomException(Exception):
    pass

# 注册异常处理器
@app.exception_handler(MyCustomException)
async def custom_exception_handler(request, exc):
    return JSONResponse(
        status_code=400,
        content={"message": "哦不！发生了一个自定义错误。", "detail": str(exc)}
    )

# 创建一个路由来触发异常
@app.get("/trigger-error")
async def trigger_error():
    raise MyCustomException("这是一个测试错误！")

2. 保存文件，然后在终端运行应用：

uvicorn app:app --reload

3. 打开浏览器，访问 http://127.0.0.1:8000/trigger-error，你会看到一个JSON响应：

{
  "message": "哦不！发生了一个自定义错误。",
  "detail": "这是一个测试错误！"
}

太棒了！你已经成功创建了第一个自定义异常处理器。是不是很简单？

第二步：解释代码

让我们分解一下你刚刚写的代码：

• 定义异常类：我们创建了 MyCustomException 类，继承自Python的 Exception。这就像定义了一个新的错误类型。

• 注册处理器：使用 @app.exception_handler(MyCustomException) 装饰器，我们告诉FastAPI当遇到这个异常时，用 custom_exception_handler 函数来处理。

• 处理器函数：这个函数接收请求和异常对象，然后返回一个自定义的JSONResponse。我们设置了状态码为400（客户端错误），并返回友好的消息。

• 触发异常：在路由 /trigger-error 中，我们故意抛出自定义异常，来测试处理器。

第三步：添加更多自定义异常

现在，让我们扩展一下，处理不同类型的异常。

在 app.py 中添加以下代码：

# 定义另一个自定义异常
class AnotherException(Exception):
    pass

# 注册处理器
@app.exception_handler(AnotherException)
async def another_exception_handler(request, exc):
    return JSONResponse(
        status_code=500,
        content={"message": "服务器内部错误，请稍后再试。", "error": str(exc)}
    )

# 新路由
@app.get("/another-error")
async def another_error():
    raise AnotherException("另一个测试错误")

保存文件，FastAPI会自动重载。然后访问 http://127.0.0.1:8000/another-error，你会看到不同的响应。

第四步：实践练习

现在是你的回合！尝试以下练习来巩固学习：

1. 修改消息：更改异常处理器返回的消息，让它更个性化。
2. 添加状态码：尝试不同的HTTP状态码，比如404表示未找到。
3. 处理内置异常：注册一个处理器来处理 HTTPException，看看会发生什么。

例如，添加：

from fastapi import HTTPException

@app.exception_handler(HTTPException)
async def http_exception_handler(request, exc):
    return JSONResponse(
        status_code=exc.status_code,
        content={"custom_message": "处理HTTP异常", "detail": exc.detail}
    )

然后，在路由中抛出一个HTTP异常：

@app.get("/http-error")
async def http_error():
    raise HTTPException(status_code=418, detail="我是一个茶壶！")

访问 http://127.0.0.1:8000/http-error，看看响应。

总结

恭喜你！你已经学会了如何在FastAPI中创建和使用自定义异常处理器。通过简单的步骤，你可以控制错误响应，让应用更友好。记住：

• 异常处理器就像应用的“安全网”，处理意外情况。
• 使用 @app.exception_handler 装饰器来注册处理器。
• 保持代码简单，逐步扩展。

Web开发并不难，FastAPI让它更简单。继续探索，尝试添加更多功能，你会越来越有信心！

如果有问题，随时查阅FastAPI官方文档或社区。快乐编程！