Web Api源碼(路由註冊)

来源:https://www.cnblogs.com/yuxl01/archive/2022/05/14/16271351.html
-Advertisement-
Play Games

這篇文章只是我學習Web API框架的輸出,學習方法還是輸出倒逼輸入比較行得通,所以不管寫的好不好,堅持下去,肯定有收穫。篇幅比較長,仔細思考閱讀下來大約需要幾分鐘。 做.NET開發有好幾年時間了,從很久之前的WebForm到MVC,再到目前前後端分離模式下RESTful風格的 Web API ,相 ...


這篇文章只是我學習Web API框架的輸出,學習方法還是輸出倒逼輸入比較行得通,所以不管寫的好不好,堅持下去,肯定有收穫。篇幅比較長,仔細思考閱讀下來大約需要幾分鐘。

做.NET開發有好幾年時間了,從很久之前的WebFormMVC,再到目前前後端分離模式下RESTful風格的 Web API ,相信這些Web框架很多人都或多或少的用過,也算見證了NET Web端的某一階段的發展吧,同時很多技術隨著發展和迭代,以及前後端分離模式的普及和興起,用的機會少了,難免可能覺得已經過時了,同時現在流行的Web框架太多太多,不局限於.Net,同樣也很優秀,例如:

Java的Spring | Hibernate

Python的Django | Flask

Node的Express和Koa

其實最重要的不是用了多少,知道多少,而是有多少沉澱,在使用領域雖然可能存在過時了,但是從技術的角度,框架設計的思想代碼風格技術點的使用把控甚至變數聲明等等,都值得我們去學習。

分享方式

  1. Web API 路由註冊路由處理通過閱讀源代碼以及邊說明的的方式來闡述。
  2. Web API 管道組裝和擴展雖然我們在閱讀源碼時會接觸到它,但我仍然會用Demo的方式來說明它.
  3. Web API 管道組裝和擴展我覺得它設計的真的很棒,忍不住要單獨拎出來說一下,雖然有可能把自己講懵,但我仍然想嘗試一下。

1. Web API 路由簡介
1.基本介紹

一個ASP.NET的Web應用具有一個全局的路由表,它是通過一個RouteTable類中的一個類型為RouteCollectionRoutes靜態屬性來表示的。

為什麼這麼說呢?或許這樣說不太好理解,用一個簡單的例子來說明,我們修改Api框架啟動時,註冊路由的方式,改為直接用 RouteTable.Routes來添加,這種做法跟框架提供的是一樣的,最終都是將路由添加到一個地方。

在針對於路由表這一點上面不僅僅只有WebAPI是這麼做的,他同樣適用於WebFormMVC 同樣可以直接在應用程式啟動時網路由表中直接添加數據,不過此處只為了證實上述描述,在日常開發中是否可以這樣用,完全取決於你自己。

1.框架提供的

public static void Register(HttpConfiguration config)
{
     // Web API 框架提供的路由
     config.Routes.MapHttpRoute(
         name: "DefaultApi",
         routeTemplate: "api/{controller}/{Action}/{id}",
         defaults: new { id = RouteParameter.Optional }
     );
}

2.通過直接路由表添加

 //在WebApiConfig.Register中修改註冊路由.
 public static void Register(HttpConfiguration config)
 {
     //驗證路由是否加到全局路由表
     var ro = new { id = RouteParameter.Optional };
     //獲取預設WebAPI路由處理器
     IRouteHandler routeHandler = HttpControllerRouteHandler.Instance;
     RouteValueDictionary defaults = new RouteValueDictionary(ro);
     Route route = new Route("api/{controller}/{Action}/{id}", defaults, routeHandler);
     RouteTable.Routes.Add("DefaultApi", route);
 }
2.思考的問題

1.我們思考RouteCollection為什麼是靜態的?

