ASP.NET Core MVC 从入门到精通之路由

随着技术的发展,ASP.NET Core MVC也推出了好长时间,经过不断的版本更新迭代,已经越来越完善,本系列文章主要讲解ASP.NET Core MVC开发B/S系统过程中所涉及到的相关内容,适用于初学者,在校毕业生,或其他想从事ASP.NET Core MVC 系统开发的人员。 经过前几篇文章的讲解,初步了解ASP.NET Core MVC项目创建,启动运行,以及ASP.NET Core MVC的命名约定,创建控制器,视图,模型,接收参数,传递数据等内容,今天继续讲解ASP.NET Core MVC 路由等相关内容,仅供学习分享使用。

ASP.NET Core MVC 从入门到精通之路由

 

 

什么是路由?

 

路由是一种机制,主要是用于检查每一个用户请求,将用户请求映射到Action中,这一动作通过路由中间件来实现。ASP.NET Core MVC使用路由中间件来匹配传入请求的URL并将它们映射到操作(Action方法)。

 

默认路由

 

在通过模板创建ASP.NET Core MVC中,默认会添加路由中间件,并提供一种默认的路由映射规则和约束。

MapControllerRoute 用于创建单个路由。 单个路由命名为 default 路由。 大多数具有控制器和视图的应用都使用类似 default 路由的路由模板。如下所示:

 1 using Microsoft.AspNetCore.Server.Kestrel.Core;
 2 using System.Text.Encodings.Web;
 3 using System.Text.Unicode;
 4 
 5 var builder = WebApplication.CreateBuilder(args);
 6 
 7 // Add services to the container.
 8 builder.Services.AddControllersWithViews().AddJsonOptions(options =>
 9 {
10     options.JsonSerializerOptions.Encoder = JavaScriptEncoder.Create(UnicodeRanges.All);
11 });
12 
13 builder.Services.Configure<KestrelServerOptions>(options =>
14 {
15     options.AllowSynchronousIO = true;
16 });
17 
18 var app = builder.Build();
19 
20 // Configure the HTTP request pipeline.
21 if (!app.Environment.IsDevelopment())
22 {
23     app.UseExceptionHandler("/Home/Error");
24     // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
25     app.UseHsts();
26 }
27 
28 app.UseHttpsRedirection();
29 app.UseStaticFiles();
30 //1. 添加路由中间件EndpointRoutingMiddleware
31 app.UseRouting();
32 
33 app.UseAuthorization();
34 
35 //2.为控制器和Action添加一种路由映射规则,包括名称,规则,约束等
36 app.MapControllerRoute(
37     name: "default",
38     pattern: "{controller=Home}/{action=Index}/{id?}");
39 
40 app.Run();

在上述代码中,创建默认路由的关键代码如下所示:

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

其中各个属性说明:

  • name表示路由名称,默认值为default。
  • pattern 为匹配模板,默认值为"{controller=Home}/{action=Index}/{id?}"。其中默认controller=Home,表示缺省值为HomeController,action=Index,表示默认缺省值为Index。id后面的?表示为可空类型,可以根据需要来填写。

 

默认路由示例

 

  • 如:/ 表示controller和action都采用默认值,相当于/Home/Index。
  • 如:/Hello表示只指定了controller,action为默认缺省值,相当于/Hello/Index。
  • 如:/Hello/Test/5 根据路由匹配规则,提取出controller=HelloController , action=Test , id =5 。如果刚好存在此controller和action,则匹配导航成功。

创建默认路由的简便写法,可通过以下代码替代上面的app.MapControllerRoute,如下所示:

1 //创建默认传统路由的简便写法
2 app.MapDefaultControllerRoute();

以上是传统路由的示例。 之所以称为传统路由,是因为它为 URL 路径建立了一个约定:

  • 第一个路径段 {controller=Home} 映射到控制器名称。
  • 第二段 {action=Index} 映射到操作名称。
  • 第三段 {id?} 用于可选 id。 {id?} 中的 ? 使其成为可选。 id 用于映射到模型实体。

此传统路由映射具有以下特点:

  • 仅基于控制器和操作名称。
  • 不基于命名空间、源文件位置或方法参数。

使用默认路由进行传统路由可以创建应用,而无需为每个操作提出新的 URL 模式,有助于简化代码。使 UI 更具可预测性。

 

多个路由

 

在实际应用中,可以设置多个路由,为某些特定的需求设置专有路由。设置多个路由,如下所示:

1 //2.为控制器和Action添加一种路由映射规则,包括名称,规则,约束等
2 app.MapControllerRoute(
3     name: "blog",
4     pattern: "blog/{*article}",
5     defaults: new { controller = "Blog", action = "Article" });
6 
7 app.MapControllerRoute(
8     name: "default",
9     pattern: "{controller=Home}/{action=Index}/{id?}");

在上述代码中,名称为blog的路由,虽然采用的是传统路由,但只用于特定操作。

