.NET Core中間件的注冊和管道的構建(1)---- 注冊和構建原理
0x00 問題的產生
管道是.NET Core中非常關鍵的一個概念,很多重要的組件都以中間件的形式存在,包括權限管理、會話管理、路由等。所以搞明白中間件是如何注冊並最終構建成管道的很重要。園子里很多先驅早已經開始了這方面的研究學習,也寫了很多文章,不過我看了后有些地方還不是特別明白。畢竟每個人都是不同的,有些內容作者覺得是常識不需要多寫的地方對我來說可能就是個盲區。幸好.NET Core整個項目都是開源的,找到源碼看了下解決了我心中的困惑。同時寫篇博客記錄一下,也算一個補充,如果大家看了能有所收獲那就更好了。本來是想一片文章寫完的,后來發現太長了,所以分了兩篇。這是第一篇,主要說一下中間件的注冊和管道的構建原理,后面一篇寫一下注冊中間件類的原理和寫中間件類需要注意的約定和特性。
0x01 中間件的注冊
管道的構建主要包含中間件注冊和把注冊的中間件構建成管道。先來說中間件的注冊。
什么是中間件。說簡單一點中間件就是一個方法,傳入一個HttpContext類型參數,返回Task。參數HttpContext中包含了HTTP請求和響應等相關信息,中間件可以讀取/修改其中的部分內容,並決定是否讓下一個中間件繼續處理這個HttpContext。這個方法包裝為一個委托RequestDelegate。

為了讓中間件有權決定是否讓下一個中間件繼續處理HttpContext,當前中間件需要下一個中間件的引用。所以在注冊中間件的時候需要注冊為Func<RequestDelegate,RequestDelegate>的形式,其中傳入的參數指的是下一個中間件,返回的是我們注冊的中間件,傳入的參數在ApplicationBuilder在執行Build()方法構建管道時傳入(后面會看到)。所以為了方便理解,不那么嚴謹的來看,中間件以Func<NextMiddleware,ThisMiddleware>的形式注冊並存儲在一個列表中。

可以通過ApplicationBuilder的Use方法注冊中間件

0x02 管道的構建
管道的構建就是把Func<RequestDelegate,RequestDelegate>列表串在一起。用第一個Func的返回值作為第二個Func的參數,第二個Func的返回值作為第三個Func的參數,依次類推。最終返回最后一個Func返回的RequestDelegate(中間件)。管道工作時最后一個RequestDelegate可以決定是否調用倒數第二個RequestDelegate,倒數第二個RequestDelegate可以決定是否調用倒數第三個RequestDelegate,依次類推直到調用第一個RequestDelegate。這中間有兩個問題:
第一個是這樣構建管道,中間件的順序和注冊的時候是相反的,所以在構件時首先把列表_components.Reverse()以保證正確的中間件順序。
第二個問題是構建第一個中間件時沒有RequestDelegate可以傳入,所以需要構建一個把狀態碼設置為404的中間件作為最開始的RequestDelegate傳入。當然在構建完成后這個中間件是存在於管道最末端的。這樣管道構建就算完成了。Build()代碼如下:

0x03 測試
構建完成后的管道和中間件如下圖:

這是微軟官方的圖,很多文章中也引用過。從這張圖中可以看出來中間件通過調用next()啟動下一個中間件。如果中間件不調用next()那么它之后的所有中間件就都不會調用了。除此之外還有一個細節需要注意,就是next()的調用並不是必須要放到最后的。也就是說可以先調用后面的中間件,等后面的中間件調用完成后在執行一些操作(圖中的more logic)。
下面來分別進行測試,正常建立一個.NET Core MVC Web項目。
測試1:注釋掉Configure()中的所有內容,然后依次注冊中間件:

運行后結果為:

這個測試印證了之前代碼中看到的中間件的注冊順序就是調用順序。
測試2:注釋掉Middleware1的next調用,其它保持不變。這樣Middleware1就不會調用Middleware2,Middleware2以及之后的所有中間件都無法調用。

運行結果變為:

這個測試說明Middleware1不調用next()的話后面的Middleware2和Middleware3都沒有被調用。
測試3:把Configure()方法修改如下:

我們在最開始注冊一個中間件記錄當前時間,然后調用后面所有中間件,最后返回時計算后面所有中間件執行所消耗的時間。為了看上去更明顯后面又注冊了一個中間件強制睡眠100毫秒。需要注意的是強制睡眠的中間件要注冊在MVC之前,因為MVC結束后就直接返回了,不會調用后面的中間件了。
運行結果為:

這個測試說明對下一個中間件的調用不一定非要放到最后,可以先調用后面中間件,等后面所有中間件調用完成后再繼續處理。
0x04 寫在最后
這篇文章主要討論了中間件的注冊和管道構建的一些原理,實際上對於復雜一點的中間件來說,一般都有更復雜的邏輯並對其它組件依賴。下一篇將討論把中間件寫成一個類並注入依賴的方法和原理。
此外這篇文章主要是我個人的一些理解和直覺。。。好吧真的有些是直覺,能力有限,博客園大牛眾多,有錯誤的地方大家嘴下留情啊。
0x05 相關文章
.NET Core中間件的注冊和管道的構建(1)---- 注冊和構建原理
.NET Core中間件的注冊和管道的構建(2)---- 用UseMiddleware擴展方法注冊中間件類
.NET Core中間件的注冊和管道的構建(3) ---- 使用Map/MapWhen擴展方法
