FastAPI 中间件与依赖注入:打造灵活的 API 架构

2024-09-04 13:36

本文主要是介绍FastAPI 中间件与依赖注入:打造灵活的 API 架构,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

在 FastAPI 中,Depends 是一个非常重要的概念,它用于依赖注入。依赖注入是一种设计模式,允许你将组件(如函数、类或服务)之间的依赖关系明确地表达出来,而不是硬编码在组件内部。这使得代码更加模块化、可测试和易于维护。

什么是 Depends

Depends 通常用于以下场景:

  1. 参数注入:将参数注入到路由处理函数中。
  2. 服务注入:将服务或工具类的实例注入到路由处理函数中。
  3. 前置验证:在路由处理函数执行之前执行验证逻辑。

如何使用 Depends

Depends 通常与路由处理函数的参数一起使用,如下所示:

from fastapi import Dependsdef get_query(token: str = Depends(your_dependency_function)):return token@app.get("/items/")
async def read_items(query: str = Depends(get_query)):return {"query": query}

在这个例子中,your_dependency_function 是一个依赖项函数,它返回一个值,该值将被注入到 get_query 函数中,然后 get_query 函数的返回值又被注入到路由处理函数 read_items 中。

依赖项函数

依赖项函数可以是任何返回值的异步或同步函数。它们可以执行各种任务,如:

  • 验证请求数据。
  • 从数据库中获取数据。
  • 执行复杂的计算。
  • 调用外部服务。

依赖项的嵌套

你可以将 Depends 用于嵌套依赖项,这意味着一个依赖项函数可以依赖于另一个依赖项函数:

def dependency_a():return "A"def dependency_b(a: str = Depends(dependency_a)):return a + "B"@app.get("/items/")
async def read_items(b: str = Depends(dependency_b)):return {"b": b}

依赖项的并行执行

FastAPI 能够并行执行依赖项函数,这意味着如果多个参数都依赖于相同的依赖项函数,FastAPI 会执行一次该函数,并将结果注入到所有参数中,从而提高效率。

依赖项的错误处理

如果依赖项函数抛出异常,FastAPI 会自动处理这些异常,并返回适当的 HTTP 响应。这使得错误处理更加简洁和集中。

其他实现依赖注入

在 FastAPI 中,Depends 是实现依赖注入的主要方式,但它并不是唯一的方法。以下是一些其他可以实现依赖注入的技术和方法:

  1. 直接参数传递
    你可以直接将依赖项作为参数传递给路由处理函数,而不是使用 Depends

    def some_dependency():return "dependency value"@app.get("/items/")
    async def read_items(dependency_value: str = some_dependency()):return {"dependency": dependency_value}
    
  2. 使用类
    通过创建类并使用其实例作为依赖项,可以利用面向对象的编程方法来管理依赖关系。

    class DependencyInjector:def get_dependency(self):return "dependency value"injector = DependencyInjector()@app.get("/items/")
    async def read_items(dependency_value: str = injector.get_dependency()):return {"dependency": dependency_value}
    
  3. 全局状态
    虽然不推荐,但可以通过全局变量或单例模式来存储和访问依赖项。

    dependency_value = "dependency value"@app.get("/items/")
    async def read_items(dependency_value: str = dependency_value):return {"dependency": dependency_value}
    
  4. 中间件
    在 FastAPI 中,你可以使用中间件来处理请求和响应。中间件可以在请求处理流程中的特定点注入依赖项。

    async def inject_dependency(request: Request, call_next):request.state.dependency = "dependency value"response = await call_next(request)return responseapp.add_middleware(Middleware, inject_dependency)
    
  5. 依赖提供者
    类似于 Depends,你可以创建自定义的依赖提供者函数,这些函数可以在内部处理复杂的依赖逻辑。

    def custom_dependency_provider():return "custom dependency value"@app.get("/items/")
    async def read_items(dependency_value: str = custom_dependency_provider()):return {"dependency": dependency_value}
    
  6. 工厂函数
    你可以定义工厂函数来创建依赖项,这些函数可以在需要时生成新的依赖项实例。

    def create_dependency():class Dependency:def __init__(self):self.value = "dependency value"return Dependency()@app.get("/items/")
    async def read_items(dependency: Dependency = Depends(create_dependency)):return {"dependency": dependency.value}
    
  7. 数据库会话管理
    对于数据库依赖,你可以使用数据库会话或 ORM 工具的上下文管理器来确保依赖项的正确注入和生命周期管理。

    from sqlalchemy.orm import Session@app.get("/items/")
    async def read_items(db: Session = Depends(get_db)):return {"items": [item async for item in db.query(Item)]}
    

每种方法都有其适用场景和优缺点。Depends 是 FastAPI 推荐的依赖注入方式,因为它提供了强大的功能,如并行执行、自动错误处理和易于测试。然而,在某些情况下,其他方法可能更适合特定的需求或设计模式。

这篇关于FastAPI 中间件与依赖注入:打造灵活的 API 架构的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1136156

相关文章

mybatis的整体架构

