Python Web 开发：使用 FastAPI 进行依赖注入与异常处理

🕗 发布于 2024-12-07 06:48 python 前端 fastapi 开发语言 数据库

Python Web 开发：使用 FastAPI 进行依赖注入与异常处理

1. 🛠️ 依赖注入与 FastAPI 高级特性

FastAPI 提供了非常强大的依赖注入机制，可以帮助开发者简化代码结构，使得应用更加清晰、可维护和易于扩展。依赖注入是一种设计模式，它使得组件之间的依赖关系得以解耦，尤其适用于大型应用程序。在 FastAPI 中，依赖注入不仅可以注入数据库连接、配置文件、服务类等，还能够注入复杂的业务逻辑处理层。

依赖注入的基础

在 FastAPI 中，依赖注入机制是通过 Depends 类来实现的。开发者只需要将需要依赖的组件作为参数传递给函数，FastAPI 会自动解析并将依赖项注入函数中。这种方式使得代码的模块化程度大大提高，也让代码更加简洁和可测试。

from fastapi import FastAPI, Depends

app = FastAPI()

# 定义一个简单的依赖项
def get_db():
    db = "数据库连接"
    return db

# 依赖注入到路径操作函数中
@app.get("/items/")
async def read_items(db: str = Depends(get_db)):
    return {"message": f"使用的数据库是：{db}"}

在上面的例子中，get_db() 函数返回一个“数据库连接”字符串，并通过 Depends(get_db) 注入到 read_items() 路由函数的参数中。FastAPI 会自动识别并调用 get_db()，将返回值传递给 db 参数。

依赖注入的优势

依赖注入提供了许多好处，尤其是在项目的可维护性和可扩展性方面。以下是几种常见的优势：

解耦和模块化：各个模块之间的依赖关系通过注入来管理，而不是硬编码在代码中，降低了模块间的耦合度。
代码清晰度：通过明确声明依赖项，代码变得更加清晰，易于理解和维护。
更容易进行单元测试：由于各个部分的依赖被解耦，因此可以通过模拟 (Mock) 或替换依赖项来更容易地进行单元测试。
复用性：开发者可以更容易地复用依赖项，无需重复创建新的实例或进行配置。

动态依赖注入

FastAPI 还支持动态依赖注入，这使得开发者可以根据不同的情况动态地决定依赖项。例如，可以根据用户角色注入不同的数据库连接、配置或服务。

from fastapi import FastAPI, Depends, HTTPException
from typing import Optional

app = FastAPI()

# 模拟根据不同角色返回不同数据库连接
def get_db(role: Optional[str] = None):
    if role == "admin":
        return "管理员数据库连接"
    elif role == "user":
        return "普通用户数据库连接"
    else:
        raise HTTPException(status_code=400, detail="无效角色")

@app.get("/items/")
async def read_items(db: str = Depends(get_db)):
    return {"message": f"当前使用的数据库连接是：{db}"}

这种动态注入方式在复杂的系统中非常有用，能够根据业务逻辑需要选择不同的依赖项。

2. ⚠️ 自定义异常类的实现与应用

在 Web 开发中，处理错误和异常是至关重要的一部分。FastAPI 提供了许多内建的异常处理机制，但对于一些特定业务场景，开发者往往需要自定义异常类。自定义异常类能够让我们更好地管理错误代码、错误消息，并且使 API 的错误信息更加语义化。

自定义异常类的实现

自定义异常类通常是通过继承 Exception 类来创建，并根据业务需要添加错误代码、消息或更多详细信息。以下是一个简单的自定义异常类实现的例子：

class ItemNotFoundError(Exception):
    def __init__(self, item_id: int):
        self.item_id = item_id
        self.message = f"项目 {item_id} 未找到"
        super().__init__(self.message)

在上述代码中，ItemNotFoundError 是一个自定义的异常类，继承了 Exception。该异常类具有一个初始化方法，用于接收 item_id 参数并构造错误信息。

使用自定义异常

在 FastAPI 中，异常可以通过 HTTPException 或通过自定义的异常类抛出。通过 Depends 注入依赖项，我们可以在路由函数中触发自定义异常。例如：

from fastapi import FastAPI, HTTPException, Depends

app = FastAPI()

# 假设这是数据库查询操作
def get_item(item_id: int):
    if item_id != 123:
        raise ItemNotFoundError(item_id)
    return {"item_id": item_id, "name": "商品名称"}

