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

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

目录

  1. 🛠️ 依赖注入与 FastAPI 高级特性
  2. ⚠️ 自定义异常类的实现与应用
  3. 🚨 使用 HTTPException 处理常见错误
  4. 🌍 全局异常处理器的设计与实现
  5. ⚙️ 异常处理与 API 响应的整合

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

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

依赖注入的基础

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

from fastapi import FastAPI, Dependsapp = 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 参数。

依赖注入的优势

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

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

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

from fastapi import FastAPI, Depends, HTTPException
from typing import Optionalapp = 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_idself.message = f"项目 {item_id} 未找到"super().__init__(self.message)

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

使用自定义异常

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

from fastapi import FastAPI, HTTPException, Dependsapp = 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_idself.status_code = 404self.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, HTTPExceptionapp = 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 JSONResponseapp = 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 JSONResponseapp = 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，从而更容易定位问题并进行修复。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.mzph.cn/web/62198.shtml

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

免押租赁系统助力资源共享新模式开创便捷租赁体验

免押租赁系统助力资源共享新模式开创便捷租赁体验

内容概要 免押租赁系统，听起来是不是很酷？这个新模式不仅仅是为了让你少花点钱，它的到来简直就是个革命！以前，租东西时首先想到的就是那个令人心痛的押金，对吧？但现在，免押租赁系统…
阅读更多...
oracle之用户的相关操作

oracle之用户的相关操作

（1）创建用户(sys用户下操作) 简单创建用户如下： CREATE USER username IDENTIFIED BY password; 如果需要自定义更多的信息，如用户使用的表空间等，可以使用如下： CREATE USER mall IDENTIFIED BY 12345…
阅读更多...
第77期 | GPTSecurity周报

第77期 | GPTSecurity周报

GPTSecurity是一个涵盖了前沿学术研究和实践经验分享的社区，集成了生成预训练Transformer（GPT）、人工智能生成内容（AIGC）以及大语言模型（LLM）等安全领域应用的知识。在这里，您可以找…
阅读更多...
如何通过自学成长为一名后端开发工程师？

如何通过自学成长为一名后端开发工程师？

大家好，我是袁庭新。最近，有星友向我提出了一个很好的问题：如何通过自学成为一名后端开发工程师？ 为了解答这个疑问，我特意制作了一个视频来详细分享我的看法和建议。 戳链接：如何通过自学成长为一名后端开…
阅读更多...
Linux---对缓冲区的简单理解--第一个系统程序

Linux---对缓冲区的简单理解--第一个系统程序

前序： 首先先理解一下什么是回车与换行；回车和换行是两个概念，它们不是一个东西； 回车:光标回到开始；换行:换到下一行； 如下图： 行缓冲区 如何理解缓冲区问题？ 可以认为&#xff0…
阅读更多...
力扣每日一题-999. 可以被一步捕获的棋子数

力扣每日一题-999. 可以被一步捕获的棋子数

题目 给定一个 8 x 8 的棋盘，只有一个 白色的车，用字符 R 表示。棋盘上还可能存在白色的象 B 以及黑色的卒 p。空方块用字符 . 表示。车可以按水平或竖直方向（上，下，左，右）移动任意个方格直到它…
阅读更多...
多模态大型语言模型MM-1.5采用数据驱动的方法，通过不断优化数据组合提高模型性能

多模态大型语言模型MM-1.5采用数据驱动的方法，通过不断优化数据组合提高模型性能

多模态大型语言模型MM-1.5采用数据驱动的方法，通过不断优化数据组合提高模型性能 MM-1.5模型的设计核心在于其数据驱动的方法，这意味着模型的性能在很大程度上取决于所使用的数据类型和组合。这种方法的实施细节可以从以下几个方面来展开： …
阅读更多...
UE5水文章 UI按钮样式快捷复制黏贴

UE5水文章 UI按钮样式快捷复制黏贴

shift右键拷贝 shift右键黏贴
阅读更多...
[Python学习日记-70] 元类

[Python学习日记-70] 元类

[Python学习日记-70] 元类 简介 什么是元类 关键字 class 创建类的流程分析 自定义元类控制类的创建 自定义元类控制类的调用 自定义元类的属性查找 自定义元类的应用与练习 简介 在上一篇章当中我们已经了解了面向对象的各种内置函数了，本篇我们将讲述“元类…
阅读更多...
数据结构题库11

数据结构题库11

第五章 树和二叉树 一、单项选择题 1．关于二叉树的下列说法正确的是 (1)。 (1)：A．二叉树的度为2 B．二叉树的度可以小于2 C．每一个结点的度都为2 D．至少有一个结点的度为 2．设深度为h(h>0)的二…
阅读更多...
【学习路线】Java

