首页 > 其他分享> 文章详细

.NetCore 3.1和.NetCore 5.0 中WebApi的入参端的校验方法

2021-07-10 13:31:50 阅读：332 来源： 互联网

标签：5.0 WebApi HttpGet return NetCore bool using true public

我们在写WebApi时，一般都是要对接口的入参进行验证。若入参为一个实体，我们一般用注解的方式(DataAnnotations)，或者FluentValidation来验证实体。

这几种常用的方法我就不总结了，网上有一大堆。参考：

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

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

但是若接口的入参不是实体，我们该怎么校验呢？其实这种情况操作起来更简单，微软早就帮我们准备好方法了。也就是使用路由模板（route template），也就是对路由进行限制。内置的常用的路由模板见官方文档：

https://docs.microsoft.com/zh-cn/dotnet/api/microsoft.aspnetcore.routing.constraints?view=aspnetcore-5.0

我们先看下代码：

  /// <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;
        }

标签：5.0,WebApi,HttpGet,return,NetCore,bool,using,true,public
来源： https://www.cnblogs.com/puzi0315/p/14993636.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9

.NetCore 3.1和.NetCore 5.0 中WebApi的入参端的校验方法