@app.get("/items/{item_id}")
async def read_item(item_id: int, item: dict = Depends(get_item)):
    return item

在上面的代码中，get_item 函数尝试查找指定 item_id 的项目，如果没有找到该项目，抛出 ItemNotFoundError 异常。FastAPI 会自动捕捉到这个异常并返回合适的错误信息。

异常类的扩展

自定义异常类不仅仅可以添加错误信息，还可以增加 HTTP 状态码、错误码等，以便更好地进行错误分类和处理。例如：

class ItemNotFoundError(HTTPException):
    def __init__(self, item_id: int):
        self.item_id = item_id
        self.status_code = 404
        self.detail = f"项目 {item_id} 未找到"
        super().__init__(status_code=self.status_code, detail=self.detail)

这种做法使得自定义的异常类可以直接作为 HTTPException 使用，FastAPI 会自动将其作为 HTTP 响应返回。

3. 🚨 使用 HTTPException 处理常见错误

FastAPI 内置了许多常用的 HTTP 错误状态码和异常处理类，其中 HTTPException 是最常用的异常类。它允许开发者通过设置状态码、错误信息等来抛出 HTTP 错误，进而在 API 响应中提供友好的错误提示。

使用 `HTTPException`

HTTPException 是一个简单的异常类，可以用来返回 HTTP 错误。它接受 status_code 和 detail 两个参数，分别表示 HTTP 状态码和错误信息。以下是一个简单的示例：

from fastapi import FastAPI, HTTPException

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int):
    if item_id != 123:
        raise HTTPException(status_code=404, detail="项目未找到")
    return {"item_id": item_id, "name": "商品名称"}

在上面的代码中，当 item_id 不为 123 时，FastAPI 会抛出 HTTPException，返回 404 状态码并显示错误信息“项目未找到”。

错误处理与自定义响应

在实际开发中，错误的处理往往需要根据业务场景进行定制化，比如添加更多的错误细节信息或返回不同格式的响应。例如，除了返回标准的 JSON 错误响应外，还可以添加额外的字段，帮助前端更好地理解错误。

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

@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={
            "error": exc.detail,
            "request_url": str(request.url),
        },
    )

在上面的代码中，我们定义了一个全局异常处理器，它会在遇到 HTTPException 异常时，返回自定义的 JSON 响应格式，并附加请求的 URL 作为调试信息。

4. 🌍 全局异常处理器的设计与实现

FastAPI 允许开发者通过全局异常处理器来捕获和处理应用中的所有异常。通过这种方式，开发者可以集中管理所有错误响应逻辑，而不需要在每个路由中单独处理异常。这使得应用的异常管理变得更加统一和高效。

定义全局异常处理器

FastAPI 通过 @app.exception_handler 装饰器提供了全局异常处理的功能。开发者可以为不同类型的

异常定义专门的处理函数，下面是一个处理所有未捕获异常的例子：

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

app = FastAPI()

@app.exception_handler(Exception)
async def global_exception_handler(request, exc: Exception):
    return JSONResponse(
        status_code=500,
        content={
            "message": "服务器发生了未知错误",
            "detail": str(exc),
        },
    )

在上面的代码中，我们定义了一个全局异常处理器，它会捕获所有未处理的异常，并返回一个统一的 500 错误响应。响应中包含了错误的详细信息以及“服务器发生了未知错误”的提示。

捕获特定异常

除了捕获所有异常，开发者还可以为特定的异常类型定义专门的处理函数。例如，当捕获 HTTPException 时，我们希望返回更加详细的错误信息和建议。如下所示：

@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={
            "error": exc.detail,
            "advice": "请检查请求参数或尝试稍后重试。",
        },
    )

这种做法能够让错误响应更加用户友好，并提供一些建议，帮助客户端更容易地解决问题。

5. ⚙️ 异常处理与 API 响应的整合

在实际的 API 开发中，错误处理不仅仅是返回一个错误状态码和消息那么简单。开发者往往需要将错误处理与 API 响应的整体设计相结合，以确保前端能够准确地解析和显示错误信息。FastAPI 提供了一些灵活的机制，能够帮助开发者实现这一点。

设计一致的错误响应格式

为了让前端更加方便地处理错误信息，通常需要设计一种统一的错误响应格式。这可以通过全局异常处理器和自定义异常类来实现。

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

