ASP.NET Core MVC 源碼學習：Routing 路由

前言

最近打算抽時間看一下 ASP.NET Core MVC 的源碼，特此把自己學習到的内容記錄下來，也算是做個筆記吧。

路由作為 MVC 的基本部分，是以在學習 MVC 的其他源碼之前還是先學習一下路由系統，ASP.NET Core 的路由系統相對于以前的 Mvc 變化很大，它重新整合了 Web Api 和 MVC。

路由源碼位址：https://github.com/aspnet/Routing

路由（Routing）功能介紹

路由是 MVC 的一個重要組成部分，它主要負責将接收到的 Http 請求映射到具體的一個路由處理程式上，在MVC 中也就是說路由到具體的某個 Controller 的 Action 上。

路由的啟動方式是在ASP.NET Core MVC 應用程式啟動的時候作為一個中間件來啟動的，詳細資訊會在下一篇的文章中給出。

通俗的來說就是，路由從請求的 URL 位址中提取資訊，然後根據這些資訊進行比對，進而映射到具體的處理程式上，是以路由是基于URL建構的一個中間件架構。

路由還有一個作用是生成響應的的URL，也就是說生成一個連結位址可以進行重定向或者連結。

路由中間件主要包含以下幾個部分：

URL 比對
URL 生成
IRouter 接口
路由模闆
模闆限制

Getting Started

ASP.NET Core Routing 主要分為兩個項目，分别是

Microsoft.AspNetCore.Routing.Abstractions

Microsoft.AspNetCore.Routing

。前者是一個路由提供各功能的抽象，後者是具體實作。

我們在閱讀源碼的過程中，我建議還是先大緻浏覽一下項目結構，然後找出關鍵類，再由入口程式進行閱讀。

Microsoft.AspNetCore.Routing.Abstractions

大緻看完整個結構之後，我可能發現了幾個關鍵的接口，了解了這幾個接口的作用後能夠幫助我們在後續的閱讀中事半功倍。

IRouter

在

Microsoft.AspNetCore.Routing.Abstractions

中有一個關鍵的接口就是

IRouter

public interface IRouter
{
    Task RouteAsync(RouteContext context);

    VirtualPathData GetVirtualPath(VirtualPathContext context);
}

這個接口主要幹兩件事情，第一件是根據路由上下文來進行路由處理，第二件是根據虛拟路徑上下文擷取

VirtualPathData

。

IRouteHandler

另外一個關鍵接口是

IRouteHandler

, 根據名字可以看出主要是對路由處理程式機型抽象以及定義的一個接口。

public interface IRouteHandler
{
    RequestDelegate GetRequestHandler(HttpContext httpContext, RouteData routeData);
}

它傳回一個

RequestDelegate

的一個委托，這個委托可能大家比較熟悉了，封裝了處理Http請求的方法，位于

Microsoft.AspNetCore.Http.Abstractions

中，看過我之前部落格的同學應該比較了解。

這個接口中

GetRequestHandler

方法有兩個參數，第一個是 HttpContext，就不多說了，主要是來看一下第二個參數

RouteData

。

RouteData

，封裝了目前路由中的資料資訊，它包含三個主要屬性，分别是

DataTokens

Routers

Values

。

DataTokens

：是比對的路徑中附帶的一些相關屬性的鍵值對字典。

Routers

：是一個

Ilist<IRouter>

清單，說明RouteData 中可能會包含子路由。

Values

：目前路由的路徑下包含的鍵值。

還有一個

RouteValueDictionary

, 它是一個集合類，主要是用來存放路由中的一些資料資訊的，沒有直接使用

IEnumerable<KeyValuePair<string, string>>

這個資料結構是應為它的内部存儲轉換比較複雜，它的構造函數接收一個 Object 的對象，它會嘗試将Object 對象轉化為自己可以識别的集合。

IRoutingFeature

我根據這個接口的命名一眼就看出來了這個接口的用途，還記得我在之前部落格中講述Http管道流程中得時候提到過一個叫工具箱的東西麼，這個

IRoutingFeature

也是其中的一個組成部分。我們看一下它的定義：

public interface IRoutingFeature
{
    RouteData RouteData { get; set; }
}

原來他隻是包裝了

RouteData

，到 HttpContext 中啊。

IRouteConstraint

這個接口我在閱讀的時候看了一下注釋，原來路由中的參數參數檢查主要是靠這個接口來完成的。

我們都知道在我們寫一個 Route Url位址表達式的時候，有時候會這樣寫：

Route("/Product/{ProductId:long}")

, 在這個表達式中有一個

{ProductId:long}

的參數限制，那麼它的主要功能實作就是靠這個接口來完成的。

