架构师_程序员_码农网

 找回密码
 注册[Register]

QQ登录

只需一步,快速开始

查看: 6921|回复: 1

[.NET Core] ASP.NET Core中自定义路由约束的实现

[复制链接]
发表于 2019-5-6 09:30:30 | 显示全部楼层 |阅读模式
路由约束

ASP.NET Core中,通过定义路由模板,可以在Url上传递变量,同时可以针对变量提供默认值、可选和约束。

约束的使用方法是在属性路由上添加指定的约束名,用法如下:

框架内部已经提供了一些约束,如下所示:

约束
示例
匹配项示例
说明
int
{id:int}
123456789, -123456789
匹配任何整数
bool
{active:bool}
true, FALSE
匹配 true或 false(区分大小写)
datetime
{dob:datetime}
2016-12-31, 2016-12-31 7:32pm
匹配有效的 DateTime 值(位于固定区域性中 - 查看警告)
decimal
{price:decimal}
49.99, -1,000.01
匹配有效的 decimal 值(位于固定区域性中 - 查看警告)
double
{weight:double}
1.234, -1,001.01e8
匹配有效的 double 值(位于固定区域性中 - 查看警告)
float
{weight:float}
1.234, -1,001.01e8
匹配有效的 float 值(位于固定区域性中 - 查看警告)
guid
{id:guid}
CD2C1638-1638-72D5-1638-DEADBEEF1638, {CD2C1638-1638-72D5-1638-DEADBEEF1638}
匹配有效的 Guid 值
long
{ticks:long}
123456789, -123456789
匹配有效的 long 值
minlength(value)
{username:minlength(4)}
Rick
字符串必须至少为 4 个字符
maxlength(value)
{filename:maxlength(8)}
Richard
字符串不得超过 8 个字符
length(length)
{filename:length(12)}
somefile.txt
字符串必须正好为 12 个字符
length(min,max)
{filename:length(8,16)}
somefile.txt
字符串必须至少为 8 个字符,且不得超过 16 个字符
min(value)
{age:min(18)}
19
整数值必须至少为 18
max(value)
{age:max(120)}
91
整数值不得超过 120
range(min,max)
{age:range(18,120)}
91
整数值必须至少为 18,且不得超过 120
alpha
{name:alpha}
Rick
字符串必须由一个或多个字母字符(a-z,区分大小写)组成
regex(expression)
{ssn:regex(^\d{{3}}-\d{{2}}-\d{{4}}$)}
123-45-6789
字符串必须匹配正则表达式(参见有关定义正则表达式的提示)
required
{name:required}
Rick
用于强制在 URL 生成过程中存在非参数值


内置的约束能够适用于大部分常见的应用场景,但是有时候我们还是需要去自定义我们想要的效果。
自定义路由约束

自定义约束是要实现 IRouteConstraint 接口,然后重载 Match 方法,该方法有四个参数。

第一个参数 httpContext 是当前请求的上下文

第二个参数 route 是当前约束所属的路由

第三个参数 routeKey 是当前检查的变量名,例如文章开头示例中的 id
第四个参数 values 是当前Url匹配的字典值,例如文章开头的示例的路由,如果Url是 users/1 ,那么就有一个字典,其 key = id , value = 1 。当然还有其他的变量的值,比如 controller , action 等。

第五个参数 routeDirection 是一个枚举值,代表是web请求的还是用 Url.Action 等方法生成Url。

举一个实例,我们想要定义一个约束,指定路由传过来的参数必须是指定的枚举值。

我们先定义一个枚举:


然后定义约束:

在 Startup.cs 的 ConfigureServices 方法添加自定义约束:
在路由上使用约束:

( WebApplicationTest 是当前的 namespace )


{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的整数} 的时候,匹配第二个路由。

其他情况匹配第三个路由。

结论

路由约束在某些场景下是非常有用的功能,可以减少 controller 中校验参数,将部分参数校验的功能使用声明式的 attruibute 来实现,某些重复的校验可以通过抽取成约束公共使用。

constraint 的构造函数可以使用注入,所以可以扩展性十分强,可以通过查询数据库做一些参数校验。

官网上对于路由约束只是简单的提了一下,本文对路由约束的使用提供了具体的示例。





上一篇:零基础学C#(全彩版) 明日科技
下一篇:ASP.NET Core – Razor View Import用途介绍
码农网,只发表在实践过程中,遇到的技术难题,不误导他人。
 楼主| 发表于 2019-5-6 09:32:15 | 显示全部楼层
码农网,只发表在实践过程中,遇到的技术难题,不误导他人。
您需要登录后才可以回帖 登录 | 注册[Register]

本版积分规则

免责声明:
码农网所发布的一切软件、编程资料或者文章仅限用于学习和研究目的;不得将上述内容用于商业或者非法用途,否则,一切后果请用户自负。本站信息来自网络,版权争议与本站无关。您必须在下载后的24个小时之内,从您的电脑中彻底删除上述内容。如果您喜欢该程序,请支持正版软件,购买注册,得到更好的正版服务。如有侵权请邮件与我们联系处理。

Mail To:help@itsvse.com

QQ|手机版|小黑屋|架构师 ( 鲁ICP备14021824号-2 )|网站地图

GMT+8, 2024-3-29 19:39

Powered by Discuz! X3.4

Copyright © 2001-2021, Tencent Cloud.

快速回复 返回顶部 返回列表