Browse Source
Co-authored-by: Waynerv <[email protected]> Co-authored-by: Sebastián Ramírez <[email protected]>pull/3724/head
committed by
GitHub
2 changed files with 89 additions and 0 deletions
@ -0,0 +1,88 @@ |
|||
# 子依赖项 |
|||
|
|||
FastAPI 支持创建含**子依赖项**的依赖项。 |
|||
|
|||
并且,可以按需声明任意**深度**的子依赖项嵌套层级。 |
|||
|
|||
**FastAPI** 负责处理解析不同深度的子依赖项。 |
|||
|
|||
### 第一层依赖项 |
|||
|
|||
下列代码创建了第一层依赖项: |
|||
|
|||
```Python hl_lines="8-9" |
|||
{!../../../docs_src/dependencies/tutorial005.py!} |
|||
``` |
|||
|
|||
这段代码声明了类型为 `str` 的可选查询参数 `q`,然后返回这个查询参数。 |
|||
|
|||
这个函数很简单(不过也没什么用),但却有助于让我们专注于了解子依赖项的工作方式。 |
|||
|
|||
### 第二层依赖项 |
|||
|
|||
接下来,创建另一个依赖项函数,并同时用该依赖项自身再声明一个依赖项(所以这也是一个「依赖项」): |
|||
|
|||
```Python hl_lines="13" |
|||
{!../../../docs_src/dependencies/tutorial005.py!} |
|||
``` |
|||
|
|||
这里重点说明一下声明的参数: |
|||
|
|||
* 尽管该函数自身是依赖项,但还声明了另一个依赖项(它「依赖」于其他对象) |
|||
* 该函数依赖 `query_extractor`, 并把 `query_extractor` 的返回值赋给参数 `q` |
|||
* 同时,该函数还声明了类型是 `str` 的可选 cookie(`last_query`) |
|||
* 用户未提供查询参数 `q` 时,则使用上次使用后保存在 cookie 中的查询 |
|||
|
|||
### 使用依赖项 |
|||
|
|||
接下来,就可以使用依赖项: |
|||
|
|||
```Python hl_lines="21" |
|||
{!../../../docs_src/dependencies/tutorial005.py!} |
|||
``` |
|||
|
|||
!!! info "信息" |
|||
|
|||
注意,这里在*路径操作函数*中只声明了一个依赖项,即 `query_or_cookie_extractor` 。 |
|||
|
|||
但 **FastAPI** 必须先处理 `query_extractor`,以便在调用 `query_or_cookie_extractor` 时使用 `query_extractor` 返回的结果。 |
|||
|
|||
```mermaid |
|||
graph TB |
|||
|
|||
query_extractor(["query_extractor"]) |
|||
query_or_cookie_extractor(["query_or_cookie_extractor"]) |
|||
|
|||
read_query["/items/"] |
|||
|
|||
query_extractor --> query_or_cookie_extractor --> read_query |
|||
``` |
|||
|
|||
## 多次使用同一个依赖项 |
|||
|
|||
如果在同一个*路径操作* 多次声明了同一个依赖项,例如,多个依赖项共用一个子依赖项,**FastAPI** 在处理同一请求时,只调用一次该子依赖项。 |
|||
|
|||
FastAPI 不会为同一个请求多次调用同一个依赖项,而是把依赖项的返回值进行<abbr title="一个实用程序/系统来存储计算/生成的值,以便重用它们,而不是再次计算它们。">「缓存」</abbr>,并把它传递给同一请求中所有需要使用该返回值的「依赖项」。 |
|||
|
|||
在高级使用场景中,如果不想使用「缓存」值,而是为需要在同一请求的每一步操作(多次)中都实际调用依赖项,可以把 `Depends` 的参数 `use_cache` 的值设置为 `False` : |
|||
|
|||
```Python hl_lines="1" |
|||
async def needy_dependency(fresh_value: str = Depends(get_value, use_cache=False)): |
|||
return {"fresh_value": fresh_value} |
|||
``` |
|||
|
|||
## 小结 |
|||
|
|||
千万别被本章里这些花里胡哨的词藻吓倒了,其实**依赖注入**系统非常简单。 |
|||
|
|||
依赖注入无非是与*路径操作函数*一样的函数罢了。 |
|||
|
|||
但它依然非常强大,能够声明任意嵌套深度的「图」或树状的依赖结构。 |
|||
|
|||
!!! tip "提示" |
|||
|
|||
这些简单的例子现在看上去虽然没有什么实用价值, |
|||
|
|||
但在**安全**一章中,您会了解到这些例子的用途, |
|||
|
|||
以及这些例子所能节省的代码量。 |
Loading…
Reference in new issue