/// Defines the contract that a class must implement in order to check whether a URL parameter
/// value is valid for a constraint.
public interface IRouteConstraint
{
    bool Match(
        HttpContext httpContext,
        IRouter route,
        string routeKey,
        RouteValueDictionary values,
        RouteDirection routeDirection);
}

Microsoft.AspNetCore.Routing

Microsoft.AspNetCore.Routing

主要是對

Abstractions

的一個主要實作，我們閱讀代碼的時候可以從它的入口開始閱讀。

RoutingServiceCollectionExtensions

是一個擴充ASP.NET Core DI 的一個擴充類，在這個方法中用來進行 ConfigService，Routing 對外暴露了一個 IRoutingBuilder 接口用來讓使用者添加自己的路由規則，我們來看一下：

public static IApplicationBuilder UseRouter(this IApplicationBuilder builder, Action<IRouteBuilder> action)
{
    //...略
    
    // 構造一個RouterBuilder 提供給action委托宮配置
    var routeBuilder = new RouteBuilder(builder);
    action(routeBuilder);
    
    //調用下面的一個擴充方法，routeBuilder.Build() 見下文
    return builder.UseRouter(routeBuilder.Build());
}

public static IApplicationBuilder UseRouter(this IApplicationBuilder builder, IRouter router)
{
     //...略
     
    return builder.UseMiddleware<RouterMiddleware>(router);
}

routeBuilder.Build()

建構了一個集合

RouteCollection

，用來儲存所有的

IRouter

處理程式資訊，包括使用者配置的Router。

RouteCollection

本身也實作了

IRouter

, 是以它也具有路由處理的能力。

Routing 中間件的入口是

RouterMiddleware

這個類，通過這個中間件注冊到 Http 的管道處理流程中， ASP.NET Core MVC 會把它預設的作為其配置項的一部分，當然你也可以把Routing單獨拿出來使用。

我們來看一下

Invoke

方法裡面做了什麼，它位于

RouterMiddleware.cs

檔案中。

public async Task Invoke(HttpContext httpContext)
{
    var context = new RouteContext(httpContext);
    context.RouteData.Routers.Add(_router);

    await _router.RouteAsync(context);

    if (context.Handler == null)
    {
        _logger.RequestDidNotMatchRoutes();
        await _next.Invoke(httpContext);
    }
    else
    {
        httpContext.Features[typeof(IRoutingFeature)] = new RoutingFeature()
        {
            RouteData = context.RouteData,
        };

        await context.Handler(context.HttpContext);
    }
}

首先，通過 httpContext 來初始化路由上下文（RouteContext），然後把使用者配置的路由規則添加到路由上下文RouteData中的Routers中去。

接下來

await _router.RouteAsync(context)

, 就是用到了

IRouter

接口中的

RouteAsync

方法了。

我們接着跟蹤

RouteAsync

這個函數，看其内部都做了什麼？我們又跟蹤到了

RouteCollection.cs

這個類：

我們看一下 RouteAsync 的流程：

public async virtual Task RouteAsync(RouteContext context)
{
    var snapshot = context.RouteData.PushState(null, values: null, dataTokens: null);

    for (var i = ; i < Count; i++)
    {
        var route = this[i];
        context.RouteData.Routers.Add(route);

        try
        {
            await route.RouteAsync(context);

            if (context.Handler != null)
            {
                break;
            }
        }
        finally
        {
            if (context.Handler == null)
            {
                snapshot.Restore();
            }
        }
    }
}

我覺得這個類，包括函數設計的很巧妙，如果是我的話，我不一定能夠想的出來，是以我們通過看源碼也能夠學到很多新知識。

為什麼說設計的巧妙呢？

RouteCollection

繼承了 IRouter 但是并沒有具體的對路由進行處理，而是通過循環來重新将路由上下文分發的具體的路由處理程式上。我們來看一下他的流程：

1、為了提高性能，建立了一個RouteDataSnapshot 快照對象，RouteDataSnapshot是一個結構體，它存儲了 Route 中的路由資料資訊。

2、循環目前 RouteCollection 中的 Router，添加到 RouterContext裡的Routers中，然後把RouterContext交給Router來處理。

3、當沒有處理程式處理目前路由

snapshot.Restore()

重新初始化快照狀态。

接下來就要看具體的路由處理對象了，我們從

RouteBase

開始。

1、RouteBase 的構造函數會初始化

RouteTemplate

Name

DataTokens

Defaults

Defaults 是預設配置的路由參數。

2、

RouteAsync

中會進行一系列檢查，如果沒有比對到URL對應的路由就會直接傳回。

3、使用路由參數比對器

RouteConstraintMatcher

進行比對，如果沒有比對到，同樣直接傳回。

4、如果比對成功，會觸發

OnRouteMatched(RouteContext context)

函數，它是一個抽象函數，具體實作位于

Route.cs

中。

然後，我們再繼續跟蹤到

Route.cs

