FastAPI 依賴注入詳解:概念

FastAPI得力于TypingPydantic以及Inspect灵巧,強大的類型庫和反射庫搀矫,給與了其進行類型檢測和依賴注入的能力抹沪。

為什么可以進行類型檢測

endpoint 指的是我們所編寫的,處理request請求的函數瓤球。而我們會將希望從HTTP報文中獲取的參數融欧,填寫在endpoint參數的位置。
Inspect庫是Python強大的反射庫卦羡,它可以實現自省噪馏,對函數的參數進行檢測,得到它們的信息绿饵。包括參數名欠肾,標注的類型,默認值蝴罪,允許的傳值方式董济。

def test(a: int, b: str = "b_str"):
    pass

sig = inspect.signature(test)
params = dict(sig.parameters)
參數字典

我們可以看到,每個參數會被解析為一個Parameter對象要门,里面記錄了參數的各種信息虏肾。
annotationdefault代表著類型注解和默認值欢搜,kind表示允許何種方式傳參封豪。
empty是用來做判斷的工具,我們可以看到當annotation炒瘟,default未標注時吹埠,其類型是<class 'inspect._empty'>,當我們想判斷是否有標注時疮装,就需要與其做比較缘琅,為了方便,empty用來代表<class 'inspect._empty'>廓推。只需要與他進行判斷即可刷袍。

這樣,一個函數的參數信息便是已知的樊展,進而呻纹,一個endpoint所需要的參數信息也是已知的∽ú框架知道我們的endpoint需要什么樣的參數雷酪。

為什么需要類型檢測

FastAPI高度集成OpenAPI(即SwaggerUI),參數類型檢測涝婉,可以生成信息更加明確和豐富的API文檔哥力。這對于效率上來說是飛躍性的提升。后端只需要把endpoint寫出來墩弯,框架就會將信息豐富的API文檔自動生成出來省骂。
另一方面蟀淮,就是為依賴注入提供了基礎。

為什么需要依賴注入

如果你了解spring的話钞澳,你一定知道spring的核心技術是IOCAOPIOCDI的前提涨缚,DIIOC的一種實現轧粟。

FastAPI的依賴注入,主要是為了解決兩個問題脓魏。

  1. 在endpoint之前執(zhí)行一些邏輯兰吟,這更加符合依賴的字面意思,本件事(endpoint)必須依賴于某些事(依賴項)的成功執(zhí)行茂翔。并獲取他們的返回值
  2. 智能的依賴項填充混蔼,我們接收的request可能包含大量字段,我們也可能需要他們作為參數珊燎,生成各種對象惭嚣。例如我的request中包含name, age, email, token, count, title, article我需要讓他們滿足
    (User(name, age, email), Depend(verify_token), count, Article(title, article))等一系列參數,正常情況下我們只能自己手動實例化或調用這些內容悔政。但是依賴注入幫我們將這些步驟都完成了晚吞,這得利于inspect的反射,可以檢測每個角色都需要什么樣的參數谋国。

從廣義上來講槽地,endpoint執(zhí)行前所需要準備的所有項,都屬于依賴系統(tǒng)的范疇芦瘾。FastAPI的依賴系統(tǒng)捌蚊,負責為endpoint準備“環(huán)境”。

那么近弟,這些項都是指的哪些缅糟?

  • 普通參數
  • 參數校驗 Path(),Query()
  • 額外參數 Header()藐吮,Cookie()溺拱,Body(),Form()谣辞,File()
  • 依賴項 Depends()迫摔,Security()

重點在于Depnds()

Depends()可以攜帶一個函數,或者一個類泥从。返回的結果是其result句占,或者實例。
所有依賴項都可以有自己的參數躯嫉,這些參數是從報文中攔截纱烘。

