106 lines
5.7 KiB
Markdown
106 lines
5.7 KiB
Markdown
# 現在のユーザーの取得 { #get-current-user }
|
||
|
||
一つ前の章では、（依存性注入システムに基づいた）セキュリティシステムは、 *path operation 関数* に `str` として `token` を与えていました:
|
||
|
||
{* ../../docs_src/security/tutorial001_an_py310.py hl[12] *}
|
||
|
||
しかし、それはまだそんなに有用ではありません。
|
||
|
||
現在のユーザーを取得するようにしてみましょう。
|
||
|
||
## ユーザーモデルの作成 { #create-a-user-model }
|
||
|
||
まずは、Pydanticのユーザーモデルを作成しましょう。
|
||
|
||
ボディを宣言するのにPydanticを使用するのと同じやり方で、Pydanticを別のどんなところでも使うことができます:
|
||
|
||
{* ../../docs_src/security/tutorial002_an_py310.py hl[5,12:16] *}
|
||
|
||
## 依存関係 `get_current_user` を作成 { #create-a-get-current-user-dependency }
|
||
|
||
依存関係 `get_current_user` を作ってみましょう。
|
||
|
||
依存関係はサブ依存関係を持つことができるのを覚えていますか？
|
||
|
||
`get_current_user` は前に作成した `oauth2_scheme` と同じ依存関係を持ちます。
|
||
|
||
以前直接 *path operation* の中でしていたのと同じように、新しい依存関係である `get_current_user` はサブ依存関係である `oauth2_scheme` から `str` として `token` を受け取るようになります:
|
||
|
||
{* ../../docs_src/security/tutorial002_an_py310.py hl[25] *}
|
||
|
||
## ユーザーの取得 { #get-the-user }
|
||
|
||
`get_current_user` は作成した（偽物の）ユーティリティ関数を使って、 `str` としてトークンを受け取り、先ほどのPydanticの `User` モデルを返却します:
|
||
|
||
{* ../../docs_src/security/tutorial002_an_py310.py hl[19:22,26:27] *}
|
||
|
||
## 現在のユーザーの注入 { #inject-the-current-user }
|
||
|
||
ですので、 `get_current_user` に対して同様に *path operation* の中で `Depends` を利用できます。
|
||
|
||
{* ../../docs_src/security/tutorial002_an_py310.py hl[31] *}
|
||
|
||
Pydanticモデルの `User` として、 `current_user` の型を宣言することに注意してください。
|
||
|
||
その関数の中ですべての入力補完や型チェックを行う際に役に立ちます。
|
||
|
||
/// tip | 豆知識
|
||
|
||
リクエストボディはPydanticモデルでも宣言できることを覚えているかもしれません。
|
||
|
||
ここでは `Depends` を使っているおかげで、 **FastAPI** が混乱することはありません。
|
||
|
||
///
|
||
|
||
/// tip | 豆知識
|
||
|
||
依存関係システムがこのように設計されているおかげで、 `User` モデルを返却する別の依存関係（別の「dependables」）を持つことができます。
|
||
|
||
同じデータ型を返却する依存関係は一つだけしか持てない、という制約が入ることはないのです。
|
||
|
||
///
|
||
|
||
## 別のモデル { #other-models }
|
||
|
||
これで、*path operation 関数* の中で現在のユーザーを直接取得し、`Depends` を使って、 **依存性注入** レベルでセキュリティメカニズムを処理できるようになりました。
|
||
|
||
そして、セキュリティ要件のためにどんなモデルやデータでも利用することができます。（この場合は、 Pydanticモデルの `User`）
|
||
|
||
しかし、特定のデータモデルやクラス、型に制限されることはありません。
|
||
|
||
モデルを、 `id` と `email` は持つが、 `username` は全く持たないようにしたいですか？ わかりました。同じ手段でこうしたこともできます。
|
||
|
||
ある `str` だけを持ちたい？ あるいはある `dict` だけですか？ それとも、データベースクラスのモデルインスタンスを直接持ちたいですか？ すべて同じやり方で機能します。
|
||
|
||
実際には、あなたのアプリケーションにはログインするようなユーザーはおらず、単にアクセストークンを持つロボットやボット、別のシステムがありますか？ここでも、全く同じようにすべて機能します。
|
||
|
||
あなたのアプリケーションに必要なのがどんな種類のモデル、どんな種類のクラス、どんな種類のデータベースであったとしても、 **FastAPI** は依存性注入システムでカバーしてくれます。
|
||
|
||
## コードサイズ { #code-size }
|
||
|
||
この例は冗長に見えるかもしれません。セキュリティとデータモデルユーティリティ関数および *path operation* が同じファイルに混在しているということを覚えておいてください。
|
||
|
||
しかし、ここに重要なポイントがあります。
|
||
|
||
セキュリティと依存性注入に関するものは、一度だけ書きます。
|
||
|
||
そして、それは好きなだけ複雑にすることができます。それでも、一箇所に、一度だけ書くのです。すべての柔軟性を備えます。
|
||
|
||
しかし、同じセキュリティシステムを使って何千ものエンドポイント（*path operation*）を持つことができます。
|
||
|
||
そして、それらエンドポイントのすべて（必要な、どの部分でも）がこうした依存関係や、あなたが作成する別の依存関係を再利用する利点を享受できるのです。
|
||
|
||
さらに、こうした何千もの *path operation* は、たった3行で表現できるのです:
|
||
|
||
{* ../../docs_src/security/tutorial002_an_py310.py hl[30:32] *}
|
||
|
||
## まとめ { #recap }
|
||
|
||
これで、 *path operation 関数* の中で直接現在のユーザーを取得できるようになりました。
|
||
|
||
既に半分のところまで来ています。
|
||
|
||
あとは、ユーザー/クライアントが実際に `username` と `password` を送信するための *path operation* を追加する必要があるだけです。
|
||
|
||
次はそれを説明します。
|