app = FastAPI()

@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):
    return JSONResponse(
        status_code=exc.status_code,
        content={
            "status": "error",
            "error_code": exc.status_code,
            "message": exc.detail,
        },
    )

这种格式化的错误响应使得前端可以快速定位错误信息，并根据 error_code 进行相应的处理。

错误日志记录

除了返回错误信息外，错误日志记录也是异常处理中重要的一部分。通过将错误信息记录到日志中，开发者可以追踪应用的异常并分析问题根源。FastAPI 可以与 Python 标准库的 logging 模块集成，以便记录错误日志。

import logging
from fastapi import FastAPI, HTTPException
from fastapi.responses import JSONResponse

# 配置日志记录
logging.basicConfig(level=logging.ERROR)
logger = logging.getLogger(__name__)

app = FastAPI()

@app.exception_handler(HTTPException)
async def custom_http_exception_handler(request, exc: HTTPException):
    logger.error(f"发生错误: {exc.detail}, URL: {request.url}")
    return JSONResponse(
        status_code=exc.status_code,
        content={
            "status": "error",
            "error_code": exc.status_code,
            "message": exc.detail,
        },
    )

通过记录日志，开发者可以在后台查看详细的错误信息和请求 URL，从而更容易定位问题并进行修复。

原文地址：https://blog.csdn.net/weixin_52392194/article/details/144297096

免责声明：本站文章内容转载自网络资源，如本站内容侵犯了原著者的合法权益，可联系本站删除。更多内容请关注自学内容网（zxcms.com）！

上一篇：Qt学习笔记第51到60讲
下一篇：UE5 Compile Plugins | Rebuild from Source Manually | Unreal Engine | Tutorial

“declarative data-parallel operators“与“MapReduce”
“Declarative data-parallel operators”与“MapReduce”在数据处理和并行计算领域具有不同的特点和适用场景。它们之间的关系是相辅相成、相互补充的，而不是相互替代
阅读更多2024-12-29
服务器与电脑主机各自的优势
服务器能够采用冗余和容错机制，保证服务器中的操作系统可以长时间的稳定运行工作，为企业提供了远程管理和集中存储管理等多个专业的服务，为企业降低了整体的维护管理成本；人们经常认为服务器与电脑主机是同一种网
阅读更多2024-12-29
salesforce 控制 Experience Cloud 站点用户可以看到哪些用户
中，您可以通过多种方式控制站点用户（如社区用户）之间的可见性。这包括用户之间的信息可见性以及他们可以访问的其他用户数据。参考：https://help.salesforce.com/s/article
阅读更多2024-12-29
zabbix5.0版本（安装部署+添加服务器+拆分数据库）
本篇文章介绍，监控是对我们操作系统进行不间断的监控，这是软件生命周期非常重要的一环，可以做到事前告警，事后根据监控内容排查问题（金丝雀，监控重要指标），有问题的时候，运维需要管理运维债务（在软件开发过
阅读更多2024-12-29
【服务器主板】定制化：基于Intel至强平台的全新解决方案
随着数据处理需求不断增长，服务器硬件的发展也在持续推进。在这一背景下，为用户定制了一款全新的基于Intel至强平台的服务器主板，旨在提供强大的计算能力、优异的内存支持以及高速存储扩展能力。适用于需要高
阅读更多2024-12-29
TDengine 新功能 VARBINARY 数据类型
VARBIANRY 数据类型的使用全说明
阅读更多2024-12-29
【算法】下标计数
下标计数
阅读更多2024-12-29
leecode322.零钱兑换
多重背包问题，物品价值和INT_MAX重量都是coins[i]，amount是背包容量，求装满这个背包所需要的物品个数最少是多少。dp初始化：背包容量为0时，组合数为0，dp[0]=0；由于每次都取最
阅读更多2024-12-29
手撕算法-严刑拷打
给定 m 台“相同”机器（或工作线程、工人等），以及 n 个“任务”或“工作”，每个任务都有一个执行时间。
阅读更多2024-12-29
【golang】map遍历注意事项
循环结构，能够正确处理连续元素的查找和计数，避免了原代码中。当 you 尝试使用。上述代码通过修正后的。循环使用不当的问题。
阅读更多2024-12-29

Python Web 开发：使用 FastAPI 进行依赖注入与异常处理