Browse Source
Co-authored-by: ryusuke.miyaji <[email protected]> Co-authored-by: ryuckel <[email protected]> Co-authored-by: tokusumi <[email protected]> Co-authored-by: T. Tokusumi <[email protected]> Co-authored-by: Sebastián Ramírez <[email protected]>pull/10972/head
committed by
GitHub
1 changed files with 86 additions and 0 deletions
@ -0,0 +1,86 @@ |
|||
# サブ依存関係 |
|||
|
|||
**サブ依存関係** を持つ依存関係を作成することができます。 |
|||
|
|||
それらは必要なだけ **深く** することができます。 |
|||
|
|||
**FastAPI** はそれらを解決してくれます。 |
|||
|
|||
### 最初の依存関係「依存可能なもの」 |
|||
|
|||
以下のような最初の依存関係(「依存可能なもの」)を作成することができます: |
|||
|
|||
```Python hl_lines="8 9" |
|||
{!../../../docs_src/dependencies/tutorial005.py!} |
|||
``` |
|||
|
|||
これはオプショナルのクエリパラメータ`q`を`str`として宣言し、それを返すだけです。 |
|||
|
|||
これは非常にシンプルです(あまり便利ではありません)が、サブ依存関係がどのように機能するかに焦点を当てるのに役立ちます。 |
|||
|
|||
### 第二の依存関係 「依存可能なもの」と「依存」 |
|||
|
|||
そして、別の依存関数(「依存可能なもの」)を作成して、同時にそれ自身の依存関係を宣言することができます(つまりそれ自身も「依存」です): |
|||
|
|||
```Python hl_lines="13" |
|||
{!../../../docs_src/dependencies/tutorial005.py!} |
|||
``` |
|||
|
|||
宣言されたパラメータに注目してみましょう: |
|||
|
|||
* この関数は依存関係(「依存可能なもの」)そのものであるにもかかわらず、別の依存関係を宣言しています(何か他のものに「依存」しています)。 |
|||
* これは`query_extractor`に依存しており、それが返す値をパラメータ`q`に代入します。 |
|||
* また、オプショナルの`last_query`クッキーを`str`として宣言します。 |
|||
* ユーザーがクエリ`q`を提供しなかった場合、クッキーに保存していた最後に使用したクエリを使用します。 |
|||
|
|||
### 依存関係の使用 |
|||
|
|||
以下のように依存関係を使用することができます: |
|||
|
|||
```Python hl_lines="21" |
|||
{!../../../docs_src/dependencies/tutorial005.py!} |
|||
``` |
|||
|
|||
!!! info "情報" |
|||
*path operation関数*の中で宣言している依存関係は`query_or_cookie_extractor`の1つだけであることに注意してください。 |
|||
|
|||
しかし、**FastAPI** は`query_extractor`を最初に解決し、その結果を`query_or_cookie_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 |
|||
``` |
|||
|
|||
## 同じ依存関係の複数回の使用 |
|||
|
|||
依存関係の1つが同じ*path operation*に対して複数回宣言されている場合、例えば、複数の依存関係が共通のサブ依存関係を持っている場合、**FastAPI** はリクエストごとに1回だけそのサブ依存関係を呼び出します。 |
|||
|
|||
そして、返された値を<abbr title="計算された値・生成された値を保存するユーティリティまたはシステム、再計算する代わりに再利用するためのもの">「キャッシュ」</abbr>に保存し、同じリクエストに対して依存関係を何度も呼び出す代わりに、特定のリクエストでそれを必要とする全ての「依存関係」に渡すことになります。 |
|||
|
|||
高度なシナリオでは、「キャッシュされた」値を使うのではなく、同じリクエストの各ステップ(おそらく複数回)で依存関係を呼び出す必要があることがわかっている場合、`Depens`を使用する際に、`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} |
|||
``` |
|||
|
|||
## まとめ |
|||
|
|||
ここで使われている派手な言葉は別にして、**依存性注入** システムは非常にシンプルです。 |
|||
|
|||
*path operation関数*と同じように見えるただの関数です。 |
|||
|
|||
しかし、それでも非常に強力で、任意の深くネストされた依存関係「グラフ」(ツリー)を宣言することができます。 |
|||
|
|||
!!! tip "豆知識" |
|||
これらの単純な例では、全てが役に立つとは言えないかもしれません。 |
|||
|
|||
しかし、**security** についての章で、それがどれほど有用であるかがわかるでしょう。 |
|||
|
|||
そして、あなたを救うコードの量もみることになるでしょう。 |
Loading…
Reference in new issue