我們在寫WebApi時，一般都是要對介面的入參進行驗證。若入參為一個實體，我們一般用註解的方式(DataAnnotations)，或者FluentValidation來驗證實體。

這幾種常用的方法我就不總結了，網上有一大堆。參考：

https://www.cnblogs.com/lwqlun/p/10311945.html

http://www.zyiz.net/tech/detail-200294.html

但是若介面的入參不是實體，我們該怎麼校驗呢？其實這種情況操作起來更簡單，微軟早就幫我們準備好方法了。也就是使用路由模板（route template），也就是對路由進行限制。內建的常用的路由模板見官方文件：

我們先看下程式碼：

  /// <summary>
        /// 
        /// </summary>
        /// <param name="id">最大20</param>
        /// <param name="linkGenerator"></param>
        /// <returns></returns>
 

        [HttpGet("{id:max(20)}")]
        public bool Max([FromRoute]long id, [FromServices]LinkGenerator linkGenerator)
        {

            var a = linkGenerator.GetPathByAction(HttpContext, 
                action: "Reque", 
                controller: "Order", 
                values: new { name = "
 
abc" });

            var uri = linkGenerator.GetUriByAction(HttpContext, 
                action: "Reque", 
                controller: "Order", 
                values: new { name = "abc" });
            return true;
        }

        /// <summary>
        /// 
        /// </summary>
        /// <param name="ss">必填</param>
        /// <returns></returns>
        [HttpGet("{name:required}")]
        [Obsolete]
        public bool Reque(string name)
        {
            return true;
        }


        /// <summary>
        /// 
        /// </summary>
        /// <param name="number">以三個數字開始</param>
        /// <returns></returns>
        [HttpGet("{number:regex(^\\d{{3}}$)}")]
        public bool Number(string number)
        {
            return true;
        }

看到HttpGet後面括號裡的內容了吧，這個就是路由模板。上面只是舉幾個簡單的例子，swagger裡效果如下：

路由模板的格式為 ： {引數名:規則}，內建的規則有：必填， 時間型別，最大值，最大長度。支援正則表示式，也支援自定義。

若需要自定義，則需要建立一個類，繼承：IRouteConstraint,簡單的實現如下：

using Microsoft.AspNetCore.Http;
using Microsoft.AspNetCore.Routing;
using System;
using System.Collections.Generic;
using System.Linq;
using System.Threading.Tasks;

namespace RoutingTest
{
    public class MyRouteConstraint : IRouteConstraint
    {
        public bool Match(HttpContext httpContext, IRouter route, string routeKey, RouteValueDictionary values, RouteDirection routeDirection)
        {
            if (RouteDirection.IncomingRequest == routeDirection)
            {
                var v = values[routeKey];
                if (long.TryParse(v.ToString(), out var value))
                {
                    return true;
                }
            }
            return false;
        }
    }
}

然後在StartUp的ConfigureServices裡註冊：

services.AddRouting(options =>
{
options.ConstraintMap.Add("MyRC", typeof(MyRouteConstraint));
});

使用在Action的方法如下：

        /// <summary>
        /// 
        /// </summary>
        /// <param name="id">必須可以轉為long</param>
        /// <returns></returns>
        [HttpGet("{id:MyRC}")]
        public bool OrderExist([FromRoute]string id)
        {
            return true;
        }

作者：沐雪
文章均系作者原創或翻譯，如有錯誤不妥之處，歡迎各位批評指正。本文版權歸作者和部落格園共有，如需轉載懇請註明。
如果您覺得閱讀這篇部落格讓你有所收穫，請點選右下方【推薦】
找一找教程網-隨時隨地學軟體程式設計 http://www.zyiz.net/