FastAPI 提供了简单易用,但功能强大的依赖注入系统。
这个依赖系统设计的简单易用,可以让开发人员轻松地把组件集成至 FastAPI。
编程中的「依赖注入」是声明代码(本文中为路径操作函数 )运行所需的,或要使用的「依赖」的一种方式。
然后,由系统(本文中为 FastAPI)负责执行任意需要的逻辑,为代码提供这些依赖(「注入」依赖项)。
依赖注入常用于以下场景:
上述场景均可以使用依赖注入,将代码重复最小化。
接下来,我们学习一个非常简单的例子,尽管它过于简单,不是很实用。
但通过这个例子,您可以初步了解「依赖注入」的工作机制。
首先,要关注的是依赖项。
依赖项就是一个函数,且可以使用与路径操作函数相同的参数:
from typing import Optional
from fastapi import Depends, FastAPI
app = FastAPI()
async def common_parameters(q: Optional[str] = None, skip: int = 0, limit: int = 100):
return {"q": q, "skip": skip, "limit": limit}
@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):
return commons
@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters)):
return commons
大功告成。
只用了2 行代码。
依赖项函数的形式和结构与路径操作函数一样。
因此,可以把依赖项当作没有「装饰器」(即,没有 @app.get("/some-path") )的路径操作函数。
依赖项可以返回各种内容。
本例中的依赖项预期接收如下参数:
然后,依赖项函数返回包含这些值的 dict。
from typing import Optional
from fastapi import Depends, FastAPI
app = FastAPI()
async def common_parameters(q: Optional[str] = None, skip: int = 0, limit: int = 100):
return {"q": q, "skip": skip, "limit": limit}
@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):
return commons
@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters)):
return commons
与在路径操作函数参数中使用 Body、Query 的方式相同,声明依赖项需要使用 Depends 和一个新的参数:
from typing import Optional
from fastapi import Depends, FastAPI
app = FastAPI()
async def common_parameters(q: Optional[str] = None, skip: int = 0, limit: int = 100):
return {"q": q, "skip": skip, "limit": limit}
@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):
return commons
@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters)):
return commons
虽然,在路径操作函数的参数中使用 Depends 的方式与 Body、Query 相同,但 Depends 的工作方式略有不同。
这里只能传给 Depends 一个参数。
且该参数必须是可调用对象,比如函数。
该函数接收的参数和路径操作函数的参数一样。
提示
下一章介绍,除了函数还有哪些「对象」可以用作依赖项。
接收到新的请求时,FastAPI 执行如下操作:
这样,只编写一次代码,FastAPI 就可以为多个路径操作共享这段代码 。
检查
注意,无需创建专门的类,并将之传递给 FastAPI 以进行「注册」或执行类似的操作。
只要把它传递给 Depends,FastAPI 就知道该如何执行后续操作。
FastAPI 调用依赖项的方式与路径操作函数一样,因此,定义依赖项函数,也要应用与路径操作函数相同的规则。
即,既可以使用异步的 async def,也可以使用普通的 def 定义依赖项。
在普通的 def 路径操作函数中,可以声明异步的 async def 依赖项;也可以在异步的 async def 路径操作函数中声明普通的 def 依赖项。
上述这些操作都是可行的,FastAPI 知道该怎么处理。
笔记
如里不了解异步,请参阅异步:“着急了?” 一章中 async 和 await 的内容。
依赖项及子依赖项的所有请求声明、验证和需求都可以集成至同一个 OpenAPI 概图。
所以,交互文档里也会显示依赖项的所有信息:
观察一下就会发现,只要路径 和操作匹配,就可以使用声明的路径操作函数。然后,FastAPI 会用正确的参数调用函数,并提取请求中的数据。
实际上,所有(或大多数)网络框架的工作方式都是这样的。
开发人员永远都不需要直接调用这些函数,这些函数是由框架(在此为 FastAPI )调用的。
通过依赖注入系统,只要告诉 FastAPI 路径操作函数 还要「依赖」其他在路径操作函数之前执行的内容,FastAPI 就会执行函数代码,并「注入」函数返回的结果。
其他与「依赖注入」概念相同的术语为:
依赖注入系统支持构建集成和「插件」。但实际上,FastAPI 根本不需要创建「插件」,因为使用依赖项可以声明不限数量的、可用于路径操作函数的集成与交互。
创建依赖项非常简单、直观,并且还支持导入 Python 包。毫不夸张地说,只要几行代码就可以把需要的 Python 包与 API 函数集成在一起。
下一章将详细介绍在关系型数据库、NoSQL 数据库、安全等方面使用依赖项的例子。
依赖注入系统如此简洁的特性,让 FastAPI 可以与下列系统兼容:
虽然,层级式依赖注入系统的定义与使用十分简单,但它却非常强大。
比如,可以定义依赖其他依赖项的依赖项。
最后,依赖项层级树构建后,依赖注入系统会处理所有依赖项及其子依赖项,并为每一步操作提供(注入)结果。
比如,下面有 4 个 API 路径操作(端点):
开发人员可以使用依赖项及其子依赖项为这些路径操作添加不同的权限:
与 OpenAPI 集成
在声明需求时,所有这些依赖项还会把参数、验证等功能添加至路径操作。
FastAPI 负责把上述内容全部添加到 OpenAPI 概图,并显示在交互文档中。
假设您在某个域中拥有后端API。并且您在另一个域或同一域的不同路径(或移动应用程序)中有一个前端。并且您希望有一种方法让前...
Django也提供允许在代码中完全控制数据库的API。手动指定数据库分配将优先于路由分配的数据库。手动为查询集选择数据库你可以在...
在Django项目中,一个常见需求是获取最终形式的URL,比如用于嵌入生成的内容中(视图和资源网址,给用户展示网址等)或用户服务...
所有 Django 支持的数据库后端都支持迁移,还有些支持表修改(通过 SchemaEditor 类实现)的第三方后端也支持。然而,有些数据库...
除前面说的基础请求/响应中间件模式外,你可以给基于类的中间件添加三种其他特殊方法:process_view()process_view(request, vie...
该会话目录在使用 JSONSerializer 时接受任何 json 序列化值或者当使用 PickleSerializer 时接受任何 picklable Pyt...
默认情况下,Django 为每个模型类添加了一个名为 objects 的 Manager。不过,若你想将 objects 用作字段名,或想使...
Java Swing教程 -Java Swing BorderLayoutBorderLayout将容器的空间分为五个区域:北,南,东,西和中心。BorderLayout将容器的空...
Java Swing教程 -Java Swing JColorChooser方法...以下代码使用JColorChooser选择一种颜色,并在标准输出上打印一条消息:import ...