好文分享 — Building Custom Middleware in FastAPI

Middleware (或稱中間層、中介層)是 Web 框架很常見的設計模式,包含 FastAPI, Django, Express 等都有提供 middleware 的功能,而且實務上後端工程師也經常會接觸到 middleware, 諸如 Session 驗證、 CSRF token 驗證/產生、 Gzip 壓縮 response payload 等等,這些都是很適合在 middleware 中解決的需求,因為只要在 middleware 中實作好之後,其他 API endpoints 都不用再額外實作一遍,提高程式碼的再利用率之外,也降低重複程式碼的情況。

Middleware 的實際運作就像一層一層的洋蔥,要求(request)進到 middleware 之後,會先交由第 1 層 middleware 處理,這時 middleware 可以自由對要求(request)做加工或修改,例如查詢要求 IP 位址來自哪個地理位置,並把相關資訊額外加到 request 資料之中,再交由第 2 層的 middleware 處理,以此類推,接著進到 API endpoint 做商業邏輯處理(例如成立訂單、結帳等工作),再將回應(response)傳給使用者之前,同樣會進入 middleware 進行處理, middleware 同樣可以對回應(response)做加工或修改,此時 middleware 的執行順序會以相反順序執行,例如原本要求(request)是經由 A, B, C 3 層 middleware, 那麼回應(response)就會是 C, B, A 的次序執行:

request -> A -> B -> C -> API endpoint -> C -> B -> A -> response

另外,由於 middleware 就處於 request 與 response 的必經路徑之上,所以在開發/使用 middleware 時要特別小心,因為只要其中 1 個環節壞掉,基本保證所有 APIs 都會故障,所以 middleware 基本上都應該要寫測試,而且盡可能地處理各種例外情況,避免影響服務的穩定性。

“Building Custom Middleware in FastAPI” 1 文就以 FastAPI 為例,教大家如何客製化 middleware 之外,還教導如何用 Pytest 與 FastAPI 內建的 TestClient 進行測試,更於文末提供最佳實務見解,相當適合對 middleware 不熟的人閱讀!

Building Custom Middleware in FastAPI

FOLLOW US

對抗久坐職業傷害

研究指出每天增加 2 小時坐著的時間,會增加大腸癌、心臟疾病、肺癌的風險,也造成肩頸、腰背疼痛等常見問題。

然而對抗這些問題,卻只需要工作時定期休息跟伸展身體即可!

你想輕鬆改變現狀嗎?試試看我們的 PomodoRoll 番茄鐘吧! PomodoRoll 番茄鐘會根據你所設定的專注時間,定期建議你 1 項辦公族適用的伸展運動,幫助你打敗久坐所帶來的傷害!

贊助我們的創作

看完這篇文章了嗎? 休息一下,喝杯咖啡吧!

如果你覺得 MyApollo 有讓你獲得實用的資訊,希望能看到更多的技術分享,邀請你贊助我們一杯咖啡,讓我們有更多的動力與精力繼續提供高品質的文章,感謝你的支持!