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

相关文章

Python结合PyWebView库打造跨平台桌面应用

《Python结合PyWebView库打造跨平台桌面应用》随着Web技术的发展,将HTML/CSS/JavaScript与Python结合构建桌面应用成为可能,本文将系统讲解如何使用PyWebView... 目录一、技术原理与优势分析1.1 架构原理1.2 核心优势二、开发环境搭建2.1 安装依赖2.2 验

Spring Boot循环依赖原理、解决方案与最佳实践(全解析)

《SpringBoot循环依赖原理、解决方案与最佳实践(全解析)》循环依赖指两个或多个Bean相互直接或间接引用,形成闭环依赖关系,:本文主要介绍SpringBoot循环依赖原理、解决方案与最... 目录一、循环依赖的本质与危害1.1 什么是循环依赖?1.2 核心危害二、Spring的三级缓存机制2.1 三

Python如何自动生成环境依赖包requirements

《Python如何自动生成环境依赖包requirements》:本文主要介绍Python如何自动生成环境依赖包requirements问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑... 目录生成当前 python 环境 安装的所有依赖包1、命令2、常见问题只生成当前 项目 的所有依赖包1、

基于Python打造一个全能文本处理工具

《基于Python打造一个全能文本处理工具》:本文主要介绍一个基于Python+Tkinter开发的全功能本地化文本处理工具,它不仅具备基础的格式转换功能,更集成了中文特色处理等实用功能,有需要的... 目录1. 概述:当文本处理遇上python图形界面2. 功能全景图:六大核心模块解析3.运行效果4. 相

springboot项目中常用的工具类和api详解

《springboot项目中常用的工具类和api详解》在SpringBoot项目中,开发者通常会依赖一些工具类和API来简化开发、提高效率,以下是一些常用的工具类及其典型应用场景,涵盖Spring原生... 目录1. Spring Framework 自带工具类(1) StringUtils(2) Coll

Python从零打造高安全密码管理器

《Python从零打造高安全密码管理器》在数字化时代,每人平均需要管理近百个账号密码,本文将带大家深入剖析一个基于Python的高安全性密码管理器实现方案,感兴趣的小伙伴可以参考一下... 目录一、前言:为什么我们需要专属密码管理器二、系统架构设计2.1 安全加密体系2.2 密码强度策略三、核心功能实现详解

基于Python打造一个可视化FTP服务器

《基于Python打造一个可视化FTP服务器》在日常办公和团队协作中,文件共享是一个不可或缺的需求,所以本文将使用Python+Tkinter+pyftpdlib开发一款可视化FTP服务器,有需要的小... 目录1. 概述2. 功能介绍3. 如何使用4. 代码解析5. 运行效果6.相关源码7. 总结与展望1

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

Java异常架构Exception(异常)详解

《Java异常架构Exception(异常)详解》:本文主要介绍Java异常架构Exception(异常),具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录1. Exception 类的概述Exception的分类2. 受检异常(Checked Exception)