ASP.NET Core 的 Routing

ASP.NET Core 的 Routing

ASP.NET Core 的 controllers 使用Routing 中间件匹配客户端的 url 请求，然后映射到对应的 controller 的处理方法（Action）上。
Actions 可以是 常规路由 或 属性路由 的映射。
MVC App一般使用常规路由。
REST APIs 应该使用属性路由。

MVC App 中用的常规路由

使用 MapControllerRoute() 方法，创建一个单一路由。

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

这个单一路由的名字是"default"。
这个单一路由的模板是"{controller=Home}/{action=Index}/{id?}"，Home是默认Controller名称，Index是默认Action名称。

这个路由模板：

  • 匹配的url路径类似：/Products/Details/5
  • 解析的参数值是：{ controller = Products, action = Details, id = 5 }

如果有两个Controller 的定义是这样的：

public class ProductsController : Controller
{public IActionResult Details(int id){// use id;}
}
public class HomeController : Controller
{public IActionResult Index() { ... }
}

如果有 url是：/Products/Details/5，
对应路由模板的 “{controller=Home}/{action=Index}/{id?}”，
因为可以找到Products Controller，所以匹配了ProductsController

  • Products Controller 中的 Products
  • Details 代表Action方法
  • 5 对应入参 id 的值，? 表示 5 是可空的，如果id出现在url中但无值，则默认为0。

而以下 url：都会匹配到HomeController：

  • /Home/Index/17
  • /Home/Index
  • /Home 可以找到Home controllers，没有指定具体的则找默认的 Index action
  • / 没有具体指定controllers和action，则找默认的Home controllers 和 Index action

注意：匹配的过程只基于Controllers名称和Action名称，与代码的命名空间，文件夹层级，Action的参数无关。

设置多个常规路由

可以多次调用 app.MapControllerRoute()。

app.MapControllerRoute(name: "blog",pattern: "blog/{*article}",defaults: new { controller = "Blog", action = "Article" });
app.MapControllerRoute(name: "default",pattern: "{controller=Home}/{action=Index}/{id?}");

blog路由在这里是一个专用的常规路由，符合规则的 url 都会映射到BlogController的Article方法。
“/Blog”, “/Blog/Article”, 和 “/Blog/{any-string}” 都会映射到BlogController的Article方法。
blog路由优先于default路由进行匹配，因为它先被注册。

Action 冲突

如果多个Action都被路由系统匹配，那么会：

  • 选择最匹配的，或
  • 抛出异常

比如url /Products/Edit/17 会同时匹配下面的两个 Action

public class ProductsController : Controller
{public IActionResult Edit(int id){return ControllerContext.MyDisplayRouteInfo(id);}[HttpPost]public IActionResult Edit(int id, Product product){return ControllerContext.MyDisplayRouteInfo(id, product.name);}
}

而一般来说，只有id入参的Action，url 一般是GET方法，而入参是int id, Product product的Action，url一般是POST方法。
所以需要使用[HttpGet] 或者 [HttpPOST] 来标记Action，让路由系统匹配最佳的Action，HTTP Method属性包括：

  • [HttpGet]
  • [HttpPost]
  • [HttpPut]
  • [HttpDelete]
  • [HttpHead]
  • [HttpPatch]

REST APIs 中用的属性路由

属性路由没有像传统路由那样的通配路由，而且不再通过Controller和Action的名称匹配，除非使用占位符匹配。
直接在Controller的Action中用属性定义：

public class HomeController : Controller
{[Route("")][Route("Home")][Route("Home/Index")][Route("Home/Index/{id?}")][HttpGet]public IActionResult Index(int? id){return ControllerContext.MyDisplayRouteInfo(id);}[Route("Home/About")][Route("Home/About/{id?}")]public IActionResult About(int? id){return ControllerContext.MyDisplayRouteInfo(id);}
}

意思是一个Action可以匹配多个url模板。
但应该尽量精确的使用url模板，保证效率。

占位符匹配

占位符可以是 [action], [area], 和 [controller]，占位符使用area，controller和action的名称进行匹配。
例如：

public class HomeController : Controller
{[Route("")][Route("Home")][Route("[controller]/[action]")]public IActionResult Index(){return ControllerContext.MyDisplayRouteInfo();}[Route("[controller]/[action]")]public IActionResult About(){return ControllerContext.MyDisplayRouteInfo();}
}

和

[Route("[controller]/[action]")]
public class HomeController : Controller
{[Route("~/")][Route("/Home")][Route("~/Home/Index")]public IActionResult Index(){return ControllerContext.MyDisplayRouteInfo();}public IActionResult About(){return ControllerContext.MyDisplayRouteInfo();}
}

组合匹配

[ApiController]
[Route("products")]
public class ProductsApiController : ControllerBase
{[HttpGet]public IActionResult ListProducts(){return ControllerContext.MyDisplayRouteInfo();}[HttpGet("{id}")]public IActionResult GetProduct(int id){return ControllerContext.MyDisplayRouteInfo(id);}
}

在Controller上定义了[Route(“products”)]，在Action 上定义了HttpMethod，那么在匹配时，会组合起来匹配，比如：

