在深入探究依赖注入系统之前,让我们升级之前的例子。
在前面的例子中, 我们从可依赖项中返回了一个dict
:
=== "Python 3.6 以及 以下"
```Python hl_lines="9"
{!> ../../../docs_src/dependencies/tutorial001.py!}
```
=== "Python 3.10 以及以上"
```Python hl_lines="7"
{!> ../../../docs_src/dependencies/tutorial001_py310.py!}
```
但是后面我们在路径操作函数的参数commons
共享中得到了一个dict
。
我们知道编辑器不能为dict
提供很多支持(比如补全),因为它们不能知道它们的键和值类型。
对此,我们可以做的更好...
到目前为止,您看到的依赖项都被声明为函数。
但这并不是声明依赖项的唯一方法(尽管它可能是更常见的方法)。
关键因素是依赖项应该是“可调用的”。
Python中的“可调用”是指任何Python可以像函数一样“调用”的对象。
所以,如果你需要一个对象something
(可能不是一个函数),你可以像这样“调用”它(执行它),就像:
something()
或者
something(some_argument, some_keyword_argument="foo")
像这样它就是“可调用”。
您可能会注意到,要创建一个Python类的实例,您可以使用相同的语法。
举个例子:
class Cat:
def __init__(self, name: str):
self.name = name
fluffy = Cat(name="Mr Fluffy")
在这个例子中, fluffy
是一个实现Cat
的实例。
并且为了创建fluffy
,你就调用了Cat
。
因此,Python类也是属于可调用。
所以,在FastAPI中,你可以使用Python类作为依赖项。
FastAPI实际上检查的是它是否“可调用”(函数,类或其他任何类型)以及定义的参数。
如果您在FastAPI中以一个“可调用”对象作为依赖项,它将分析该“可调用”对象的参数,并以与路径操作函数的参数相同的方式处理它们。包括子依赖项。
这也适用于完全没有参数的可调用对象。这与不带参数的路径操作函数一样。
所以,我们可以将上面的依赖项common_parameters
更改为类CommonQueryParams
=== "Python 3.6 以及 以下"
```Python hl_lines="11-15"
{!> ../../../docs_src/dependencies/tutorial002.py!}
```
=== "Python 3.10 以及 以上"
```Python hl_lines="9-13"
{!> ../../../docs_src/dependencies/tutorial002_py310.py!}
```
注意用于创建类实例的__init__
方法:
=== "Python 3.6 以及 以下"
```Python hl_lines="12"
{!> ../../../docs_src/dependencies/tutorial002.py!}
```
=== "Python 3.10 以及 以上"
```Python hl_lines="10"
{!> ../../../docs_src/dependencies/tutorial002_py310.py!}
```
...它具有与我们以前的common_parameters
相同的参数:
=== "Python 3.6 以及 以下"
```Python hl_lines="9"
{!> ../../../docs_src/dependencies/tutorial001.py!}
```
=== "Python 3.10 以及 以上"
```Python hl_lines="6"
{!> ../../../docs_src/dependencies/tutorial001_py310.py!}
```
这些参数就是FastAPI用来“处理”依赖项的。
在这两种创建依赖项方法下,都将会:
- 一个可选的
q
查询参数,它是一个str
类型。 - 一个整数类型的
skip
查询参数,默认值为0。 - 一个整数类型
limit
查询参数,默认值为0。
在这两种创建依赖项方法下,数据都将在OpenAPI概图上进行转换、验证和记录等。
现在,您可以使用此类声明的依赖项了。
=== "Python 3.6 以及 以下"
```Python hl_lines="19"
{!> ../../../docs_src/dependencies/tutorial002.py!}
```
=== "Python 3.10 以及 以上"
```Python hl_lines="17"
{!> ../../../docs_src/dependencies/tutorial002_py310.py!}
```
FastAPI 调用这个CommonQueryParams
类。这将创建该类的一个“实例”,该实例将作为commons
参数传递给你的函数。
注意,我们在上面的代码中编写了两次CommonQueryParams
:
commons: CommonQueryParams = Depends(CommonQueryParams)
最后的 CommonQueryParams
:
... = Depends(CommonQueryParams)
...Fastapi实际上将知道使用什么依赖项。
FastAPI将从中提取声明的参数,这才是FastAPI实际调用的。
在本例中,第一个CommonQueryParams
:
commons: CommonQueryParams ...
...对于FastAPI没有任何特殊的意义。FastAPI不会使用它进行数据转换、验证等(因为对于这,它实际使用的是= Depends(CommonQueryParams)
)。
你实际上可以只这样编写:
commons = Depends(CommonQueryParams)
..就像这样:
=== "Python 3.6 以及 以下"
```Python hl_lines="19"
{!> ../../../docs_src/dependencies/tutorial003.py!}
```
=== "Python 3.10 以及 以上"
```Python hl_lines="17"
{!> ../../../docs_src/dependencies/tutorial003_py310.py!}
```
但是声明类型是被鼓励的,因为这样你的编辑器就会知道将传递什么作为commons
参数,然后它可以帮助你完成代码,类型检查,等等:
但是您可以看到,我们在这里有一些代码重复了,编写了CommonQueryParams
两次:
commons: CommonQueryParams = Depends(CommonQueryParams)
FastAPI为这些情况提供了一个快捷方式,在这种情况下,依赖项是一个特定的类,FastAPI将其“调用”来创建类本身的一个实例。
对于这些特定的情况,您可以跟随以下操作:
不是写成这样:
commons: CommonQueryParams = Depends(CommonQueryParams)
...而是这样写:
commons: CommonQueryParams = Depends()
您声明依赖项作为参数的类型,并使用Depends()
作为该函数的参数的“默认”值(在=之后),而在Depends()
中没有任何参数,这样不必在内部再次编写完整的类,取代了Depends(CommonQueryParams)
。
同样的例子看起来像这样:
=== "Python 3.6 以及 以下"
```Python hl_lines="19"
{!> ../../../docs_src/dependencies/tutorial004.py!}
```
=== "Python 3.10 以及 以上"
```Python hl_lines="17"
{!> ../../../docs_src/dependencies/tutorial004_py310.py!}
```
...Fastapi将会知道该怎么处理。
!!! tip 如果这看起来更加混乱而不是更加有帮助,那么请忽略它,你不需要它。
这只是一个快捷方式。因为**FastAPI**关心的是帮助您减少代码重复。