Web Api原始碼(路由注冊)-有解無憂

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

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

Java的Spring | Hibernate

Python的Django | Flask

Node的Express和Koa

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

分享方式

Web API 路由注冊和路由處理通過閱讀源代碼以及邊說明的的方式來闡述，

Web API 管道組裝和擴展雖然我們在閱讀原始碼時會接觸到它，但我仍然會用Demo的方式來說明它.

Web API 管道組裝和擴展我覺得它設計的真的很棒，忍不住要單獨拎出來說一下,雖然有可能把自己講懵,但我仍然想嘗試一下，

1. Web API 路由簡介

1.基本介紹

一個ASP.NET的Web應用具有一個全域的路由表,它是通過一個RouteTable類中的一個型別為RouteCollection的Routes靜態屬性來表示的，

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

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

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個重要的靜態屬性Configuration、DefaultHandler、DefaultServer

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也就是說,在MapHttpRoute中CreateRoute()是由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原始碼進行閱讀,這樣可以幫助更好的理解，

轉載請註明出處，本文鏈接：https://www.uj5u.com/net/474554.html

標籤：.NET技术

上一篇：如何加快我的SUPERSLOW搜索腳本

下一篇：WPF|黑暗模式的錢包支付儀表盤界面設計