ASP.NET Core MVC 初探

最新推荐文章于 2025-10-14 11:43:02 发布

转载最新推荐文章于 2025-10-14 11:43:02 发布 · 1.3k 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://blog.youkuaiyun.com/WuLex

文章标签：

#mvc #asp.net

ASP.NET Core MVC | Blazor 专栏收录该内容

234 篇文章

订阅专栏

本文详细介绍了ASP.NET Core中如何启用和配置MVC模型，包括路由服务、默认路由、自定义路由、约束和数据令牌的使用。核心服务如MVCCore、认证授权、视图处理等也被深入探讨。

ASP.NET Core完全支持传统的ASP.NET模型 - 视图 - 控制器（MVC）应用程序模型，其中传入请求的URL被解析为一对控制器/操作项，其中控制器项标识类名，操作项标识控制器类上的方法。如果要使用ASP.NET Core MVC 模型，必须显式的启用。

注册MVC服务

MVC应用程序模型的核心是MvcRouteHandler服务，它是负责解析MVC路由的URL，调用所选控制器方法以及处理操作结果的引擎。

注意：MvcRouteHandler也是经典ASP.NET MVC实现中使用的类的名称。但是，在经典的ASP.NET MVC中，该类的作用比ASP.NET Core中的作用更为有限。为了捕捉该类在ASP.NET Core中的作用，而不仅仅依赖于搜索引擎的能力，最好直接查看它的实现。

要将MvcRouteHandler服务添加到ASP.NET Host，只需向启动类的ConfigureServices()方法添加一行代码即可。

public void ConfigureServices(IServiceCollection services)
{
	services.AddMvc();
}

AddMvc()方法有两个重载。无参数方法接受MVC服务的所有默认设置。第二个重载，如下所示，允许您选择临时选项。

services.AddMvc(options =>
{
    options.ModelBinderProviders.Add(new SmartDateBinderProvider());
    options.SslPort = 345;
});

选项通过MvcOptions类的实例指定。该类是可以在MVC框架中更改的配置参数的容器。例如，上面的代码片段添加了一个新的模型绑定器，它将特定字符串解析为有效日期，并指定在使用RequireHttpsAttribute修饰控制器类时要使用的SSL端口。完整的可配置选项列表可在此处找到：https://docs.microsoft.com/zh-cn/dotnet/api/microsoft.aspnetcore.mvc.mvcoptions

已启用的其他附加服务

当使用AddMvc()方法注册服务后，在该方法下，许多其他服务也一同被初始化并添加到管道中。

下面是使用AddMvc()方法后，一同被启用的MVC服务介绍：

MVC Core：MVC应用程序模型的核心服务集，包括路由和控制器。
API Explorer：服务负责收集和公开有关控制器和动作的信息，以便动态发现功能和帮助页面。
Authorization：认证和授权背后的服务。
Default Framework Parts：将输入标记助手和URL解析助手添加到应用程序部件列表的服务。
Formatter Mappings：设置默认媒体类型映射的服务。
Views：处理操作的服务结果为HTML视图。
Razor Engine：将Razor视图和页面引擎注册到MVC系统中。
Tag Helpers：服务引用标签助手的框架部分。
Data Annotations：服务以引用关于数据注释的框架部分。
JSON Formatters：处理操作的服务结果为JSON流。
CORS：服务以引用关于跨源资源共享（CORS）的框架部分。

注意：在上述服务中，某些服务仅在您公开Web API时才有用。这些服务是API Explorer，Formatter Mappings和CORS。

如果您有内存限制 - 例如，您在云中托管应用程序 - 您可能希望应用程序只引用框架的裸机。上述中的服务列表可以缩短; 缩短程度主要取决于您在应用程序中需要具备的实际功能。以下代码足以在没有更高级功能的情况下提供纯HTML视图，例如表单验证和标记帮助程序的数据注释。

public void ConfigureServices(IServiceCollection services)
{
    var builder = services.AddMvcCore();
    builder.AddViews();
    builder.AddRazorViewEngine();
}

但是，上面的代码不足以返回格式化的JSON数据。要添加该功能，您只需添加：

builder.AddJsonFormatters();

激活MVC服务

在启动类的Configure()方法中，调用UseMvc()方法来配置ASP.NET Core管道以支持MVC应用程序模型。此时，除了传统路由之外，MVC应用程序模型周围的所有内容都已完全设置。

路由是应用程序可以识别和处理的URL模板。路由最终映射到一对控制器和操作名称。可以根据需要添加任意数量的路由，这些路由几乎可以采用你喜欢的任何形式。内部MVC服务负责请求路由，启用MVC Core服务时会自动注册。

