Endpoint路由

在ASP.NET Core 2.2中，新增了一種路由，叫做 Endpoint （終結(jié)點）路由。本文將以往的路由系統(tǒng)稱為 傳統(tǒng)路由 。

本文通過源碼的方式介紹傳統(tǒng)路由和 Endpoint 路由部分核心功能和實現(xiàn)方法，具體功能上的差異見 官方文檔 。

在升級到ASP.NET Core 2.2后，會自動啟用 Endpoint 路由。如果要恢復(fù)以往的實現(xiàn)邏輯，需要加入以下代碼：

services.AddMvc(options => options.EnableEndpointRouting = false)
  .SetCompatibilityVersion(CompatibilityVersion.Version_2_2);

本文分析的源代碼基于ASP.NET Core 2.2.3版本的 源代碼 。

Endpoint作用

Endpoint 路由與傳統(tǒng)路由的區(qū)別在于，傳統(tǒng)路由 Url 與 Action 對應(yīng)關(guān)系的處理是在 UseMvc 中做的。我們無法根據(jù) Url 獲取對應(yīng)的 Action 然后進行處理。

Endpoint 就是將 Url 與 Action 的映射關(guān)系從 Mvc 中拆離，作為獨立使用的中間件。

由此帶來的好處是我們可以在其他的中間件中使用 Controller 和 Action 上的一些信息，例如 Attruibute 。

框架也提供了 LinkGenerator 類來直接根據(jù) Endpoint 生成鏈接，不再需要 HttpContext 的信息。

另外也提升了一些RPS(Requests per Second)。

不過目前 Endpoint 依然是在 UseMvc 中調(diào)用，更多開放的使用方式會在ASP.NET Core 3.0中實現(xiàn)。

啟用Endpoint路由

源代碼見 Github 。也可以獲取源代碼到本地看。

在 MvcApplicationBuilderExtensions.cs 文件72行的 UseMvc 方法中我們可以看到以下代碼：

var options = app.ApplicationServices.GetRequiredService<IOptions<MvcOptions>>();

if (options.Value.EnableEndpointRouting)
{
  ...
}
else
{
  ...
}

if 之中是 Endpoint 路由的邏輯， else 是傳統(tǒng)路由的邏輯。

而 MvcOptions 的構(gòu)造方法如下所示， EnableEndpointRouting 是通過 CompatibilitySwitch 來控制默認(rèn)值的，這就是 CompatibilityVersion.Version_2_2 啟用 Endpoint 路由的原因。

public MvcOptions()
{
  // ...
  _enableEndpointRouting = new CompatibilitySwitch<bool>(nameof(EnableEndpointRouting));
  // ...
}

Endpoint路由實現(xiàn)原理

在 MvcApplicationBuilderExtensions.cs 文件的92-123行的代碼是將所有的 Controller 中的 Action 轉(zhuǎn)換成 Endpoint 。

在129行的 UseEndpointRouting 中，添加了一個 EndpointRoutingMiddleware 的中間件，這個中間件就是從所有的 Endpoint 中找到當(dāng)前路由對應(yīng)的 Endpoint ，然后放到 Feature 集合中。

在132行的 UseEndpoint 中，添加了一個 EndpointMiddleware 中間件，這個中間件是將 EndpointRoutingMiddleware 中找到的 Endpoint 取出，根據(jù)其中的 MetaData 信息，找到對應(yīng)的 Controller 和 Action ，并調(diào)用。

在 UseMvc 方法里， UseEndpointRouting 和 UseEndpoint 是連續(xù)的兩個中間件，而 UseEndpoint 是請求的結(jié)束，這意味著我們自定義的中間件無法取得 Endpoint 信息。

但是通過手動調(diào)用 UseEndpoint ，我們還是可以拿到 Endpoint 路由信息的。

使用示例

下面展示一個使用示例。

定義一個 LogAttribute 類，并包含一個 Message 屬性，在 Action 上聲明使用。

定義一個 EndpointTestMiddleware 中間件，輸出 LogAttribute 的 Message 屬性。

手動調(diào)用 UseEndpointRouting ，然后調(diào)用我們定義的 EndpointTestMiddleware 中間件。

// Startup.cs
public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
  app.UseEndpointRouting();

  app.UseMiddleware<EndpointTestMiddleware>();

  app.UseMvc(routes =>
  {
    routes.MapRoute(
      name: "default",
      template: "{controller=Home}/{action=Index}/{id?}");
  });
}
// EndpointTestMiddleware.cs
public class EndpointTestMiddleware
{
  private RequestDelegate _next;

  public EndpointTestMiddleware(RequestDelegate next)
  {
    _next = next;
  }

  public async Task Invoke(HttpContext httpContext)
  {
    var endpoint = httpContext.Features.Get<IEndpointFeature>()?.Endpoint;
    if (endpoint == null)
    {
      await _next(httpContext);
      return;
    }
    var attruibutes = endpoint.Metadata.OfType<LogAttribute>();
    foreach (var attribute in attruibutes)
    {
      Debug.WriteLine("------------------------------------------------------------------------");
      Debug.WriteLine(attribute.Message);
      Debug.WriteLine("------------------------------------------------------------------------");
    }
    await _next(httpContext);
  }
}
// LogAttribute.cs
[AttributeUsage(AttributeTargets.Method, Inherited = false, AllowMultiple = true)]
public sealed class LogAttribute : Attribute
{
  public LogAttribute(string message)
  {
    Message = message;
  }

  public string Message { get; set; }
}
// HomeController.cs
public class HomeController : Controller
{
  [Log("Index")]
  public IActionResult Index()
  {
    return View();
  }

  [Log("Privacy")]
  public IActionResult Privacy()
  {
    return View();
  }
}

這樣的話，我們可以在我們自己的中間件中拿到 Endpoint 信息，然后找到 Controller 上的 LogAttribute ，然后輸出 Message。

總結(jié)

Endpoint 是ASP.NET Core 2.2中一種新的路由機制，它解決了傳統(tǒng)路由難以擴展的問題，解決了傳統(tǒng)路由與MVC過于耦合的問題，并提升了一定的RPS。

本文介紹了Endpoint路由，簡單分析了Endpoint的實現(xiàn)原理，并給出了一個使用的示例。

參考鏈接：

[ https://devblogs.microsoft.com/aspnet/asp-net-core-2-2-0-preview1-endpoint-routing/ ]
[ https://www.stevejgordon.co.uk/asp-net-core-first-look-at-global-routing-dispatcher ]
[ https://rolandguijt.com/endpoint-routing-in-asp-net-core-2-2-explained/ ]

以上就是本文的全部內(nèi)容，希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評論