這就像派發(fā)快遞的小哥杨拐,而依賴項是走在你前面的人±奚叮快遞小哥會優(yōu)先將他需要的快遞派發(fā)給他哄陶,在剩余的快遞中尋找你所需的。如果有差錯哺壶,那就說明出了大問題屋吨,你們之間的所需起了沖突

  1. Depends()有兩個參數山宾,dependencyuse_cache至扰,前者是我們的依賴項,而后者资锰,代表的是是否使用緩存敢课。
    緩存的意義在于,假設在解決依賴的過程中绷杜,有一個依賴項不止執(zhí)行一次直秆,他可能被多次需求。但我們不希望多次執(zhí)行它接剩。我們便可以使用緩存來解決切厘。
    緩存默認置為True,我們不需要手動開啟它懊缺,但是某些情況下疫稿,我們希望同一個依賴項多次執(zhí)行,那么便可以手動置為False
  2. 依賴項可以寫在裝飾器的dependencies參數中鹃两,例如:
    @app.get("/items/", dependencies=[Depends(verify_token), Depends(verify_key)])
    這代表著我們不需要這個依賴項的結果遗座,只需要其順利執(zhí)行。
  3. 依賴項中可以使用 yieldcontext俊扳,例如獲取數據庫session的依賴項途蒋,我們可能只需要其不斷產生session,而不是將整個函數重新執(zhí)行一次馋记,便可以用yield不斷為所有需求方提供yield号坡。而context可以幫我們更好的管理生成的依賴項

參考官方文檔:https://fastapi.tiangolo.com/zh/tutorial/dependencies/dependencies-with-yield/

下一篇 FastAPI 依賴注入詳解: 處理依賴樹 http://www.reibang.com/p/9685f6b7ca24

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市梯醒,隨后出現的幾起案子宽堆,更是在濱河造成了極大的恐慌,老刑警劉巖茸习,帶你破解...
    沈念sama閱讀 206,214評論 6 481
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件畜隶,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機籽慢,發(fā)現死者居然都...
    沈念sama閱讀 88,307評論 2 382
  • 文/潘曉璐 我一進店門浸遗,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人箱亿,你說我怎么就攤上這事跛锌。” “怎么了届惋?”我有些...
    開封第一講書人閱讀 152,543評論 0 341
  • 文/不壞的土叔 我叫張陵察净,是天一觀的道長。 經常有香客問我盼樟,道長,這世上最難降的妖魔是什么锈至? 我笑而不...
    開封第一講書人閱讀 55,221評論 1 279
  • 正文 為了忘掉前任晨缴,我火速辦了婚禮,結果婚禮上峡捡,老公的妹妹穿的比我還像新娘击碗。我一直安慰自己,他們只是感情好们拙,可當我...
    茶點故事閱讀 64,224評論 5 371
  • 文/花漫 我一把揭開白布稍途。 她就那樣靜靜地躺著,像睡著了一般砚婆。 火紅的嫁衣襯著肌膚如雪械拍。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 49,007評論 1 284
  • 那天装盯,我揣著相機與錄音坷虑,去河邊找鬼。 笑死埂奈,一個胖子當著我的面吹牛迄损,可吹牛的內容都是我干的。 我是一名探鬼主播账磺,決...
    沈念sama閱讀 38,313評論 3 399
  • 文/蒼蘭香墨 我猛地睜開眼芹敌,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了垮抗?” 一聲冷哼從身側響起氏捞,我...
    開封第一講書人閱讀 36,956評論 0 259
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎借宵,沒想到半個月后幌衣,有當地人在樹林里發(fā)現了一具尸體,經...
    沈念sama閱讀 43,441評論 1 300
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 35,925評論 2 323
  • 正文 我和宋清朗相戀三年豁护,在試婚紗的時候發(fā)現自己被綠了哼凯。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 38,018評論 1 333
  • 序言:一個原本活蹦亂跳的男人離奇死亡楚里,死狀恐怖断部,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情班缎,我是刑警寧澤蝴光,帶...
    沈念sama閱讀 33,685評論 4 322
  • 正文 年R本政府宣布,位于F島的核電站达址,受9級特大地震影響蔑祟,放射性物質發(fā)生泄漏。R本人自食惡果不足惜沉唠,卻給世界環(huán)境...
    茶點故事閱讀 39,234評論 3 307
  • 文/蒙蒙 一疆虚、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧满葛,春花似錦径簿、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,240評論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至锄贷,卻和暖如春译蒂,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背肃叶。 一陣腳步聲響...
    開封第一講書人閱讀 31,464評論 1 261
  • 我被黑心中介騙來泰國打工蹂随, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人因惭。 一個月前我還...
    沈念sama閱讀 45,467評論 2 352
  • 正文 我出身青樓岳锁,卻偏偏與公主長得像,于是被迫代替她去往敵國和親蹦魔。 傳聞我的和親對象是個殘疾皇子激率,可洞房花燭夜當晚...
    茶點故事閱讀 42,762評論 2 345