mybatis的整体架构分为三层: 1.基础支持层 该层包括:数据源模块、事务管理模块、缓存模块、Binding模块、反射模块、类型转换模块、日志模块、资源加载模块、解析器模块 2.核心处理层 该层包括:配置解析、参数映射、SQL解析、SQL执行、结果集映射、插件 3.接口层 该层包括:SqlSession 基础支持层 该层保护mybatis的基础模块,它们为核心处理层提供了良好的支撑。

百度/小米/滴滴/京东,中台架构比较

小米中台建设实践 01 小米的三大中台建设:业务+数据+技术 业务中台--从业务说起 在中台建设中,需要规范化的服务接口、一致整合化的数据、容器化的技术组件以及弹性的基础设施。并结合业务情况,判定是否真的需要中台。 小米参考了业界优秀的案例包括移动中台、数据中台、业务中台、技术中台等,再结合其业务发展历程及业务现状,整理了中台架构的核心方法论,一是企业如何共享服务,二是如何为业务提供便利。

每天认识几个maven依赖(ActiveMQ+activemq-jaxb+activesoap+activespace+adarwin)

八、ActiveMQ 1、是什么? ActiveMQ 是一个开源的消息中间件(Message Broker),由 Apache 软件基金会开发和维护。它实现了 Java 消息服务(Java Message Service, JMS)规范,并支持多种消息传递协议,包括 AMQP、MQTT 和 OpenWire 等。 2、有什么用? 可靠性:ActiveMQ 提供了消息持久性和事务支持,确保消

高效+灵活,万博智云全球发布AWS无代理跨云容灾方案!

摘要 近日,万博智云推出了基于AWS的无代理跨云容灾解决方案,并与拉丁美洲,中东,亚洲的合作伙伴面向全球开展了联合发布。这一方案以AWS应用环境为基础,将HyperBDR平台的高效、灵活和成本效益优势与无代理功能相结合,为全球企业带来实现了更便捷、经济的数据保护。 一、全球联合发布 9月2日,万博智云CEO Michael Wong在线上平台发布AWS无代理跨云容灾解决方案的阐述视频,介绍了

基于 YOLOv5 的积水检测系统:打造高效智能的智慧城市应用

在城市发展中,积水问题日益严重,特别是在大雨过后,积水往往会影响交通甚至威胁人们的安全。通过现代计算机视觉技术,我们能够智能化地检测和识别积水区域,减少潜在危险。本文将介绍如何使用 YOLOv5 和 PyQt5 搭建一个积水检测系统,结合深度学习和直观的图形界面,为用户提供高效的解决方案。 源码地址: PyQt5+YoloV5 实现积水检测系统 预览: 项目背景

pip-tools:打造可重复、可控的 Python 开发环境,解决依赖关系,让代码更稳定

在 Python 开发中,管理依赖关系是一项繁琐且容易出错的任务。手动更新依赖版本、处理冲突、确保一致性等等,都可能让开发者感到头疼。而 pip-tools 为开发者提供了一套稳定可靠的解决方案。 什么是 pip-tools? pip-tools 是一组命令行工具,旨在简化 Python 依赖关系的管理,确保项目环境的稳定性和可重复性。它主要包含两个核心工具:pip-compile 和 pip

系统架构设计师: 信息安全技术

简简单单 Online zuozuo: 简简单单 Online zuozuo 简简单单 Online zuozuo 简简单单 Online zuozuo 简简单单 Online zuozuo :本心、输入输出、结果 简简单单 Online zuozuo : 文章目录 系统架构设计师: 信息安全技术前言信息安全的基本要素:信息安全的范围:安全措施的目标:访问控制技术要素:访问控制包括:等保

深入理解数据库的 4NF:多值依赖与消除数据异常

在数据库设计中, "范式" 是一个常常被提到的重要概念。许多初学者在学习数据库设计时,经常听到第一范式(1NF)、第二范式(2NF)、第三范式(3NF)以及 BCNF(Boyce-Codd范式)。这些范式都旨在通过消除数据冗余和异常来优化数据库结构。然而,当我们谈到 4NF(第四范式)时,事情变得更加复杂。本文将带你深入了解 多值依赖 和 4NF,帮助你在数据库设计中消除更高级别的异常。 什么是

【LabVIEW学习篇 - 21】:DLL与API的调用

文章目录 DLL与API调用DLLAPIDLL的调用 DLL与API调用 LabVIEW虽然已经足够强大,但不同的语言在不同领域都有着自己的优势,为了强强联合,LabVIEW提供了强大的外部程序接口能力,包括DLL、CIN(C语言接口)、ActiveX、.NET、MATLAB等等。通过DLL可以使用户很方便地调用C、C++、C#、VB等编程语言写的程序以及windows自带的大

利用命令模式构建高效的手游后端架构

在现代手游开发中,后端架构的设计对于支持高并发、快速迭代和复杂游戏逻辑至关重要。命令模式作为一种行为设计模式,可以有效地解耦请求的发起者与接收者,提升系统的可维护性和扩展性。本文将深入探讨如何利用命令模式构建一个强大且灵活的手游后端架构。 1. 命令模式的概念与优势 命令模式通过将请求封装为对象,使得请求的发起者和接收者之间的耦合度降低。这种模式的主要优势包括: 解耦请求发起者与处理者