启用常规路由

为了可以使用，你的应用程序应提供规则来选择它想要处理的URL。但是，并非所有可行的URL都必须明确列出，一个或多个带占位符的URL模板将完成这项工作。存在默认路由规则，有时称为传统路由。通常，默认路由足以满足整个应用程序的需要。

添加默认路由

如果您对路由没有任何特殊顾虑，最简单的方法是仅使用默认路由。

public void Configure(IApplicationBuilder app)
{
    app.UseMvcWithDefaultRoute();
}

UseMvcWithDefaultRoute()方法背后的实际代码如下所示：

public void Configure(IApplicationBuilder app)
{
    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "default",
            template: "{controller=Home}/{action=Index}/{id?}");
    });
}

路由参数在传入请求的整体处理中起着关键作用，特别是名为controller和action的路由参数，因为它们以某种方式指向实际产生响应的代码。任何成功映射到路由的请求都将通过在控制器类上执行方法来处理。名为controller的路由参数标识控制器类，名为action的路由参数标识要调用的方法。

没有配置路由时

可以在没有参数的情况下调用UseMvc()方法。发生这种情况时，ASP.NET MVC应用程序功能齐全，但没有可以处理的已配置路由。

public void Configure(IApplicationBuilder app)
{
    app.UseMvc();
}

上面的代码完全等同于下面的代码段：

app.UseMvc(routes => { });

如果在Configure()方法中存在如下代码：

//使用默认路由配置
app.UseMvcWithDefaultRoute();
//添加终止中间件到管道
app.Run(async (context) =>
{
    await context.Response.WriteAsync("Hello World!");
});

如果使用了UserMvc()或者UseMvcWithDefaultRoute()语句，它们会改变管道的结构，当使用了与配置的路由相匹配的控制器和视图访问页面时，它将绕过了你可能定义的任何终止中间件（比如上述中的输出“Hello World”语句），优先显示视图对应的页面内容，只有在找不到路由的情况下，或者由于缺少控制器或方法而无法工作（终止中间件），则终止中间件将重新获得管道中的位置并按预期运行（即会输出“Hello world”）。

路由服务和管道

在内部，UseMvc()方法定义路由构建器服务并将其配置为使用提供的路由和默认处理程序。默认处理程序是MvcRouteHandler类的实例，该类负责查找匹配的路由以及从模板中提取控制器和操作方法名称。

此外，MvcRouteHandler类还将尝试执行action方法。如果成功，它会将请求的上下文标记为已处理，以便没有其他中间件可以触及生成的响应。否则，它允许请求继续通过管道直到完全处理。
在这里插入图片描述
注意：在传统的ASP.NET MVC中，如果找不到URL的匹配路由，将导致HTTP 404状态代码。相反，在ASP.NET Core中，任何终止中间件都有机会处理请求。

配置路由表

定义路由的方式有两种，配置URL模板或者定义属性路由。

路由剖析

路由基本上由唯一名称和URL模板指定。 URL模板可以由静态文本组成，也可以包括动态参数，其值从URL和可能的整个HTTP上下文中摘录。定义路由的完整语法如下所示。

app.UseMvc(routes => 
{   
   routes.MapRoute(
       name: "your_route",
       template: "...",
       defaults: new { controller = "...", action = "..." },
       constraints: { ... },
       dataTokens: { ... });
})

template参数指的是您选择的URL模式。如上所述，对于默认的常规路由，它等于：

{controller}/{action}/{id?}

定义其他路由可以采用您喜欢的任何形式，并且可以包括静态文本和自定义路由参数。 defaults参数指定模板中的路由参数的默认值。 template参数可以与defaults参数融合。发生这种情况时，省略defaults参数，模板参数采用以下形式。

template: "{controller=Home}/{action=Index}/{id?}"

如上所述，如果?符号附加到参数名称，表示该参数是可选的。

constraints参数指的是在特定路由参数上设置的约束，例如可接受的值或所需类型。

dataTokens参数引用与路由关联的其他自定义值，但不用于确定路由是否与URL模式匹配。

定义自定义路由

常规路由从URL的各个分段自动计算出控制器和方法名称。自定义路由只使用替代算法来计算相同的信息。更常见的是，自定义路由由显式映射到控制器/方法对的静态文本组成。

通常，不需要禁用传统路由，只需添加一些临时路由即可拥有一些受控URL来调用应用程序的某种行为。

为了说明自定义路由的使用，首先定义一个控制器/视图，代码如下：

DateController：