【学习路线】Java

Java基础 基础 基础语法 面向对象 集合框架 JCF 进阶 并发编程 JVM 企业级开发 框架 Spring Boot Spring Cloud 分布式 高性能 高可用 安全 基建 Docker 实战 数据库 MySQL Redis 计算机基础 计算机组成原理 操作系统 计算机网络 数据结构与算法 设计模式 参考：…
阅读更多...
学生公寓智能限电系统的功能和作用

学生公寓智能限电系统的功能和作用

学生公寓智能限电系统‌是一种用于管理和限制学生公寓用电的设备和技术，旨在确保用电安全、防止火灾事故，并促进节能减排。以下是关于学生公寓智能限电系统的详细介绍： 1、功能和作用 智能限电系统通过以下功能来管理和限制用电&#xff1a…
阅读更多...
【开发语言】层次状态机(HSM)介绍

【开发语言】层次状态机(HSM)介绍

层次状态机（Hierarchical State Machine, HSM），从基本原理、结构设计、实现方法以及如何结合 Qt 进行具体实现等方面进行分析。 1. 层次状态机的基本原理 层次状态机是一种用于管理复杂系统行为的状态机模型，它通过将状态组织成…
阅读更多...
MYSQL PARTITIONING分区操作和性能测试

MYSQL PARTITIONING分区操作和性能测试

PARTITION OR NOT PARTITION IN MYSQl Bill Karwin says “In most circumstances, you’re better off using indexes instead of partitioning as your main method of query optimization.” According to RICK JAMES: “It is so tempting to believe that PARTITIONing wi…
阅读更多...
深入解析 Loss 减少方式：mean和sum的区别及其在大语言模型中的应用 （中英双语）

深入解析 Loss 减少方式：mean和sum的区别及其在大语言模型中的应用 （中英双语）

深入解析 Loss 减少方式：mean 和 sum 的区别及其在大语言模型中的应用 在训练大语言模型（Large Language Models, LLM）时，损失函数（Loss Function）的处理方式对模型的性能和优化过程有显著影响。本文以 re…
阅读更多...
基于 AutoFlow 快速搭建基于 TiDB 向量搜索的本地知识库问答机器人

基于 AutoFlow 快速搭建基于 TiDB 向量搜索的本地知识库问答机器人

导读 本文将详细介绍如何通过 PingCAP 开源项目 AutoFlow 实现快速搭建基于 TiDB 的本地知识库问答机器人。如果提前准备好 Docker、TiDB 环境，整个搭建过程估计在 10 分钟左右即可完成，无须开发任何代码。 文中使用一篇 TiDB 文档作为本地数据源作为示…
阅读更多...
生信技能63 - 构建gnomAD变异位点的SQLite查询数据库

生信技能63 - 构建gnomAD变异位点的SQLite查询数据库

将数据量巨大的gnomAD数据库，通过SQLite数据库寻找gnomAD中存在的各种变异注释信息（如等位基因计数，深度，次要等位基因频率等），查询300.000个变量的查询需要大约40秒，通过染色体编号+位置+REF+ALT即可进行快速查询。 1. gnomAD变异注释VCF文件字段 gnomAD VCF各版本包…
阅读更多...
【前端】将vue的方法挂载到window上供全局使用，也方便跟原生js做交互

【前端】将vue的方法挂载到window上供全局使用，也方便跟原生js做交互

【前端】将vue的方法挂载到window上供全局使用&#xff0c;也方便跟原生js做交互 <template><div><el-button click"start">调用方法</el-button></div> </template> <script> // import { JScallbackProc } from ./JScal…
阅读更多...
基于XML的AOP开发

基于XML的AOP开发

AOP 为 Aspect Oriented Programming 的缩写&#xff0c;意思为面向切面编程。 AOP相关术语&#xff1a; 目标对象(Target)&#xff1a; 你要去代理的对象&#xff0c;可以理解为之前很单纯的那个对象。 代理对象(Proxy)&#xff1a; 你把你那个单纯的对象给我&#xff0c…
阅读更多...
记录blender学习过程中遇到的问题

记录blender学习过程中遇到的问题

物体发射的方向不对 被发射物体&#xff08;例如一棵树&#xff09;n键看旋转归0 切换正视图 将被发射物体的局部坐标的Z轴 指向 全局方向的X轴时 并且把粒子系统设置的物体旋转勾选上 方向就对了 做倒角发现有问题 检查缩放应用、面朝向、有没有重合点&#xff08;融合点&am…
阅读更多...
最新文章

Copyright @ 2022~2023