理解ASP.NET Core中的路由

在ASP.NET Core MVC中，路由（Routing）能够实现将请求URL映射到应用程序中Controller和Action，比如请求URL是users/index，那么默认情况下，它将会映射到UsersController以及这个Controller中的Index方法。

一、理解路由

ASP.NET Core中包含两种形式的路由，即基于约定的路由和特性路由。

基于约定的路由（Convention-based Routing）：通常在Startup类的Configure方法中，我们可以创建这一类的路由，这一类的路由通过指定路由约定或路由模块来决定程序对URL的路由方式，这种方式定义的路由对整个应用程序都有效；

特性路由（Attribute Routing）：则是以C#的特性方式，将MVC中定义的路由特性应用到Controller以及Action来为其添加路由，这一种方式仅对特性所应用的Controller或Action有效。

二、基于约定的路由

在应用程序的Startup类中，我们可以这样定义并创建基于约定的路由：

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

上例在添加MVC中间件时，通过IRouteBuilder接口的MapRoute方法添加了一个路由约定，其中约定包含了三部分，即controller、action、id，它们称为路由参数，每一部分通过{}括号括起来。其中controller与action分别表示要映射的Controller与Action，上例中也为它们指定了默认值，分别是Home和Index，而id则通过问号（?）来表示它是可选的。

以下这些URL将能够通过这个约定映射到相应的Controller和Action：

http://localhost/home/index/3

http://localhost/blogs/all

http://localhost/

其中第二个URL并没有按照约定提供完整的信息，但它也能够被正确路由，是因为第三部分id是可选的；而第三个URL并没有指定约定中的任何信息，这是因为在定义路由时为controller与index均提供了默认值。

除了能够在路由约定中为参数指定默认值以及添加可选参数外，我们还可以为路由参数添加限制，限制包含数据类型的方面的限制，比如我们希望id参数只能是int类型，就可以这样定义：

{controller}/{action}/{id:int}

类似的限制还可以是:bool、:datetime、:guid等，除了限制数据类型外，也可以限制参数值的范围，如:length(min,max)；更多的路由参数限制，可以参考这里：https://docs.microsoft.com/aspnet/core/fundamentals/routing#route-constraint-reference。

最后，需要注意的，当在Configure方法中添加了多个约定时，要注意约定的添加顺序，MVC会根据顺序对URL进行映射。

三、特性路由

特性路由能够为具体的某个Controller或Action设置路由，方法是使用[Route]特性：

[Route("home")]public class HomeController : Controller{    [Route("index")]    [Route("hello")]    public IActionResult Index()    {        return Content("Hello");    }}

这样，使用/home/index或/home/hello均可以映射到HomeController中的Index方法。这里我们可以得到以下几点结论：

1、对Controller添加的[Route]特性对其下的每个Action都有效；

2、可以为Controller或Action指定多个[Route]特性以支持多种不同的请求URL形式；

3、通过[Route]特性指定路由时，其中指定的路由值可以与Controller的类名或Action的方法名不一样，如上例的hello。

对于第3点，如果不希望自己手动填写路由值（如home、index等），那么，可以使用[controller]或[action]标记来表示当前Controller或Action。

[Route("[controller]")]public class HomeController : Controller{    [Route("")]    [Route("[action]")]    public IActionResult Index()    {        return View();    }}

这样，/home/index同样能够映射到上述Action。

如果想要向Action方法传递参数，则可以在路由值中使用{parameterName}来表示参数，如：

[Route("[controller]/[action]/{id?}")]public string Index(string id) {    …}

这样URL中的id就能够传递给Action的参数。

四、特性路由的使用——HTTP动词特性

特性路由更为常见的使用方式是通过HTTP动词特性来创建，如[HttpGet]、[HttpPost]、[HttpPut]、[HttpPatch]、[HttpDelete]、[HttpHead]；将这些特性应用在一个Action上，不仅能够设置当前Action所支持的HTTP方法，并且也能够为其指定路由以及方法参数。

特性路由在Web API开发中很常见，以下一个典型的API Controller以及特性路由的使用。

[Route("api/[controller]")]public class ValuesController : ControllerBase{    // GET api/values    [HttpGet]    public ActionResult<IEnumerable<string>> Get()    {        return new string[] { "value1", "value2" };    }    // GET api/values/5    [HttpGet("{id}")]    public ActionResult<string> Get(int id)    {        return "value";    }    // POST api/values    [HttpPost]    public void Post([FromBody] string value)    {    }    // PUT api/values/5    [HttpPut("{id}")]    public void Put(int id, [FromBody] string value)    {    }    // DELETE api/values/5    [HttpDelete("{id}")]    public void Delete(int id)    {    }}

可以看到，其中每个Action均包含了一个HTTP动词特性，这个特性不仅标识当前Action支持的HTTP方法，并且也可以定义路由以及路由参数。

最后，需要特别注意的是，特性路由的优先级要高于基于约定的路由，如果为一个Controller或其中的Action指定了特性路由，那么基于约定的路由对它就没有效果。因此，尽管我们可以在同一个应用程序中同时使用这两种方式，我们也应该注意对这两种使用方式加以区别，比如一部分Controller使用基于约定的方式，而另一部分使用特性路由的方式。一般情况下，建议在同一个程序中使用一种方式即可。

总结

本文简要地介绍了ASP.NET Core MVC中的路由以及两种创建路由的方式。理解如何创建路由会使我们能够灵活地控制请求URL的形式以及它们映射到Controller和Action的方式。