如何在 ASP.NET Core 中使用 Route 特性

ASP.NET Core 中的 Route 中间件的职责在于将 request 匹配到各自 Route 处理程序上,Route 分两种:基于约定基本特性 模式。

基于约定 模式的Route采用集中化的方式,而 基于特性 的方式允许你在 Action 或者 Controller 上单独定义,到底采用哪一种可以基于你自己的应用场景,本篇就来讨论如何使用 基于特性 模式。

创建 Controller 类

创建一个 DefaultController 类,新增如下代码。

public class DefaultController : Controller{[Route("")][Route("Default")][Route("Default/Index")]public ActionResult Index(){return new EmptyResult();}[Route("Default/GetRecordsById/{id}")]public ActionResult GetRecordsById(int id){string str = string.Format("The id passed as parameter is: {0}", id);return Ok(str);}}

Controller 级别定义 Route 特性

Route特性可用于 Controller 和 Action 级别,值得注意的是,如果应到到前者,那么 Controller 下的所有 Action 都受这个 Route 管控。

如果你仔细观察上面的 DefaultController 类代码,你会发现两个 Action 方法的 Route 路径都有 Default 前缀,这就不优雅了,优化方式就是把 Route 路径中的 Default 提取到 Controller 级别,代码如下:


[Route("Default")]   
public class DefaultController : Controller
{[Route("")][Route("Index")]public ActionResult Index(){return new EmptyResult();}[HttpGet][Route("GetRecordsById/{id}")]public ActionResult GetRecordsById(int id){string str = string.Format("The id passed as parameter is: {0}", id);return Ok(str);}
}

可以看出当 Controller 和 Action 级别都被 Route 打上标记之后,Asp.Net Core 中的 Route 引擎会自动将两者拼接起来,当然更简单粗暴的做法就是在 Controller 上使用 RoutePrefix 特性,如下代码所示:


[RoutePrefix("services")]
public class HomeController : Controller
{//Action methods
}

Action 级别定义 Route 特性

参考刚才的 DefaultController 类,我在 Index 方法上面定义了三个 Route 特性,这就意味着下面三种 Route 都可以访问到 Index() 方法,如下代码所示:


http://localhost:11277
http://localhost:11277/home
http://localhost:11277/home/index

常常在 基于约定 模式的Route中,它的 Route template 会有一些对参数的约定,比如下面的代码:

app.UseEndpoints(endpoints =>{endpoints.MapControllerRoute(name: "default",pattern: "{controller=Home}/{action=Index}/{id?}");});

同样 基于特性 模式的 Route 也是可以使用参数模式的,比如文章之前的 DefaultController.GetRecordsById 就是的,值得注意的是模板中的 {id} 表示可接收任何参数,如 string,int 等等,如果你想限定为 int 的话,也是可以实现的。

使用 Route 约束

Route 约束 就是 Controller 前的一个防火墙,他会踢掉一些不合规范的 Action 请求,比如说:你要求某个 Action 接收的参数必须是 int,那在 Route 模板中定义的语法格式一定是这样的 {parameter:constraint},如下代码所示:


[Route("Default/GetRecordsById/{id:int}")]
public ActionResult GetRecordsById(int id)
{string str = string.Format("The id passed as parameter is: {0}", id);return Ok(str);
}

在 Route 中使用可选参数

你也可以在 Route Template 上指定可选参数,意味着这个参数可传可不传,格式如下:


[Route("Sales/GetSalesByRegionId/{id?}")]

有一点非常重要,当你使用了 Route特性 之后,其实 Controller 或者 Action 的名字就不再重要了,因为 Route处理引擎 已经不再将其作为参考选项,下面的代码片段展示了如何在 Action 方法上变更 Route template 格式。


[Route("Home/GetRecordsById/{id:int}")]
public ActionResult GetRecordsById(int id)
{string str = string.Format("The id passed as parameter is: {0}", id);return Ok(str);
}

接下来可以直接使用如下地址访问 GetRecordsById 方法。


http://localhost:11277/home/GetRecordsById/1

对 Action 中的参数使用多个约束

真实场景中你不仅要求 id 必须是整数,还要求必须有一定意义,比如说最小值为1,对这种有 多重约束 的需求如何去实现呢?请看下面代码。


[Route("Default/GetRecordsById/{id:int:min(1)}")]
public ActionResult GetRecordsById(int id)
{string str = string.Format("The id passed as parameter is: {0}", id);return Ok(str);
}

常使用的 Route 约束

  • int       限定为 int 类型

  • max/min   限定 int 的最大数和最小数

  • minlength 限定 string 的最小长度

  • regex     限定符合的正则

创建自定义的 Route 约束