public class DateController : Controller
{
    public IActionResult Day(int offset)
    {
        return Content(DateTime.Now.AddDays(offset).ToShortDateString());
    }
    public IActionResult Index()
    {
        return View();
    }
}

然后在Configure()方法中，自定义路由：

public void Configure(IApplicationBuilder app, IHostingEnvironment env)
{
    if (env.IsDevelopment())
    {
        app.UseDeveloperExceptionPage();
    }
    //自定义路由
    app.UseMvc(routes =>
    {
        routes.MapRoute(
            name: "route-today",
            template: "today",
            defaults: new { controller = "date", action = "day", offset = 0 });
        routes.MapRoute(
            name: "route-yesterday",
            template: "yesterday",
            defaults: new { controller = "date", action = "day", offset = -1 });
        routes.MapRoute(
            name: "route-tomorrow",
            template: "tomorrow",
            defaults: new { controller = "date", action = "day", offset = 1 });
    });
    //常规路由（默认路由）
    app.UseMvcWithDefaultRoute();
    app.Run(async (context) =>
    {
        await context.Response.WriteAsync("Hello World!");
    });
}

访问方式一，使用路由template进行访问：

http://localhost:17699/today
http://localhost:17699/tomorrow
http://localhost:17699/yesterday

使用上述形式访问，将会自动把offset = 0 / offset = 1 / offset = -1 赋值给控制器中的Day(int offset)的offset参数。即控制器中的方法参数offset可以得到传入的实参值

访问方式二，结合传统路由使用URL参数形式进行访问：

http://localhost:17699/date/day?offset=4

上述形式进行访问，将会自动映射到控制器Date中的Day()方法，并将传入的?offset=4自动映射到offset参数，即offset参数也可以得到实际传入的值。

错误访问形式：

//错误访问形式
http://localhost:17699/date/day/4

注意：如果使用上述中的访问形式，虽然也能调用DateController中的Day视图，但是参数offset却不能得到正确的值，虽然在URL中，传入了4，但是Day(int offset)方法并不能正确解析offset参数的值，将会始终为0（int默认值），之所以这样，是因为，虽然/date/day/4与任何自定义路由都不匹配，但是它与默认路由完美匹配。controller参数设置为Date，action参数设置为Day，但是，默认路由具有第三个可选参数——id参数，其值从URL的第三个段中摘取，也就是URL中的值4实际分配给了名为id的变量，而不是名为offset的变量。这样一来，offset变量的值将始终是int默认值0。如下图所示，假如将控制器中的方法改写，指定变量id，调用/date/day/4，将会看到：
在这里插入图片描述

如果想要使用/date/day/4访问，并且正确的解析到变量offset的值，可以在自定义路由中添加一个新路由：

//使用/date/day/8这种形式进行访问
routes.MapRoute(
    name: "route-day",
    template: "date/day/{offset}", 
    defaults: new { controller = "date", action = "day", offset = 0 });

如果定义了上述这种形式的路由，就可以使用/date/day/4这种形式进行访问。同样，将之前的路由进行改写：

//使用/today/10这种形式进行访问
routes.MapRoute(
    name: "route-today",
    template: "today/{offset}",
    defaults: new { controller = "date", action = "day", offset = 0 });

此时，就可以使用/today/10这种形式进行访问了，使用/{offset}这样形式配置路由模板，可以在控制器中的视图方法中正确的解析到参数offset的值。

注意：无论用于请求的HTTP谓词如何，MapRoute()方法都将URL映射到一对控制器/方法。您也可以使用其他映射方法（如MapGet，MapPost和MapVerb）映射到特定的URL动词。

路由顺序

如果不使用自定义路由时，可以直接使用传统路由。否则，必须在启用常规路由之前，列出所有的自定义路由，这是因为，当使用多个路由时，路由服务将从上到下扫描路由表，并在路由表出现时对其进行评估，扫描到第一个匹配项时就停止，因此，自定义路由应在默认路由之前定义，这样可以避免默认路由贪婪捕获URL的风险。

例如，上述示例中，如果将app.UseMvcWithDefaultRoute()语句放在自定义路由之前，那么当使用/today请求时，默认路由将会先解析Today控制器和Index方法，如果程序中缺少TodayController和Index操作方法，则会丢弃默认路由，并继续搜索下一个路由，直到找到匹配的路由，如果都没有找到，将会抛出404错误。因此，常见的做法是，在默认路由之后，定义一个包含所有路由的形式，即它能在自定义路由和默认路由都不能匹配的情况下进行匹配，从而避免程序报错，甚至可以作为一个恢复步骤，代码如下：

 //定义路由
 ...
 //常规路由
 app.UseMvcWithDefaultRoute();
