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

相关文章

PHP应用中处理限流和API节流的最佳实践

《PHP应用中处理限流和API节流的最佳实践》限流和API节流对于确保Web应用程序的可靠性、安全性和可扩展性至关重要,本文将详细介绍PHP应用中处理限流和API节流的最佳实践,下面就来和小编一起学习... 目录限流的重要性在 php 中实施限流的最佳实践使用集中式存储进行状态管理(如 Redis)采用滑动

深入浅出Spring中的@Autowired自动注入的工作原理及实践应用

《深入浅出Spring中的@Autowired自动注入的工作原理及实践应用》在Spring框架的学习旅程中,@Autowired无疑是一个高频出现却又让初学者头疼的注解,它看似简单,却蕴含着Sprin... 目录深入浅出Spring中的@Autowired:自动注入的奥秘什么是依赖注入?@Autowired

Spring 依赖注入与循环依赖总结

《Spring依赖注入与循环依赖总结》这篇文章给大家介绍Spring依赖注入与循环依赖总结篇,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录1. Spring 三级缓存解决循环依赖1. 创建UserService原始对象2. 将原始对象包装成工

Spring-DI依赖注入全过程

《Spring-DI依赖注入全过程》SpringDI是核心特性,通过容器管理依赖注入,降低耦合度,实现方式包括组件扫描、构造器/设值/字段注入、自动装配及作用域配置,支持灵活的依赖管理与生命周期控制,... 目录1. 什么是Spring DI?2.Spring如何做的DI3.总结1. 什么是Spring D

Springboot项目构建时各种依赖详细介绍与依赖关系说明详解

《Springboot项目构建时各种依赖详细介绍与依赖关系说明详解》SpringBoot通过spring-boot-dependencies统一依赖版本管理,spring-boot-starter-w... 目录一、spring-boot-dependencies1.简介2. 内容概览3.核心内容结构4.

Python利用GeoPandas打造一个交互式中国地图选择器

《Python利用GeoPandas打造一个交互式中国地图选择器》在数据分析和可视化领域,地图是展示地理信息的强大工具,被将使用Python、wxPython和GeoPandas构建的交互式中国地图行... 目录技术栈概览代码结构分析1. __init__ 方法:初始化与状态管理2. init_ui 方法:

Go语言使用net/http构建一个RESTful API的示例代码

《Go语言使用net/http构建一个RESTfulAPI的示例代码》Go的标准库net/http提供了构建Web服务所需的强大功能,虽然众多第三方框架(如Gin、Echo)已经封装了很多功能,但... 目录引言一、什么是 RESTful API?二、实战目标:用户信息管理 API三、代码实现1. 用户数据

Python用Flask封装API及调用详解

《Python用Flask封装API及调用详解》本文介绍Flask的优势(轻量、灵活、易扩展),对比GET/POST表单/JSON请求方式,涵盖错误处理、开发建议及生产环境部署注意事项... 目录一、Flask的优势一、基础设置二、GET请求方式服务端代码客户端调用三、POST表单方式服务端代码客户端调用四

SpringBoot结合Knife4j进行API分组授权管理配置详解

《SpringBoot结合Knife4j进行API分组授权管理配置详解》在现代的微服务架构中,API文档和授权管理是不可或缺的一部分,本文将介绍如何在SpringBoot应用中集成Knife4j,并进... 目录环境准备配置 Swagger配置 Swagger OpenAPI自定义 Swagger UI 底

使用Python的requests库调用API接口的详细步骤

《使用Python的requests库调用API接口的详细步骤》使用Python的requests库调用API接口是开发中最常用的方式之一,它简化了HTTP请求的处理流程,以下是详细步骤和实战示例,涵... 目录一、准备工作:安装 requests 库二、基本调用流程(以 RESTful API 为例)1.