如果上面的一些约束不满足你的要求,你完全可以为你的场景深度定制,做法就是使用 IRouteConstraint 接口并实现它的 Match 方法即可,如下代码所示:

public class CustomRouteConstraint : IRouteConstraint{public bool Match(HttpContext httpContext, IRouter route,string routeKey,RouteValueDictionary values, RouteDirection routeDirection){throw new NotImplementedException();}}

在 Controller 上使用 token 占位符

所谓的 token 占位符 就是具有一些特定含义的占位符号,比如说:[action], [area] 和 [controller],分别表示用你真实的 Controller 和 Action 去替换,下面的代码展示了如何使用这种模式去实现。


[Route("[controller]/[action]")]
public class HomeController : Controller
{private readonly ILogger<HomeController> _logger;public HomeController(ILogger<HomeController> logger){_logger = logger;}public IActionResult Index(){return View();}//Other action methods
}

整体来看,基于特性 的 Route 给了你更多的操控权限,灵活的 Route Template 配置实现了 Controller 和 Action 的解耦,当然这里也不是说 基于约定 的Route 不好,毕竟人家是 Global 级别的,真实场景下两者更多的是混着用。

译文链接:https://www.infoworld.com/article/3569369/how-to-use-attribute-routing-in-aspnet-core.html

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/306193.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

java opencsv_用opencsv文件读写CSV文件

首先明白csv文件长啥样儿&#xff1a;用excel打开就变成表格了&#xff0c;看不到细节推荐用其它简单粗暴一点儿的编辑器&#xff0c;比如Notepad&#xff0c;csv文件内容如下&#xff1a;csv文件默认用逗号分隔各列。有了基础的了解就进入主题&#xff0c;用Opencsv读写csv文件…

Beetlex之tcp/tls服务压测工具

在编写tcp服务的时候经常需要对服务的基础性能进行一个压力测试&#xff0c;虽然网上这些工具有很多&#xff0c;但具备使用方便和高强度的测试工具则不多。为了方便这方面的高强度压测所以在beetlex的基础扩展这样一个工具。安装可以访问https://github.com/beetlex-io/TCPBen…

java自动随机字符_java随机字符生成工具

以下是我自己在工作中常用到的&#xff0c;比较好用&#xff0c;分享给大家。package org.phoenix.api.utils;import java.io.UnsupportedEncodingException;import java.util.Random;import java.util.concurrent.ThreadLocalRandom;/*** 随机字符工具类* author mengfeiyang*…

GraphQL:DataLoader的神奇

GraphQL 既是一种用于 API 的查询语言也是一个满足你数据查询的运行时。GraphQL 对你的 API 中的数据提供了一套易于理解的完整描述&#xff0c;使得客户端能够准确地获得它需要的数据&#xff0c;而且没有任何冗余&#xff0c;也让 API 更容易地随着时间推移而演进&#xff0c…

java点击关闭弹出窗口_java – JPopupMenu在子弹出窗口打开时关闭