//路由都不能解析的情况下，定义的全能路由
 app.UseMvc(routes =>
 {
     routes.MapRoute(
         name: "catch-all", 
         template: "{*url}", 
         defaults: new { controller = "error", action = "message" });
 });

上述代码中中，catch-all路由映射到ErrorController类的Message方法，该方法接受名为url的路由参数。星号符号表示此参数抓取URL的其余部分。

以编程方式访问路由数据

有关与请求的URL匹配的路由的可用信息将保存到RouteData类型的数据容器中。例如，当我们使用/yesterday进行访问时，在控制器中监视RouteData属性，可以看到下图所示数据：
在这里插入图片描述
传入的URL已与默认路由匹配，并且由于URL模式，第一个段映射到控制器路由参数，而第二个段映射到操作路由参数。路径参数通过{parameter}表示法在URL模板中定义。相反，{parameter = value}表示法定义了在缺少给定段的情况下要使用的参数的默认值。可以使用以下表达式以编程方式访问路径参数：

var controller= RouteData.Values["controller"];
var action = RouteData.Values["action"];

如果控制器不是从基类Controller继承得到的，则不能直接获取RouteData属性。此时需要注入一个可以操作上下文的服务——注入IActionContextAccessor服务。代码如下：

PocoController没有继承自基类Controller，它就是一个普通的类：

public class PocoController
{
    private IActionContextAccessor _accessor;
    //将一个操作上下文访问器注入控制器
    public PocoController(IActionContextAccessor accessor)
    {
        _accessor = accessor;
    }
    public IActionResult Index()
    {
        object controller = _accessor.ActionContext.RouteData.Values["controller"];
        object action = _accessor.ActionContext.RouteData.Values["action"];
        string text = string.Format("{0}.{1}", controller, action);
        return new ContentResult { Content = text };
    }
}

在Startup.cs中的ConfigureServices()中添加该服务：

services.AddSingleton<IActionContextAccessor, ActionContextAccessor>();

此时直接访问/poco，可以在页面中显示对应的结果。

注意：不建议注入IActionContextAccessor服务去访问RouteData，因为它表现不佳，更重要的是，很少真正需要它，因为大多数都可以使用模型绑定来获取输入的HTTP数据。

路由的高级应用

可以通过约束和数据标记进一步表示路由。约束是一种与路由参数关联的验证规则，如果未验证约束，则路由不匹配。相反，数据令牌是与可用于控制器的路由相关联的简单信息位，但不用于确定URL是否与路由匹配。

路由约束

从技术上讲，约束是一个实现IRouteConstraint接口的类，它实质上验证了传递给指定路由参数的值。例如，您可以使用约束来确保仅当给定参数接收到期望类型的值时才匹配路由。以下是定义路由约束的方法：

//路由约束
app.UseMvc(routes =>
{
    routes.MapRoute(
        name: "route-today",
        template: "today/{offset}",
        defaults: new { controller = "date", action = "day", offset = 0 },
        constraints: new { offset = new IntRouteConstraint() });
});

在该示例中，路由的offset参数受IntRouteConstraint类的操作影响，IntRouteConstraint类是ASP.NET MVC Core框架中的预定义约束类之一。你可以查看源码了解IntRouteConstraint的实现，它的实质是由约束类从路由值的字典中提取routeKey参数的值，并对其进行合理的检查。 IntRouteConstraint类只是检查该值是否可以成功解析为整数。

注意，约束可以与唯一的名称字符串相关联，该字符串解释了如何使用约束。约束名称可用于更紧凑地指定约束。如下：

routes.MapRoute(
    name: "route-day",
    template: "date/day/{offset:int}",
    defaults: new { controller = "date", action = "day", offset = 0 });

IntRouteConstraint类的名称是int，意味着{offset:int}将类的操作与offset参数相关联。 IntRouteConstraint是ASP.NET MVC Core中预定义的路径约束类之一，它们的名称在启动时设置并完整记录。如果创建自定义约束类，则应在向系统注册时设置约束的名称，假如存在一个自定义约束类YourRouteConstraint，同样实现了IRouteConstraint接口，此时你可以使用下述语句先注册该约束：

services.Configure<RouteOptions>(options => 
    options.ConstraintMap.Add("your-routes", typeof(YourRouteConstraint)));

基于此，您现在可以使用{parametername：contraintprefix}表示法将约束绑定到给定的路由参数。

预定义的路由约束

