ASP.NET Core 2.2中的Endpoint路由详解

endpoint路由

在asp.net core 2.2中，新增了一种路由，叫做 endpoint （终结点）路由。本文将以往的路由系统称为 传统路由 。

本文通过源码的方式介绍传统路由和 endpoint 路由部分核心功能和实现方法，具体功能上的差异见 官方文档 。

在升级到asp.net core 2.2后，会自动启用 endpoint 路由。如果要恢复以往的实现逻辑，需要加入以下代码：

services.addmvc(options => options.enableendpointrouting = false)
  .setcompatibilityversion(compatibilityversion.version_2_2);

本文分析的源代码基于asp.net core 2.2.3版本的 源代码 。

endpoint作用

endpoint 路由与传统路由的区别在于，传统路由 url 与 action 对应关系的处理是在 usemvc 中做的。我们无法根据 url 获取对应的 action 然后进行处理。

endpoint 就是将 url 与 action 的映射关系从 mvc 中拆离，作为独立使用的中间件。

由此带来的好处是我们可以在其他的中间件中使用 controller 和 action 上的一些信息，例如 attruibute 。

框架也提供了 linkgenerator 类来直接根据 endpoint 生成链接，不再需要 httpcontext 的信息。

另外也提升了一些rps(requests per second)。

不过目前 endpoint 依然是在 usemvc 中调用，更多开放的使用方式会在asp.net core 3.0中实现。

启用endpoint路由

源代码见 github 。也可以获取源代码到本地看。

在 mvcapplicationbuilderextensions.cs 文件72行的 usemvc 方法中我们可以看到以下代码：

var options = app.applicationservices.getrequiredservice<ioptions<mvcoptions>>();

if (options.value.enableendpointrouting)
{
  ...
}
else
{
  ...
}

if 之中是 endpoint 路由的逻辑， else 是传统路由的逻辑。

而 mvcoptions 的构造方法如下所示， enableendpointrouting 是通过 compatibilityswitch 来控制默认值的，这就是 compatibilityversion.version_2_2 启用 endpoint 路由的原因。

public mvcoptions()
{
  // ...
  _enableendpointrouting = new compatibilityswitch<bool>(nameof(enableendpointrouting));
  // ...
}

endpoint路由实现原理

在 mvcapplicationbuilderextensions.cs 文件的92-123行的代码是将所有的 controller 中的 action 转换成 endpoint 。

在129行的 useendpointrouting 中，添加了一个 endpointroutingmiddleware 的中间件，这个中间件就是从所有的 endpoint 中找到当前路由对应的 endpoint ，然后放到 feature 集合中。

在132行的 useendpoint 中，添加了一个 endpointmiddleware 中间件，这个中间件是将 endpointroutingmiddleware 中找到的 endpoint 取出，根据其中的 metadata 信息，找到对应的 controller 和 action ，并调用。

在 usemvc 方法里， useendpointrouting 和 useendpoint 是连续的两个中间件，而 useendpoint 是请求的结束，这意味着我们自定义的中间件无法取得 endpoint 信息。

但是通过手动调用 useendpoint ，我们还是可以拿到 endpoint 路由信息的。

使用示例

下面展示一个使用示例。

定义一个 logattribute 类，并包含一个 message 属性，在 action 上声明使用。

定义一个 endpointtestmiddleware 中间件，输出 logattribute 的 message 属性。

手动调用 useendpointrouting ，然后调用我们定义的 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。

总结

endpoint 是asp.net core 2.2中一种新的路由机制，它解决了传统路由难以扩展的问题，解决了传统路由与mvc过于耦合的问题，并提升了一定的rps。

本文介绍了endpoint路由，简单分析了endpoint的实现原理，并给出了一个使用的示例。

参考链接：

[ ]
[ ]
[ ]

以上就是本文的全部内容，希望对大家的学习有所帮助，也希望大家多多支持。