  • /products 会匹配 ProductsApi.ListProducts
  • /products/5 会匹配 ProductsApi.GetProduct(int)

但是 “/” 或者 “~/” 开头的模板不会被controller的模板组合。

匹配顺序

  • 模板规则越具体的越优先匹配
  • 根据 Order 属性，比如 [Route(“Home”, Order = 2)] 晚于 [Route(“Home”, Order = 1)]

指定参数类型

可以在Url模板中指定参数id的值类型：

public class Products14Controller : Controller
{[HttpPost("product14/{id:int}")]public IActionResult ShowProduct(int id){return ControllerContext.MyDisplayRouteInfo(id);}
}

还可以定义默认值：

public class MyApiControllerAttribute : Attribute, IRouteTemplateProvider
{public string Template => "api/[controller]";public int? Order => 2;public string Name { get; set; } = string.Empty;
}[MyApiController]
[ApiController]
public class MyTestApiController : ControllerBase
{// GET /api/MyTestApi[HttpGet]public IActionResult Get(){return ControllerContext.MyDisplayRouteInfo();}
}

混合使用传统路由和属性路由

Actions 可以是传统路由或者属性路由，但是定义了属性路由的Actions 就不能再被传统路由匹配了，意思是属性路由的优先级更高。
而如果Controller上定义了属性路由，那么所有内部的Actions 就都不能再被传统路由匹配了。

系统保留的路由关键字

保留的路由关键字不应该用在路由匹配系统中，包括：

  • action
  • area
  • controller
  • handler
  • page
    而且在ulr中不可以包含ASCII的"/" 或者" "，路由系统不支持URL 转义。

URL Generation 和 环境值

ASP.NET Core App 可以生成指向Action的 URL，这个功能叫 URL Generation。
URL Generation 可以减少 hard code的URL，使代码更健壮，更好维护。
可以在controllers和views使用Url属性使用 IUrlHelper 接口的方法。
先看传统路由的例子：

public class UrlGenerationController : Controller
{public IActionResult Source(){// 生成了url: /UrlGeneration/Destinationvar url = Url.Action("Destination");return ControllerContext.MyDisplayRouteInfo("", $" URL = {url}");}public IActionResult Destination(){return ControllerContext.MyDisplayRouteInfo();}
}

这里使用的是传统路由，url 变量的值是URL的路径字符串 “/UrlGeneration/Destination”。通过组合http request的路由值（环境值）：