不可能直接,它很难覆盖已知的bug,在其他手中Swing不允许同时有两个lightwieght弹出组件import javax.swing.*;import java.awt.event.*;public class Test {public static void main(String[] args) {JFrame frame new JFrame();frame.setSize(400, 400);frame.setVisible(tru…

【Azure Show】|第九期 “我的计算机入门之路” 嘉宾秦婷婷汪宇杰文轩

欢迎来到Azure Show!Azure Show欢迎来到Azure Show 第九期&#xff01;继上期【搭上AI快车】为大家带来数位微软技术专家于各自IT技术领域的经验分享&#xff0c;有2400多人在线上通过b站看了这个特辑的直播&#xff0c;非常非常感恩&#xff01;本期继续和广州图书馆合作&…

java的scanner的方法_Java Scanner reset()方法

Java Scanner reset()方法java.util.Scanner.reset() 方法重置该扫描仪。重设scanner 丢弃所有的这些可能已被useDelimiter(java.util.regex.Pattern)的调用改变其明确的状态信息&#xff0c;useLocale(java.util.Locale)&#xff0c;或useRadix(int)。1 语法public Scanner re…

Abp vNext 后台作业hangfire

概述ABP vNext 提供了后台工作者和后台作业的支持&#xff0c;基本实现与原来的 ABP 框架类似&#xff0c;并且 ABP vNext 还提供了对 HangFire 和 RabbitMQ 的后台作业集成。开发人员在使用这些第三方库的时候&#xff0c;基本就是开箱即用&#xff0c;不需要做其他复杂的配置…

如何在 C# 中使用 委托

委托是一个类型安全的函数指针&#xff0c;它可以引用与委托具有相同签名的方法&#xff0c;你可以利用 委托 实现事件或者回调函数&#xff0c;多播委托 可以引用一个或者多个具有相同签名的方法。理解 委托 本质上来说&#xff0c;委托包含了一个对方法的引用&#xff0c;概念…

java发送会议邀请邮件模板_Spring 发送邮件 HTML邮件

[java 代码 import java.security.Security; import java.util.Date; import java.util.HashMap; import java.util.Map; import java.u用到的JAR包&#xff1a;spring.jarmail.jaractivation.jarcommons-logging.jarlog4j-1.2.15.jarMimeMessage由发送器创建&…

java语言怎样判断文件夹_JAVA语言之如何判断文件,判断文件夹是否存在的代码...

本文主要向大家介绍了JAVA语言之如何判断文件&#xff0c;判断文件夹是否存在的代码&#xff0c;通过具体的内容向大家展示&#xff0c;希望对大家学习JAVA语言有所帮助。一、判断文件是否存在&#xff0c;不存在则创建File file new File("d:\\test.txt");if (!fil…

调试实战 | 通过转储文件分析程序无响应之使用 windbg + IDA 逆向篇

缘起 最近&#xff0c;接连在项目中遇到了两个界面无响应的问题。都只发生在客户特定机器上&#xff0c;不方便直接调试&#xff0c;只能抓取 dump 进行事后分析了。抓取 dump 远程连上可以重现问题的机器&#xff0c;使用 process explorer 初步观察卡死的进程&#xff0c;发现…

跟我一起学Redis之高可用从主从复制开始

前言现在遇到高并发场景时&#xff0c;缓存技术应该算是性能优化的第一步&#xff0c;缓解数据库压力的同时还能提高访问效率&#xff0c;而Redis应该是绝大多数应用场景的首选。但是尽快Redis性能再优秀&#xff0c;在当今高并发场景下&#xff0c;一台服务器负责读写&#xf…

【.Net core】EFCore——Code First生成数据库与表

Code First——领域设计模式中非常有用。使用 Code First 模式&#xff0c;专注于领域设计&#xff0c;创建领域类&#xff0c;然后生成数据库。1.创建数据模型类一般就是数据库里面有哪些表&#xff0c;就创建哪些模型&#xff0c; POCO 类就够了。public partial class SmsPu…

mysql 备份配置文件_mySQL配置文件、备份与恢复

mysql配置文件mysql的配置文件为/etc/my.cnf配置文件查找次序&#xff1a;若在多个配置文件中均有设定&#xff0c;则最后找到的最终生效/etc/my.cnf --> /etc/mysql/my.cnf --> --default-extra-file/PATH/TO/CONF_FILE --> ~/.my.cnfmysql常用配置文件参数&#xff…

oracle java写目录权限_oracle分配权限 学习笔记--转载

在全局数据库ORCL下创建一个用户首先在开始--》运行——》sqlplus&#xff0c;然后输入 sys/change_on_install as sysdba以sys权限登陆进去然后可以进行操作&#xff1a;创建用户 create user test indentified by test;这样就创建了一个用户名密码都为test的用户但这个时候te…

龙芯.NET正式发布 开源共享与开发者共成长

2020年12月19日&#xff0c;2020中国. NET开发者大会于苏州盛大开幕。本次大会以“开源、共享、创新”为主题&#xff0c;以线下城市苏州为中心&#xff0c;覆盖北京、上海、深圳、广州、长沙、成都、厦门、胶东等地区&#xff0c;是中国 .NET 开发者的大聚会&#xff0c;线上线…

划入 .NET 6版本目标,微软鼓励开发人员信任第三方库

喜欢就关注我们吧&#xff01;鉴于许多 .NET 社区的开发人员都不愿意使用非微软官方打造的库&#xff0c;近日&#xff0c;微软 .NET Framework 团队的项目经理 Immo Landwerth 发布了一个名为”Growing the .NET ecosystem“的文档&#xff0c;以鼓励 .NET 开发人员加强对第三…

归并排序 java 迭代_经典排序算法之归并排序(示例代码)

归并排序(英语&#xff1a;Merge sort&#xff0c;或mergesort)&#xff0c;是创建在归并操作上的一种有效的排序算法&#xff0c;效率为(大O符号)。1945年由约翰冯诺伊曼首次提出。该算法是采用分治法(Divide and Conquer)的一个非常典型的应用&#xff0c;且各层分治递归可以…

新鲜高频笔面试题分享,Redis、MongoDB、ElasticSearch...

2020年可能是最短的一年&#xff0c;上班没几个月就发现要元旦了&#xff1b;2020年可能是最难的一年&#xff0c;各种降薪被离职风波&#xff1b;然而好消息是&#xff0c;2021年马上来了&#xff0c;跳槽季也要来了&#xff0c;一起开始备战吧&#xff0c;新年薪资up up&…