.NetCore 3.1和.NetCore 5.0 中WebApi的请求参数的验证方法
内容导读
互联网集市收集整理的这篇技术教程文章主要介绍了.NetCore 3.1和.NetCore 5.0 中WebApi的请求参数的验证方法,小编现在分享给大家,供广大互联网技能从业者学习和参考。文章包含2568字,纯文字阅读大概需要4分钟。
内容图文

我们在写WebApi时,一般都是要对接口的入参进行验证。若入参为一个实体,我们一般用注解的方式(DataAnnotations)+ModelState,或者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)}")] publicbool 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" }); returntrue; } ///<summary>//////</summary>///<param name="ss">必填</param>///<returns></returns> [HttpGet("{name:required}")] [Obsolete] publicbool Reque(string name) { returntrue; } ///<summary>//////</summary>///<param name="number">以三个数字开始</param>///<returns></returns> [HttpGet("{number:regex(^\\d{{3}}$)}")] publicbool Number(string number) { returntrue; }
看到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(), outvar value)) { returntrue; } } returnfalse; } } }
然后在StartUp的ConfigureServices里注册:
services.AddRouting(options => { options.ConstraintMap.Add("MyRC", typeof(MyRouteConstraint)); });
使用在Action的方法如下:
/// <summary> /// /// </summary> /// <param name="id"> 必须可以转为long </param> /// <returns></returns> [HttpGet("{id:MyRC}")] publicbool OrderExist([FromRoute]string id) { returntrue; }
原文:https://www.cnblogs.com/puzi0315/p/14993636.html
内容总结
以上是互联网集市为您收集整理的.NetCore 3.1和.NetCore 5.0 中WebApi的请求参数的验证方法全部内容,希望文章能够帮你解决.NetCore 3.1和.NetCore 5.0 中WebApi的请求参数的验证方法所遇到的程序开发问题。 如果觉得互联网集市技术教程内容还不错,欢迎将互联网集市网站推荐给程序员好友。
内容备注
版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 gblab@vip.qq.com 举报,一经查实,本站将立刻删除。
内容手机端
扫描二维码推送至手机访问。