  1. 环境值: { controller = “UrlGeneration”, action = “Source” }
  2. 环境值传给 Url.Action: { controller = “UrlGeneration”, action = “Destination” }
  3. 路由模板: {controller}/{action}/{id?}
  4. 结果: /UrlGeneration/Destination

路由模板中的每个路由参数会被环境值替代。没有值的路由参数要么使用默认值，要么跳过（可空）。

再看属性路由的例子：

public class UrlGenerationAttrController : Controller
{[HttpGet("custom")]public IActionResult Source(){var url = Url.Action("Destination");return ControllerContext.MyDisplayRouteInfo("", $" URL = {url}");}[HttpGet("custom/url/to/destination")]public IActionResult Destination(){return ControllerContext.MyDisplayRouteInfo();}
}

Source action 生成了 custom/url/to/destination。

通过Action名称生成URL

Url.Action, LinkGenerator.GetPathByAction 都用于通过Controller和Action的名称生成URL。
使用 Url.Action 时，controller 和 action的路由值由.NET 运行时生成。
假设有一个路由是这样： {a}/{b}/{c}/{d}，环境值是 { a = Alice, b = Bob, c = Carol, d = David }，那么路由有足够信息生成URL，不需要额外的值。
如果添加了{ d = Donovan }，那么{ d = David }会被忽略，会生成URL Alice/Bob/Carol/Donovan。
如果添加了 { c = Cheryl }，那么{ c = Carol, d = David } 都会被忽略。

任何不匹配路由参数的额外的值都会被放进query字符串中。比如：

public IActionResult Index()
{var url = Url.Action("Buy", "Products", new { id = 17, color = "red" });return Content(url!);
}

会生成URL： /Products/Buy/17?color=red

下面的代码生成一个绝对路径URL：

public IActionResult Index2()
{var url = Url.Action("Buy", "Products", new { id = 17 }, protocol: Request.Scheme);// Returns https://localhost:5001/Products/Buy/17return Content(url!);
}

通过路由名称生成URL

Url.RouteUrl 可以指定一个路由名称生成URL，而一般不指定Controller或者Action名称。
比如：

public class UrlGeneration2Controller : Controller
{[HttpGet("")]public IActionResult Source(){var url = Url.RouteUrl("Destination_Route");return ControllerContext.MyDisplayRouteInfo("", $" URL = {url}");}[HttpGet("custom/url/to/destination2", Name = "Destination_Route")]public IActionResult Destination(){return ControllerContext.MyDisplayRouteInfo();}

下面的代码生成一个指向Destination_Route的链接：

<h1>Test Links</h1>
<ul><li><a href="@Url.RouteUrl("Destination_Route")">Test Destination_Route</a></li>
</ul>

在Action Results中生成URL

在Controlle中最常见的用法是在Action Results中返回一个URL，另一个用法是Redirect到另一个Action。
Controller基类提供了方便的方法来实现Redirect。

[HttpPost]
[ValidateAntiForgeryToken]
public IActionResult Edit(int id, Customer customer)
{if (ModelState.IsValid){// Update DB with new details.ViewData["Message"] = $"Successful edit of customer {id}";return RedirectToAction("Index");}return View(customer);
}

Area 路由

Area路由是MVC中的功能，可以把相关的功能做成一个分组。
可以通过Routing 命名空间分组controller 和 actions，也可以通过文件夹分组Views。
Areas 可以让多个controller 在不同的Area下有相同的名字。
比如：

app.MapAreaControllerRoute("blog_route", "Blog","Manage/{controller}/{action}/{id?}");
app.MapControllerRoute("default_route", "{controller}/{action}/{id?}");
app.Run();

MapAreaControllerRoute创建的路由中，blog_route是路由名，Blog是Area名。
当匹配URL路径比如 /Manage/Users/AddUser 时，“blog_route” 路由生成的路由值是：{ area = Blog, controller = Users, action = AddUser }。
上面这个路由会匹配这个Action：

    [Area("Blog")]public class UsersController : Controller{// GET /manage/users/adduserpublic IActionResult AddUser(){var area = ControllerContext.ActionDescriptor.RouteValues["area"];var actionName = ControllerContext.ActionDescriptor.ActionName;var controllerName = ControllerContext.ActionDescriptor.ControllerName;return Content($"area name:{area}" +$" controller:{controllerName}  action name: {actionName}");}        }

注意：没有Area属性的Controller不会匹配任何带Area的路由模板。

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

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

相关文章

华为OD机试 - 数字序列比大小 - 贪心算法（Java 2023 B卷 100分）

华为OD机试 - 数字序列比大小 - 贪心算法（Java 2023 B卷 100分）

目录 一、题目描述二、输入描述三、输出描述四、解题思路五、Java算法源码六、效果展示1、输入2、输出3、说明 华为OD机试 2023B卷题库疯狂收录中&#xff0c;刷题点这里 一、题目描述 A&#xff0c;B两个人万一个数字比大小的游戏&#xff0c;在游戏前&#xff0c;两个人会拿…
阅读更多...
【JAVA】建造者模式

【JAVA】建造者模式

【JAVA】建造者模式 建造者模式是一种创建型设计模式&#xff0c;用于将对象的构建过程与其表示分离。它可以通过一步一步地构建复杂对象&#xff0c;使得相同的构建过程可以创建不同的表示。 在Java中&#xff0c;建造者模式通常由以下几个组件组成&#xff1a; 产品&#x…
阅读更多...
Linux 内核动态打印调试（dev_info、 dev_dbg ）

Linux 内核动态打印调试（dev_info、 dev_dbg ）

目录 前言 1 printk消息级别 2 调整内核printk打印级别 3 dev_xxx函数简介 4 配置内核使用动态打印 5 动态调试使用方法 6 动态打印调试的基本原理 &#x1f388;个人主页&#x1f388;&#xff1a;linux_嵌入式大师之路的博客-CSDN博客&#x1f389;&#x1f389;&…
阅读更多...
数据库连接工具类（以mysql为例子）

数据库连接工具类（以mysql为例子）

依赖&#xff1a; <!-- 连接MySQL数据库的依赖&#xff0c;其他数据库网上找pom依赖替换 --><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId><version>8.0.15</version></dependency&…
阅读更多...
xss-labs靶场通关详解

xss-labs靶场通关详解

文章目录 前言level1level2level3level4level5level6level7level8level9level10level11level12level13level14level15level16level17level18level19&level20 前言 赶着假期结尾的时候&#xff0c;赶紧给自己找点任务做。现在对xss还是一知半解&#xff0c;只是了解个大概&a…
阅读更多...
vim系列之常用命令

vim系列之常用命令

一.欢迎来到我的酒馆 在本章节介绍vim编辑器常用命令。 目录 一.欢迎来到我的酒馆二.vim常用命令 二.vim常用命令 2.1vim编辑器常用命令&#xff1a; i: 在光标位置处插入字符。o: 在下一行开始位置插入一行。yy: 复制光标所在的行p: 在光标位置粘贴剪切板内容。
阅读更多...
Java seven 解读正则表达式、java方法的使用

Java seven 解读正则表达式、java方法的使用

目录 Java 正则表达式1. java.util.regex 包2. 捕获组3. 正则表达式语法4. Matcher 类的方法 Java 方法1. 定义&#xff1a;2. 优点3. 命名规则4. 方法调用5. 方法的重载6. 构造方法7. 可变参数8. finalize() 方法 Java 正则表达式 1. java.util.regex 包 Pattern 类&#xff…
阅读更多...
自用Eclipse配置记录

自用Eclipse配置记录

喜欢用eclipse写代码&#xff0c;由于现在的eclipse配置导出的功能缺失较多。这里开一帖把本人常用的配置记录一番&#xff0c;省得再到处找。 另&#xff1a;工作空间中有个.metadata 目录保存了相关的插件及配置&#xff0c;可以复制到其他空工作间中复用配置。 设置工作空间…
阅读更多...
Unity碰撞检测

Unity碰撞检测

Unity碰撞检测 前言准备材料代码使用OnCollisionEnter()进行碰撞Collider状态代码 使用OnTriggerEnter()进行碰撞Collider状态代码 区别代码OnCollisionEnter()OnTriggerEnter() 碰撞显示效果OnCollisionEnter()OnTriggerEnter() 提示结语 前言 碰撞检测可以说时学习Unity中最…
阅读更多...
ChatGPT⼊门到精通(5):ChatGPT 和Claude区别

ChatGPT⼊门到精通(5):ChatGPT 和Claude区别

⼀、Claude介绍 Claude是Anthropic开发的⼀款⼈⼯智能助⼿。 官⽅⽹站&#xff1a; ⼆、Claude能做什么 它可以通过⾃然语⾔与您进⾏交互,理解您的问题并作出回复。Claude的主要功能包括: 1、问答功能 Claude可以解答⼴泛的常识问题与知识问题。⽆论是历史上的某个事件,理科…
阅读更多...
k8s之存储篇---数据卷Volume

k8s之存储篇---数据卷Volume

数据卷概述 Kubernetes Volume&#xff08;数据卷&#xff09;主要解决了如下两方面问题&#xff1a; 数据持久性&#xff1a;通常情况下&#xff0c;容器运行起来之后&#xff0c;写入到其文件系统的文件暂时性的。当容器崩溃后&#xff0c;kubelet 将会重启该容器&#xff…
阅读更多...
群晖DSM下套件及系统网页服务器ssl证书自动更新

群晖DSM下套件及系统网页服务器ssl证书自动更新

关键字&#xff1a; DSM ssl 证书 起因 群晖下自建服务(alist3)和系统服务在外部网络访问需要加ssl安全证书来实现基础的传输保护。 申请证书和续期手动操作都还好&#xff0c;不算太麻烦&#xff0c;但是每个应用单独证书需要复制和重启&#xff0c;再配合服务重启一套下来就…
阅读更多...
【openGauss2.1.0实现X-Tuner进行参数调优】

【openGauss2.1.0实现X-Tuner进行参数调优】

openGauss2.1.0实现X-Tuner进行参数调优 一、环境说明二、参数调优步骤 openGauss2.1.0作为一款全新的开源关系型数据库&#xff0c;在性能方面具有很大的优势。通过使用X-Tuner工具&#xff0c;可以对openGauss2.1.0的参数进行优化&#xff0c;以提高其性能。 一、环境说明 华…
阅读更多...
Javaweb入门

Javaweb入门

Spring Spring发展到今天已经形成一种开发生态圈&#xff0c;Spring提供若干个子项目&#xff0c;每个项目用于完成特定的功能。 Spring Boot可以帮助我们非常快速的构建应用程序、简化开发、提高效率 SpringBootWeb入门 需求&#xff1a;使用Spring Boot开发一个web应用&a…
阅读更多...
软件测试面试怎样介绍自己的测试项目？会问到什么程度？

软件测试面试怎样介绍自己的测试项目？会问到什么程度？

想知道面试时该怎样介绍测试项目&#xff1f;会问到什么程度&#xff1f;那就需要换位思考&#xff0c;思考HR在这个环节想知道什么。 HR在该环节普遍想获得的情报主要是下面这2个方面&#xff1a; 1&#xff09;应聘者的具体经验和技术能力&#xff0c; 2&#xff09;应聘者的…
阅读更多...
Vector 动态数组（迭代器）

Vector 动态数组（迭代器）

C数据结构与算法 目录 本文前驱课程 1 C自学精简教程 目录(必读) 2 Vector<T> 动态数组&#xff08;模板语法&#xff09; 本文目标 1 熟悉迭代器设计模式&#xff1b; 2 实现数组的迭代器&#xff1b; 3 基于迭代器的容器遍历&#xff1b; 迭代器语法介绍 对迭…
阅读更多...
新版HBuilderX在uni_modules创建搜索search组件

新版HBuilderX在uni_modules创建搜索search组件

1、创建自定义组件 my-search 新版HBuilder没有了 component 文件夹&#xff0c;但是有 uni_modules 文件夹&#xff0c;用来创建组件&#xff1a; 右键 uni_modules 文件夹&#xff0c;点击 新建uni_modules创建在弹出框&#xff0c;填写组件名字&#xff0c;例如&#xff1a…
阅读更多...
netmap安装使用

netmap安装使用

文章目录 1、安装编译netmap2、使用netmap3、运行编写自己的代码 1、安装编译netmap github地址 git clone https://github.com/luigirizzo/netmap 1、进入目录 cd netmap-master/LINUX 2、安装编译环境 apt-get install build-essential 3、初始化配置环境 ./configure 出现这…
阅读更多...
【linux命令讲解大全】003.掌握文件属性与权限：chattr和chgrp工具的使用

【linux命令讲解大全】003.掌握文件属性与权限：chattr和chgrp工具的使用

文章目录 chattr补充说明语法选项实例 chgrp补充说明语法选项参数实例 从零学 python chattr 用来改变文件属性 补充说明 chattr命令用来改变文件属性。这项指令可改变存放在ext2文件系统上的文件或目录属性&#xff0c;这些属性共有以下8种模式&#xff1a; 语法 chattr …
阅读更多...
【记录】手机QQ和电脑QQ里的emoji种类有什么差异？

【记录】手机QQ和电脑QQ里的emoji种类有什么差异？

版本 手机 QQ&#xff1a;V 8.9.76.12115 电脑 QQ&#xff1a;QQ9.7.15&#xff08;29157&#xff09; 偶然发现&#xff0c;有一种emoji手机上怎么找都找不到&#xff0c;一开始以为自己失忆了&#xff0c;后来发现这种emoji只在电脑上有。 接下来简单说一下找emoji差异的方式…
阅读更多...
最新文章

Copyright @ 2022~2023