映射名称	类	描述
Int	IntRouteConstraint	确保route参数设置为整数
Bool	BoolRouteConstraint	确保将route参数设置为布尔值
datetime	DateTimeRouteConstraint	确保将route参数设置为有效日期
decimal	DecimalRouteConstraint	确保route参数设置为decimal
double	DoubleRouteConstraint	确保route参数设置为double
Float	FloatRouteConstraint	确保route参数设置为float
Guid	GuidRouteConstraint	确保将route参数设置为GUID
Long	LongRouteConstraint	确保将route参数设置为长整数
minlength(N)	MinLengthRouteConstraint	确保将route参数设置为不短于指定长度的字符串
maxlength(N)	MaxLengthRouteConstraint	确保将route参数设置为不超过指定长度的字符串
length(N)	LengthRouteConstraint	确保将route参数设置为指定长度的字符串
min(N)	MinRouteConstraint	确保将route参数设置为大于指定值的整数
max(N)	MaxRouteConstraint	确保将route参数设置为小于指定值的整数
range(M, N)	RangeRouteConstraint	确保将route参数设置为落在指定值范围内的整数
alpha	AlphaRouteConstraint	确保将route参数设置为由字母字符组成的字符串
regex(RE)	RegexInlineRouteConstraint	确保将route参数设置为符合指定正则表达式的字符串
required	RequiredRouteConstraint	确保route参数在URL中具有指定的值

如果要确保路由参数从一组已知的可能值中获取值，要以这种方式约束参数，可以使用正则表达式，如下所示：

{format:regex(json|xml|text)}

此时，仅当参数采用任何列出的子字符串时，URL才会匹配具有此类格式参数的路由。

例如，假如必须使用/tomorrow/A或者/tomorrow/B，或者/tomorrow/C才能访问该路由，可以在template参数中，显示的指定正则表达式进行约束：

routes.MapRoute(
    name: "route-tomorrow",
    template: "tomorrow/{format:regex(A|B|C)}",
    defaults: new { controller = "date", action = "day", offset = 1 });

此时，如果只使用/tomorrow访问，并不能正确解析到指定的控制器中。

数据令牌（Data Tokens）

在ASP.NET MVC中，路由不限于URL中的信息。 URL段用于确定路由是否与请求匹配，但是附加信息可以与路由相关联并且稍后以编程方式检索。要将额外信息附加到路径，请使用数据令牌。

数据令牌是使用路由定义的，只不过是名称/值对。任何路由都可以包含任意数量的数据令牌。数据令牌是未用于匹配路由的URL的免费信息位。

//数据令牌
app.UseMvc(routes =>
{
    routes.MapRoute(
        name: "catch-all",
        template: "{*url}",
        defaults: new { controller = "home", action = "index" },
        constraints: new { },
        dataTokens: new { reason = "catch-all" });
});

数据令牌不是ASP.NET MVC路由系统必不可少的必备功能，但它们有时很有用。例如，假设您有一个映射到控制器/操作对的catch-all路由，该路由也用于其他目的，并且假设Home控制器的Index方法用于与任何路由都不匹配的URL 。如果无法确定更具体的URL，则想法显示主页。如何区分主页的直接请求和由于全部路由而显示的主页？数据令牌是一种选择。以下是以编程方式检索数据令牌的方法。

var catchall = RouteData.DataTokens["reason"] ?? "";

数据令牌使用路由定义，但仅以编程方式使用。

ASP.NET MVC请求响应的过程概述

在这里插入图片描述
路由是获取HTTP请求以生成响应的较长过程的第一步。路由过程的最终结果是配对的控制器/操作，它将处理未映射到物理静态文件的请求。

首先，URL通过路由系统并映射到控制器名称和操作名称。

动作调用者（Action Invoker）

动作调用程序是整个ASP.NET MVC基础结构的核心，也是编排处理请求所需的所有步骤的组件。动作调用程序接收控制器工厂和控制器上下文，填充路径数据和HTTP请求信息的容器对象。如上图所示，调用程序运行自己的操作过滤器管道，并为实际执行请求之前和之后运行的某些临时应用程序代码提供挂钩。

调用者使用反射来创建所选控制器类的实例并调用所选方法。在这样做时，它还解析方法和构造函数的参数，从HTTP上下文读取，路由数据和系统的DI容器。

任何控制器方法都应该返回包含在IActionResult容器中的对象。顾名思义，控制器方法仅返回用于生成将发送回客户端的实际响应的数据。控制器方法决不会直接写入响应输出流。控制器方法确实具有对响应输出流的编程访问，但推荐的模式是该方法将数据打包到动作结果对象中，并向调用者提供有关如何进一步处理它的指令。