在创建多个路由时,以下几点需要注意:

  • blog 路由比 default 路由具有更高的匹配优先级,因为它最先添加。
  • 路由名称为路由指定逻辑名称,使用命名路由可以简化 URL 创建,在应用程序范围内必须唯一。
  • 默认情况下,传统路由依赖于顺序。 一般情况下,具有区域的路由应放在路由表中靠前的位置,因为它们比没有区域的路由更具体。也就是:特殊的在前面,通用的在后面

 

不明确操作

 

如果同一个请求有两个action都满足路由终结点的匹配,那么路由会进行如下处理:

  • 选择最佳的候选项。
  • 引发异常。

如下代码,在请求时,会两个都满足路由匹配规则:

 1 /// <summary>
 2 /// 请求需要编辑的学生信息
 3 /// </summary>
 4 /// <param name="id"></param>
 5 /// <returns></returns>
 6 public IActionResult Edit(int id)
 7 {
 8     var student = new Student()
 9     {
10         Id = 1,
11         Name = "公子小六",
12         Age = 21,
13         Sex = ""
14     };
15     return View();
16 }
17 
18 /// <summary>
19 /// 编辑后保存学生信息
20 /// </summary>
21 /// <param name="id"></param>
22 /// <param name="student"></param>
23 /// <returns></returns>
24 public IActionResult Edit(int id, Student student)
25 {
26     //保存学生
27     return View();
28 }

那么路由中间件就会跑出异常,如下所示:

ASP.NET Core MVC 从入门到精通之路由

 

 在这种情况下,要解析正确的路由,需要通过Http谓词来区分,只有当请求为Post时,才会请求Edit(int id,Student student);其他请求时【一般为Get】,匹配Edit(int id)。添加Http谓词后的代码如下:

 1 /// <summary>
 2 /// 请求需要编辑的学生信息
 3 /// </summary>
 4 /// <param name="id"></param>
 5 /// <returns></returns>
 6 public IActionResult Edit(int id)
 7 {
 8     var student = new Student()
 9     {
10         Id = 1,
11         Name = "公子小六",
12         Age = 21,
13         Sex = ""
14     };
15     return View();
16 }
17 
18 /// <summary>
19 /// 编辑后保存学生信息
20 /// </summary>
21 /// <param name="id"></param>
22 /// <param name="student"></param>
23 /// <returns></returns>
24 [HttpPost]
25 public IActionResult Edit(int id, Student student)
26 {
27     //保存学生
28     return View();
29 }

 

属性路由

 

属性路由一般用于WebAPI,使用一组属性将操作直接映射到路由模板,将应用功能建模为一组资源。属性路由使用[Route(template)]标记于controller或action中,示例如下所示:

 1 public class TestController : Controller
 2 {
 3 
 4     [Route("Test1")]
 5     [Route("Test1/Index")]
 6     [Route("Test1/Index/{id?}")]
 7     public IActionResult Index(int id)
 8     {
 9         ViewBag.Id = id;
10         return View();
11     }
12 
13     public IActionResult Test()
14     {
15         return View();
16     }
17 }

运行程序,在浏览器中,输入网址【https://localhost:7116/Test1/Index/10】,如下所示:

ASP.NET Core MVC 从入门到精通之路由

 

注意:属性路由中,也可用标记:[Route("[controller]/[action]")],效果可传统路由一致。

属性路由与传统路由对比

经过以上示例,属性路由与传统路由,主要由以下几点差异:

  •  属性路由需要更多输入才能指定路由,属性路由自定义比较强,更能精准控制路由。
  • 传统默认路由会更简洁地处理路由。 
  • 属性路由优先级高于传统路由。对于属性路由,控制器和操作名称在操作匹配中不起作用,除非使用标记替换。
  • 属性路由支持定义多个访问同一操作的路由,意味着每个路由属性都与操作方法上的每个路由属性相结合。
  • 属性路由支持使用与传统路由相同的内联语法,来指定可选参数、默认值和约束。如:[HttpPost("product14/{id:int}")]

 

保留关键字

 

在ASP.NET Core MVC项目中,会有一些关键字,作为路由参数名称,如下所示:

  • action
  • area
  • controller
  • handler
  • page

在 Razor 视图或 Razor 页面的上下文中保留以下关键字:

  • page
  • using
  • namespace
  • inject
  • section
  • inherits
  • model
  • addTagHelper
  • removeTagHelper

一个常见错误是使用 page 作为属性路由的路由参数。 这样做会导致与 URL 生成不一致和令人困惑的行为。错误示例如下所示:

1 public class TestController : Controller
2 {
3     [Route("/articles/{page}")]
4     public IActionResult ListArticles(int page)
5     {
6         return View(page);
7     }
8 }

 

Http谓词和路由模板

 

在ASP.NET Core MVC项目中,具有以下几种谓词,用于区分不同的请求方式:

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

ASP.NET Core 具有以下路由模板:

  • 所有 HTTP 谓词模板都是路由模板。
  • [Route]

 

混合路由:属性路由与传统路由

 

ASP.NET Core 应用可以混合使用传统路由和属性路由。 通常,对为浏览器提供 HTML 页的控制器使用传统路由,对为 API 提供服务 REST 的控制器使用属性路由。