因為靜態對象會一直存在記憶體中,直到程式池下一次回收之前.`

2.我們在用WebAPI開發應用介面的時候,前端Url請求是怎麼通過路由到達我們對應的控制器和Action的?

其實是根據路由來控制的,至於怎麼控制,怎麼實現,後面會慢慢介紹.

3.路由控制如何路由呢?

1.先註冊路由,再將路由和處理器綁定。

2.然後用戶請求根據請求的Url 匹配對應的處理器,再由處理器進行路由模板規則解析。

3.根據解析到的規則反射找到Contrller和Action。

2. Web API 路由註冊

路由註冊這一部分在MVC5之後就有2部分了,新增了一個特性路由,此次不做分享,後續有機會再補上..我們看下簡單的路由註冊圖,當然其中還有很多東西,只是畫的比較簡陋,

上面的所表示的流程中,我們作為使用框架的開發人員,關註的只是其中一小部分,從代碼角度能看到,就只有如下很簡單的幾句代碼,並且連這個代碼都是框架生成的,從另一個角度也說明框架的封裝比較完整和強大,讓開發人員只關註自己的業務就行了

註冊路由流程部分

1.註冊方式

1.在Web Api程式啟動時,首先調用GlobalConfiguration.Configure(WebApiConfig.Register)方法,這個方法接收的參數是一個Action<HttpConfiguration> 作為參數,看到Action我們的第一反應就是作為回調執行, 框架給我們預留了擴展空間,用戶擴展的內容在內部執行

2.說白了GlobalConfiguration.Configure()方法的參數,需要一個委托,而委托的本質就是一個無返回值,包含HttpConfiguration類型的實例作為參數的方法,我們轉到框架定義的WebApiConfig.Register()方法,毫無疑問它符合要求,所以這個方法就是在框架中被GlobalConfiguration.Configure() 執行的回調,而這個回調的作用就是註冊路由

註冊路由作為框架GlobalConfiguration.Configure的回調,與上圖中相等

2.GlobalConfiguration

我們發現更多的信息在GlobalConfiguration類中,繼續一步步解讀,打開源碼找到GlobalConfiguration這個類來看

1.它是個靜態類包含一個重要的方法Configure(Action configurationCallback)

2.它包含3個重要的靜態屬性ConfigurationDefaultHandlerDefaultServer

3.三個屬性被調用時就已經初始化了,但被Lazy類型包裹,說明是被延遲執行,具體延遲執行的時機就是調用它的Value屬性時。

4.目前在路由註冊階段只介紹Configuration,剩下2個在路由解析部分在分享.

1.我們首先看GlobalConfiguration.Configure(Action configurationCallback) 的內部做了2件事,執行我們擴展的回調,也就是註冊路由的業務,然後檢查初始化HttpConfiguration

執行回調需要的參數,正是第一個屬性Configuration 通過該類型的Routes屬性的MapHttpRoute擴展方法來往路由表中添加數據。可以知道我們只要搞清楚了HttpConfiguration類型的Configuration的來源,就能搞清楚很多事情。

我們找到HttpConfiguration類型的Configuration是怎麼初始化的,先展開它,查看代碼看到他是由內部的CreateConfiguration()方法創建的

3.註冊流程步驟

1.在CreateConfiguration()HttpConfiguration被構造時我們經過查看上下文發現

1.傳入一個HostedHttpRouteCollection對象,併在內部賦值給HttpRouteCollection類型的_routes屬性

2.HostedHttpRouteCollection在構造時,傳入了我們的全局路由表RouteTable.Routes

2.我們找到映射路由的擴展方法MapHttpRoute可以知道我們調用它的Route屬性是一個HostedHttpRouteCollection也就是說,在MapHttpRouteCreateRoute()是由HostedHttpRouteCollection來調用的

3.繼續轉到HostedHttpRouteCollection類中的CreateRoute()內部看到它返回一個HostedHttpRoute而它就是實現IHttpRoute的實例。

4.繼續深入在HostedHttpRoute構造時,內部有一個Route類型的OriginalRoute屬性,它被賦值為繼承自(Route:RouteBase)HttpWebRoute類型。

5.在HttpWebRoute初始構造時傳入了幾個極為重要的參數路由模板IRouteHandler類型HttpControllerRouteHandler以及一個IHttpRoute類型的HostedHttpRoute,然後程式返回,註意此處的IRouteHandler可以理解為是路由的處理器.最終在HostedHttpRouteCollection對象上調用routes.Add(name, route)添加 路由模板名字處理程式.

4.總結

現在我們對Web Api中的路由註冊部分已經做了一個簡單的介紹,並且一步一步理解了源碼實現的邏輯,其實說到本質,路由註冊只做了一件事,就是將路由模板規則和路由處理器提前綁定,客戶端按照對應的規則請求來匹配對應的路由處理器做最終的處理,而目前框架內置的路由處理器就是一個HttpControllerRouteHandler,後面部分進入路由處理,如果在閱讀過程中有任何疑問歡迎隨時和我討論, 強烈建議在閱讀本篇分享建立了粗略的知識點之後,有時間的話自己先下載Web Api源碼進行閱讀,這樣可以幫助更好的理解。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • #類型轉換 由於java是強類型語言,所以在進行某些運算的時候,需要用到類型轉換。 低-->高指的是位元組大小,從小到大。 小數的優先順序大於整數 數值進行類型轉換時不要讓數據溢出 由低到高可以直接轉換,無需額外代碼。 註意點: 1 不能對布爾值進行轉換 2 不能把對象類型轉換為不相干的類型 3 在把高 ...
  • 開發環境: SpringBoot: 2.6.5 SpringCloud: 2021.0.0 SpringCloudAlibaba: 2021.0.1.0 Nacos: 2.1.0 代碼: @Slf4j @Component public class MyInMemoryRouteDefinition ...
  • 一、分頁查詢(引用了element框架) 思路: Sql語句:select * from <表名> limit <從第幾條開始查詢>,<查詢多少條數據> 例子:select * from user limit 2,10; 前端:傳遞兩個數據給後端:begin,size 但是我們分頁查詢的頁面肯定不會 ...
  • 多線程筆記(三) 1. 同步容器與併發容器 同步容器 通過synchronized關鍵字實現線程安全的容器;或通過Collections這個工具類的synchronizedXXX方法創建的容器,都稱為同步容器 例如Vector, Stack, Hashtable Vector是list介面的線程安全 ...
  • 一、協調生產/消費的需求 本文內容主要想向大家介紹一下Lock結合Condition的使用方法,為了更好的理解Lock鎖與Condition鎖信號,我們來手寫一個ArrayBlockingQueue。 JDK實際上已經有這個類,基於Lock鎖與Condition鎖信號實現的,當然JDK實現代碼很複雜 ...
  • 目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • pip是個安裝包的軟體,conda是個環境管理的工具。conda能夠安裝多個python解釋器,pip不行。conda install這種方式安裝的庫都會放在/Users/orion-orion/miniforge3/pkgs目錄下。這樣的好處是,當在某個環境下已經下載好了某個庫,再在另一個環境中還... ...
  • 閱讀目錄 效果展示 準備 簡單說明 + 源碼 結尾(視頻及源碼倉庫) 1. 效果展示 欣賞效果: 2. 準備 創建一個WPF工程,比如站長使用 .NET 7 創建名為 WalletPayment 的WPF項目。 這次我們不添加任何圖片,只添加了一個Nuget包 MaterialDesignTheme ...
一周排行
    -Advertisement-
    Play Games
  • 分組和樹形結構是不一樣的。 樹形結構是以遞歸形式存在。分組是以鍵值對存在的形式,類似於GroupBy這樣的形式。 舉個例子 ID NAME SEX Class 1 張三 男 1 2 李四 女 2 3 王二 男 1 當以Sex為分組依據時則是 Key Value 男 1 張三 男 1 3 王二 男 1 ...
  • NetCore中將SQLServer資料庫備份為Sql腳本 描述: 最近寫項目收到了一個需求, 就是將SQL Server資料庫備份為Sql腳本, 如果是My Sql之類的還好說, 但是在網上搜了一大堆, 全是教你怎麼操作SSMS的, 就很d疼! 解決方案: 通過各種查找資料, 還有一些老哥的幫助, ...
  • 我的Notion Clowd.Squirrel Squirrel.Windows 是一組工具和適用於.Net的庫,用於管理 Desktop Windows 應用程式的安裝和更新。 Squirrel.Windows 對 Windows 應用程式的實現語言沒有任何要求,甚至無需服務端即可完成增量更新。 ...
  • 轉載請註明來源 https://www.cnblogs.com/brucejiao/p/16188865.html 謝謝! 轉載請註明來源 https://www.cnblogs.com/brucejiao/p/16188865.html 謝謝! 轉載請註明來源 https://www.cnblog ...
  • 1. Netty源碼研究筆記(3)——Channel系列 依舊是通過先縱向再橫向的研究方法,在開篇中,我們發現不管是Sever還是Client,最終的啟動是通過調用channel的對應方法來完成的,而這個動作實際在channel綁定的eventLoop中執行。 接下來,我們繼續EchoSever、E ...
  • 大家好,今天給大家介紹一款輕量、快速、穩定可編排的組件式規則引擎框架LiteFlow。 一、LiteFlow的介紹 LiteFlow官方網站和代碼倉庫地址 官方網站:https://yomahub.com/liteflow Gitee托管倉庫:https://gitee.com/dromara/li ...
  • 我使用Spring AOP實現了用戶操作日誌功能 今天答辯完了,復盤了一下系統,發現還是有一些東西值得拿出來和大家分享一下。 需求分析 系統需要對用戶的操作進行記錄,方便未來溯源 首先想到的就是在每個方法中,去實現記錄的邏輯,但是這樣做肯定是不現實的,首先工作量大,其次違背了軟體工程設計原則(開閉原 ...
  • 《零基礎學Java》 繪製幾何圖形 Java可以分別使用 Graphics 和 Graphics2D 繪製圖形,Graphics類 使用不同的方法繪製不同的圖形(drawLine()方法可f以繪製線、drawRect()方法用於繪製矩形、drawOval()方法用於繪製橢圓形)。 Graphics類 ...
  • 本期教程人臉識別第三方平臺為虹軟科技,本文章講解的是人臉識別RGB活體追蹤技術,免費的功能很多可以自行搭配,希望在你看完本章課程有所收穫。 ...
  • 很多人都喜歡使用黑色的主題樣式,包括我自己,使用了差不多三年的黑色主題,但是個人覺得在進行視窗轉換的時候很廢眼睛。 比如IDEA是全黑的,然後需要看PDF或者WORD又變成白色的了,這樣來回切換導致眼睛很累,畢竟現在網頁以及大部分軟體的界面都是白色的。那麼還是老老實實的使用原來比較順眼的模式吧。 1 ...