路由約束

ASP.NET Core中，通過(guò)定義路由模板，可以在Url上傳遞變量，同時(shí)可以針對(duì)變量提供默認(rèn)值、可選和約束。

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

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

框架內(nèi)部已經(jīng)提供了一些約束，如下所示：

內(nèi)置的約束能夠適用于大部分常見(jiàn)的應(yīng)用場(chǎng)景，但是有時(shí)候我們還是需要去自定義我們想要的效果。

自定義路由約束

自定義約束是要實(shí)現(xiàn) IRouteConstraint 接口，然后重載 Match 方法，該方法有四個(gè)參數(shù)。

第一個(gè)參數(shù) httpContext 是當(dāng)前請(qǐng)求的上下文

第二個(gè)參數(shù) route 是當(dāng)前約束所屬的路由

第三個(gè)參數(shù) routeKey 是當(dāng)前檢查的變量名，例如文章開(kāi)頭示例中的 id

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

第五個(gè)參數(shù) routeDirection 是一個(gè)枚舉值，代表是web請(qǐng)求的還是用 Url.Action 等方法生成Url。

舉一個(gè)實(shí)例，我們想要定義一個(gè)約束，指定路由傳過(guò)來(lái)的參數(shù)必須是指定的枚舉值。

我們先定義一個(gè)枚舉：

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 是當(dāng)前的 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) ，否則對(duì)于 id = 0 或 id = 1 會(huì)有沖突。

運(yùn)行程序，當(dāng)路由是 api/Test/0 、 api/Test/1 、 api/Test/True 和 api/Test/False 的時(shí)候，匹配我們的自定義約束。

當(dāng)路由是 api/Test/{大于2的整數(shù)} 的時(shí)候，匹配第二個(gè)路由。

其他情況匹配第三個(gè)路由。

結(jié)論

路由約束在某些場(chǎng)景下是非常有用的功能，可以減少 controller 中校驗(yàn)參數(shù)，將部分參數(shù)校驗(yàn)的功能使用聲明式的 attruibute 來(lái)實(shí)現(xiàn)，某些重復(fù)的校驗(yàn)可以通過(guò)抽取成約束公共使用。

constraint 的構(gòu)造函數(shù)可以使用注入，所以可以擴(kuò)展性十分強(qiáng)，可以通過(guò)查詢數(shù)據(jù)庫(kù)做一些參數(shù)校驗(yàn)。

官網(wǎng)上對(duì)于路由約束只是簡(jiǎn)單的提了一下，本文對(duì)路由約束的使用提供了具體的示例。

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

最新評(píng)論