操作既支持传统路由,也支持属性路由。 通过在控制器或操作上放置路由可实现属性路由。 不能通过传统路由访问定义属性路由的操作,反之亦然。 控制器上的任何路由属性都会使控制器中的所有操作使用属性路由。

属性路由和传统路由使用相同的路由引擎。

以上就是ASP.NET Core MVC从入门到精通之路由的全部内容,旨在抛砖引玉,一起学习,共同进步。

原文链接:https://www.cnblogs.com/hsiang/archive/2023/04/13/17308420.html

本站文章如无特殊说明,均为本站原创,如若转载,请注明出处:ASP.NET Core MVC 从入门到精通之路由 - Python技术站

(0)
上一篇 2023年4月17日
下一篇 2023年4月17日

相关文章

  • C# Winform消息通知系统托盘气泡提示框ToolTip控件

    一、引言 在C# Winform界面开发中,消息通知和提示框往往是必不可少的功能。Winform提供了两种常用的消息通知方式:系统托盘气泡提示和ToolTip控件。本文将详细讲解如何使用这两种控件。 二、系统托盘气泡提示 添加系统托盘图标 在Winform中使用系统托盘气泡提示,首先需要在窗体上添加一个NotifyIcon控件,用于显示图标。添加方法如下: …

    C# 2023年6月7日
    00
  • c#实现服务器性能监控并发送邮件保存日志

    下面就详细讲解“c#实现服务器性能监控并发送邮件保存日志”的完整攻略。 简介 在任何一个需要稳定运行的系统中,服务器的性能监控是非常关键的。我们需要通过服务器性能监控,来检测服务器是否在正常工作,并且在服务器发生异常性能的时候,及时发送邮件通知管理员。本文将介绍如何使用C#来实现服务器性能监控并发送邮件保存日志。 实现方法 以下是实现服务器性能监控并发送邮件…

    C# 2023年6月1日
    00
  • C#中动态显示当前系统时间的实例方法

    下面我将为您详细讲解在C#中动态显示当前系统时间的实例方法的完整攻略。 步骤1:创建新的控制台应用程序 在Visual Studio中创建新的控制台应用程序,命名为“DynamicTime”。 步骤2:添加必要的命名空间 为了使用C#中的DateTime类,我们需要在程序中添加System命名空间。 using System; 步骤3:创建主方法 在Main…

    C# 2023年6月1日
    00
  • C# Linq的OfType()方法 – 返回序列中指定类型的元素

    下面是C# Linq的OfType()方法的详细讲解: C# Linq OfType() 方法的作用 C# Linq OfType() 方法是用于从集合中筛选出具有指定类型的元素的方法。在某些情况下,我们需要从一个集合中仅仅保留某一种类型的元素,这时我们就可以使用 OfType() 方法。 OfType() 方法可以作用于任何实现了 IEnumerable(…

    C# 2023年4月19日
    00
  • C#基础入门之算法:交换

    C#基础入门之算法:交换 算法介绍 交换是一种常用的算法,它可以将两个变量的值互换。在编程中,交换算法经常用于排序、查找、加密等操作中。 实现方法 在C#中,实现变量交换可以采用以下四种方法: 1.使用第三个变量 int a = 3; int b = 5; int temp = a; a = b; b = temp; 2.使用加减法 int a = 3; i…

    C# 2023年6月6日
    00
  • C# 中使用正则表达式匹配字符的含义

    当我们在 C# 中处理字符串时,需要使用正则表达式来匹配相应的字符,例如检测一个字符串是否符合某个特定的格式,或者替换掉字符串中的一些特定字符,这些情况都需要使用正则表达式来进行匹配。 1.正则表达式的基本语法 在 C# 中使用正则表达式,需要使用 System.Text.RegularExpressions 名称空间。我们可以使用 Regex.IsMatc…

    C# 2023年6月8日
    00
  • C#获取视频某一帧的缩略图的方法

    C#获取视频某一帧的缩略图的方法 在C#中,我们可以使用FFmpeg库和GDI+库来获取视频某一帧的缩略图。本文将提供详细的“C#获取视频某一帧的缩略图的方法”的完整攻略,包括如何使用FFmpeg库和GDI+库获取视频某一帧的缩略图,以及两个示例代码。 使用FFmpeg库获取视频某一帧的缩略图 在使用FFmpeg库获取视频某一帧的缩略图时,我们可以使用以下步…

    C# 2023年5月15日
    00
  • C#实现对文件进行加密保护的示例代码

    下面是“C#实现对文件进行加密保护的示例代码”的完整攻略。 一、引言 对文件进行加密保护是信息安全领域中的一个重要问题。C# 是一种流行的编程语言,也是.NET平台的核心语言之一。在C#中,我们可以很容易地实现对文件的加密保护。本文将分享一些如何使用C#加密你的文档的方法和示例代码。 二、C#实现对文件进行加密保护的示例代码 下面是一个简单的示例代码,演示了…

    C# 2023年6月1日
    00
合作推广
合作推广
分享本页
返回顶部