怎么在ASP.NET Core中自定義路由約束

本篇文章給大家分享的是有關怎么在ASP.NET Core中自定義路由約束，小編覺得挺實用的，因此分享給大家學習，希望大家閱讀完這篇文章后可以有所收獲，話不多說，跟著小編一起來看看吧。

路由約束

ASP.NET Core中，通過定義路由模板，可以在Url上傳遞變量，同時可以針對變量提供默認值、可選和約束。

約束的使用方法是在屬性路由上添加指定的約束名，用法如下：

// 單個使用
[Route("users/{id:int}")]
public User GetUserById(int id) { }
// 組合使用
[Route("users/{id:int:min(1)}")]
public User GetUserById(int id) { }

框架內部已經提供了一些約束，如下所示：

內置的約束能夠適用于大部分常見的應用場景，但是有時候我們還是需要去自定義我們想要的效果。

自定義路由約束

自定義約束是要實現 IRouteConstraint 接口，然后重載 Match 方法，該方法有四個參數。

第一個參數 httpContext 是當前請求的上下文

第二個參數 route 是當前約束所屬的路由

第三個參數 routeKey 是當前檢查的變量名，例如文章開頭示例中的 id

第四個參數 values 是當前Url匹配的字典值，例如文章開頭的示例的路由，如果Url是 users/1 ，那么就有一個字典，其 key = id ， value = 1 。當然還有其他的變量的值，比如 controller ， action 等。

第五個參數 routeDirection 是一個枚舉值，代表是web請求的還是用 Url.Action 等方法生成Url。

舉一個實例，我們想要定義一個約束，指定路由傳過來的參數必須是指定的枚舉值。

我們先定義一個枚舉：

public enum BoolEnum
{
  True,
  False
}

然后定義約束：

public class EnumConstraint : IRouteConstraint
{
  private Type _enumType;

  public EnumConstraint(string enumTypeName)
  {
    _enumType = Type.GetType(enumTypeName);
  }

  public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
  {
    var value = values[routeKey];
    if (value == null)
    {
      return false;
    }

    if (Enum.TryParse(_enumType, value.ToString(), out object result))
    {
      if (Enum.IsDefined(_enumType, result))
      {
        return true;
      }
    }

    return false;
  }
}

在 Startup.cs 的 ConfigureServices 方法添加自定義約束：

services.Configure<RouteOptions>(options =>
{
  options.ConstraintMap.Add("enum", typeof(EnumConstraint));
});

在路由上使用約束：

( WebApplicationTest 是當前的 namespace )

[Route("api/[controller]")]
[ApiController]
public class TestController : ControllerBase
{
  // GET: api/Test
  [HttpGet("{bool:enum(" + nameof(WebApplicationTest) + "." + nameof(BoolEnum) + ")}")]
  public string Get(BoolEnum @bool)
  {
    return "bool: " + @bool;
  }

  [HttpGet("{id:int:min(2)}", Name = "Get")]
  public string Get(int id)
  {
    return "id: " + id;
  }

  [HttpGet("{name}")]
  public string Get(string name)
  {
    return "name: " + name;
  }
}

{id:int:min(2)} 路由必須使用 min(2) ，否則對于 id = 0 或 id = 1 會有沖突。

運行程序，當路由是 api/Test/0 、 api/Test/1 、 api/Test/True 和 api/Test/False 的時候，匹配我們的自定義約束。

當路由是 api/Test/{大于2的整數} 的時候，匹配第二個路由。

其他情況匹配第三個路由。

ASP.NET 是什么

ASP.NET 是開源，跨平臺，高性能，輕量級的 Web 應用構建框架，常用于通過 HTML、CSS、JavaScript 以及服務器腳本來構建網頁和網站。

以上就是怎么在ASP.NET Core中自定義路由約束，小編相信有部分知識點可能是我們日常工作會見到或用到的。希望你能通過這篇文章學到更多知識。更多詳情敬請關注億速云行業資訊頻道。