中的 OnRouteMatch，一起來看一下：

protected override Task OnRouteMatched(RouteContext context)
{
    
    context.RouteData.Routers.Add(_target);
    return _target.RouteAsync(context);
}

_target 值得目前路由的處理程式，那麼具體是哪個路由處理程式呢？我們一起探索一下。

我們知道，我們建立路由一共有

MapRoute

MapGet

MapPost

MapPut

MapDelete

MapVerb

... 等等這寫方式，我們分别對應說一下每一種它的路由處理程式是怎麼樣的，下面是一個示例：

app.UseRouter(routes =>{
    routes.DefaultHandler = new RouteHandler((httpContext) =>
    {
        var request = httpContext.Request;
        return httpContext.Response.WriteAsync($"");
    });
                    
    routes
    .MapGet("api/get/{id}", (request, response, routeData) => {})
    .MapMiddlewareRoute("api/middleware", (appBuilder) => 
                         appBuilder.Use((httpContext, next) => httpContext.Response.WriteAsync("Middleware!")
                      ))
    .MapRoute(
          name: "AllVerbs",
          template: "api/all/{name}/{lastName?}",
          defaults: new { lastName = "Doe" },
          constraints: new { lastName = new RegexRouteConstraint(new Regex("[a-zA-Z]{3}",RegexOptions.CultureInvariant, RegexMatchTimeout)) });
});

按照上面的示例解釋一下，

MapRoute

：使用這種方式的話，必須要給 DefaultHandler 指派處理程式，否則會抛出異常，通常情況下我們會使用RouteHandler類。

MapVerb

： MapPost,MapPut 等等都和它類似，它将處理程式作為一個 RequestDelegate 委托提供了出來，也就是說我們實際上在自己處理HttpContext的東西，不會經過RouteHandler處理。

MapMiddlewareRoute

：需要傳入一個 IApplicationBuilder 委托，實際上 IApplicationBuilder Build之後也是一個 RequestDelegate，它會在内部 new 一個 RouteHandler 類，然後調用的 MapRoute。

這些所有的矛頭都指向了 RouteHandler ，我們來看看

RouteHandler

吧。

public class RouteHandler : IRouteHandler, IRouter
{
    // ...略

    public Task RouteAsync(RouteContext context)
    {
        context.Handler = _requestDelegate;
        return TaskCache.CompletedTask;
    }
}

什麼都沒幹，僅僅是将傳入進來的 RequestDelegate 指派給了 RouteContext 的處理程式。

最後，代碼會執行到

RouterMiddleware

類中的

Invoke

方法的最後一行

await context.Handler(context.HttpContext)

，這個時候開始調用Handler委托，執行使用者代碼。

總結

我們來總結一下以上流程：

首先傳入請求會到注冊的 RouterMiddleware 中間件，然後它 RouteAsync 按順序調用每個路由上的方法。當一個請求到來的時候，IRouter執行個體選擇是否處理已經設定到

RouteContext

Handler

上的一個非空 RequestDelegate。如果Route已經為該請求設定處理程式，則路由處理會中止并且開始調用設定的Hanlder處理程式以處理請求。如果目前請求嘗試了所有路由都沒有找到處理程式的話，則調用next，将請求交給管道中的下一個中間件。

關于路由模闆和參數限制源碼處理流程就不一一說了，有興趣可以直接看下源碼。

ASP.NET Core MVC 源碼學習：Routing 路由

前言

路由（Routing）功能介紹

Getting Started

Microsoft.AspNetCore.Routing.Abstractions

Microsoft.AspNetCore.Routing

總結

繼續閱讀

mysql和c#在類型轉換的問題An unhandled exception occurred while processing the request.

Method MethodName is not supported on this proxy

asp.net core Swagger JWT

Castle動态代理攔截器可跟蹤模型更改和觸發規則介紹總結

IdentityServer4（四）

asp.net core源代碼下載下傳與運作

ASP.NET CORE API 部署到IIS 上HTTP錯誤 500.19-Internal Server Error 錯誤代碼：0x8007000d

Cake Frosting：更具可維護性的C＃DevOps什麼是Frosting？入門适應Frosting别名目錄/檔案插件和工具概括

.Net Core平台下實作SignalR用戶端和服務端

ASP.NET Core 中建立 gRPC 用戶端和伺服器

ASP.NET Core SignalR.NET 用戶端

AutoWrapper：通過有意義的響應來美化您的ASP.NET Core API介紹預設的ASP.NET Core API響應AutoWrapper.Core的救援TL，DR 給我看代碼定義自己的自定義消息定義自己的Api異常選項支援日志支援Swagger總結參考文獻

使用Entity Framework和Web API的ASP.NET Core Blazor CRUD介紹背景使用代碼

ASP.NET Core MVC(一)

建立ASP.NET CORE MVC項目