FastAPI得力于Typing、Pydantic以及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對象要门,里面記錄了參數的各種信息虏肾。
annotation
,default
代表著類型注解和默認值欢搜,kind
表示允許何種方式傳參封豪。
empty
是用來做判斷的工具,我們可以看到當annotation
炒瘟,default
未標注時吹埠,其類型是<class 'inspect._empty'>
,當我們想判斷是否有標注時疮装,就需要與其做比較缘琅,為了方便,empty用來代表<class 'inspect._empty'>
廓推。只需要與他進行判斷即可刷袍。
這樣,一個函數的參數信息便是已知的樊展,進而呻纹,一個endpoint所需要的參數信息也是已知的∽ú框架知道我們的endpoint需要什么樣的參數雷酪。
為什么需要類型檢測
FastAPI高度集成OpenAPI(即SwaggerUI),參數類型檢測涝婉,可以生成信息更加明確和豐富的API文檔哥力。這對于效率上來說是飛躍性的提升。后端只需要把endpoint寫出來墩弯,框架就會將信息豐富的API文檔自動生成出來省骂。
另一方面蟀淮,就是為依賴注入提供了基礎。
為什么需要依賴注入
如果你了解spring的話钞澳,你一定知道spring的核心技術是IOC和AOP,IOC是DI的前提涨缚,DI是IOC的一種實現轧粟。
FastAPI的依賴注入,主要是為了解決兩個問題脓魏。
- 在endpoint之前執(zhí)行一些邏輯兰吟,這更加符合依賴的字面意思,本件事(endpoint)必須依賴于某些事(依賴項)的成功執(zhí)行茂翔。并獲取他們的返回值
- 智能的依賴項填充混蔼,我們接收的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ā)給他哄陶,在剩余的快遞中尋找你所需的。如果有差錯哺壶,那就說明出了大問題屋吨,你們之間的所需起了沖突。
- Depends()有兩個參數山宾,
dependency
和use_cache
至扰,前者是我們的依賴項,而后者资锰,代表的是是否使用緩存敢课。
緩存的意義在于,假設在解決依賴的過程中绷杜,有一個依賴項不止執(zhí)行一次直秆,他可能被多次需求。但我們不希望多次執(zhí)行它接剩。我們便可以使用緩存來解決切厘。
緩存默認置為True,我們不需要手動開啟它懊缺,但是某些情況下疫稿,我們希望同一個依賴項多次執(zhí)行,那么便可以手動置為False - 依賴項可以寫在裝飾器的dependencies參數中鹃两,例如:
@app.get("/items/", dependencies=[Depends(verify_token), Depends(verify_key)])
這代表著我們不需要這個依賴項的結果遗座,只需要其順利執(zhí)行。 - 依賴項中可以使用 yield 和 context俊扳,例如獲取數據庫session的依賴項途蒋,我們可能只需要其不斷產生session,而不是將整個函數重新執(zhí)行一次馋记,便可以用yield不斷為所有需求方提供yield号坡。而context可以幫我們更好的管理生成的依賴項
參考官方文檔:https://fastapi.tiangolo.com/zh/tutorial/dependencies/dependencies-with-yield/
下一篇 FastAPI 依賴注入詳解: 處理依賴樹 http://www.reibang.com/p/9685f6b7ca24