关注小程序 找一找教程网-随时随地学编程

路由

在 ASP.NET Core 中路由到控制器操作

作者:Ryan NowakRick Anderson

ASP.NET Core MVC 使用路由中间件来匹配传入请求的 URL 并将它们映射到操作。 路由在启动代码或属性中定义。 路由描述应如何将 URL 路径与操作相匹配。 它还用于在响应中生成送出的 URL(用于链接)。

操作既支持传统路由,也支持属性路由。 通过在控制器或操作上放置路由可实现属性路由。 有关详细信息,请参阅混合路由

本文档将介绍 MVC 与路由之间的交互,以及典型的 MVC 应用如何使用各种路由功能。 有关高级路由的详细信息,请参阅路由

设置路由中间件

Configure 方法中,可能会看到与下面类似的代码:

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

在对 UseMvc 的调用中,MapRoute 用于创建单个路由,亦称 default 路由。 大多数 MVC 应用使用带有模板的路由,与 default 路由类似。

路由模板 "{controller=Home}/{action=Index}/{id?}" 可以匹配诸如 /Products/Details/5 之类的 URL 路径,并通过对路径进行标记来提取路由值 { controller = Products, action = Details, id = 5 } MVC 将尝试查找名为 ProductsController 的控制器并运行 Details 操作:

public class ProductsController : Controller
{
   public IActionResult Details(int id) { ... }
}

请注意,在此示例中,当调用此操作时,模型绑定会使用值 id = 5id 参数设置为 5 有关更多详细信息,请参阅模型绑定

使用 default 路由:

routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");

路由模板:

  • {controller=Home}Home 定义为默认 controller

  • {action=Index}Index 定义为默认 action

  • {id?}id 定义为可选参数

默认路由参数和可选路由参数不必包含在 URL 路径中进行匹配。 有关路由模板语法的详细说明,请参阅路由模板参考

"{controller=Home}/{action=Index}/{id?}" 可以匹配 URL 路径 / 并生成路由值 { controller = Home, action = Index } controlleraction 的值使用默认值,id 不生成值,因为 URL 路径中没有相应的段。 MVC 使用这些路由值选择 HomeControllerIndex 操作:

public class HomeController : Controller
{
  public IActionResult Index() { ... }
}

通过使用此控制器定义和路由模板,将对以下任意 URL 路径执行 HomeController.Index 操作:

  • /Home/Index/17

  • /Home/Index

  • /Home

  • /

简便方法 UseMvcWithDefaultRoute

app.UseMvcWithDefaultRoute();

可用于替换:

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

UseMvcUseMvcWithDefaultRoute 可向中间件管道添加 RouterMiddleware 的实例。 MVC 不直接与中间件交互,而是使用路由来处理请求。 MVC 通过 MvcRouteHandler 实例连接到路由。 UseMvc 内的代码与下面类似:

var routes = new RouteBuilder(app);

// Add connection to MVC, will be hooked up by calls to MapRoute.
routes.DefaultHandler = new MvcRouteHandler(...);

// Execute callback to register routes.
// routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");

// Create route collection and add the middleware.
app.UseRouter(routes.Build());

UseMvc 不直接定义任何路由,它向 attribute 路由的路由集合添加占位符。 重载 UseMvc(Action<IRouteBuilder>) 则允许用户添加自己的路由,并且还支持属性路由。 UseMvc 及其所有变体都会为属性路由添加占位符:无论如何配置 UseMvc,属性路由始终可用。 UseMvcWithDefaultRoute 定义默认路由并支持属性路由。 属性路由部分提供了有关属性路由的更多详细信息。

传统路由

default 路由:

routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");

是一种传统路由 将这种样式称为传统路由的原因在于,它为 URL 路径设立了一个约定

  • 第一个路径段映射到控制器名称

  • 第二段映射到操作名称。

  • 第三段用于可选 id(用于映射到模型实体)

使用此 default 路由时,URL 路径 /Products/List 映射到 ProductsController.List 操作,/Blog/Article/17 映射到 BlogController.Article 此映射基于控制器和操作名称,而不基于命名空间、源文件位置或方法参数。

提示

使用默认路由进行传统路由时,可快速生成应用程序,无需为所定义的每项操作提供一个新的 URL 模式。 对于包含 CRUD 样式操作的应用程序,通过保持各控制器间 URL 的一致性,可帮助简化代码,使 UI 更易预测。

警告

路由模板将 id 定义为可选参数,意味着无需在 URL 中提供 ID 也可执行操作。 从 URL 中省略 id 通常会导致模型绑定将它设置为 0,进而导致在数据库中找不到与 id == 0 匹配的实体。 属性路由可以提供细化控制,使某些操作需要 ID,某些操作不需要 ID。 按照惯例,当可选参数(比如 id)有可能在正确的用法中出现时,本文档将涵盖这些参数。

多个路由

通过添加对 MapRoute 的多次调用,可以在 UseMvc 内添加多个路由。 这样做可以定义多个约定,或添加专用于特定操作的传统路由,比如:

app.UseMvc(routes =>
{
   routes.MapRoute("blog", "blog/{*article}",
            defaults: new { controller = "Blog", action = "Article" });
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

此处的 blog 路由是一个专用的传统路由,这表示它使用传统路由系统,但专用于特定的操作。 由于 controlleraction 不会在路由模板中作为参数显示,它们只能有默认值,因此,此路由将始终映射到 BlogController.Article 操作。

路由集合中的路由会进行排序,并按添加顺序进行处理。 因此,在此示例中,将先尝试 blog 路由,再尝试 default 路由。

备注

专用传统路由通常使用 catch-all 路由参数(比如 {*article})来捕获 URL 路径的剩余部分。 这会使某个路由变得“太贪婪”,也就是说,它会匹配用户想要使用其他路由来匹配的 URL。 将“贪婪的”路由放在路由表中靠后的位置可解决此问题。

回退

在处理请求时,MVC 将验证路由值能否用于在应用程序中查找控制器和操作。 如果路由值与任何操作都不匹配,则将该路由视为不匹配,并尝试下一个路由。 这称为回退,其目的是简化传统路由重叠的情况。

区分操作

当通过路由匹配到两项操作时,MVC 必须进行区分,以选择“最佳”候选项,否则会引发异常。 例如:

public class ProductsController : Controller
{
   public IActionResult Edit(int id) { ... }

   [HttpPost]
   public IActionResult Edit(int id, Product product) { ... }
}

此控制器定义了两项操作,这两项操作均与 URL 路径 /Products/Edit/17 和路由数据 { controller = Products, action = Edit, id = 17 } 匹配。 这是 MVC 控制器的典型模式,其中 Edit(int) 显示用于编辑产品的表单,Edit(int, Product) 处理已发布的表单。 为此,MVC 需要在请求为 HTTP POST 时选择 Edit(int, Product),在 Http 谓词为任何其他内容时选择 Edit(int)

HttpPostAttribute ( [HttpPost] ) 是 IActionConstraint 的实现,它仅允许执行当 Http 谓词为 POST 时选择的操作。 IActionConstraint 的存在使 Edit(int, Product) 成为比 Edit(int)“更好”的匹配项,因此会先尝试 Edit(int, Product)

只需在特殊化方案中编写自定义 IActionConstraint 实现,但务必了解 HttpPostAttribute 等属性的角色 — 为其他 Http 谓词定义了类似的属性。 在传统路由中,当操作属于 show form -> submit form 工作流时通常使用相同的操作名称。 在阅读了解 IActionConstraint 部分后,此模式的便利性将变得更加明显。

如果匹配多个路由,但 MVC 找不到“最佳”路由,则会引发 AmbiguousActionException

路由名称

以下示例中的字符串 "blog""default" 都是路由名称:

app.UseMvc(routes =>
{
   routes.MapRoute("blog", "blog/{*article}",
               defaults: new { controller = "Blog", action = "Article" });
   routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

路由名称为路由提供一个逻辑名称,以便使用命名路由来生成 URL。 路由排序会使 URL 生成复杂化,而这极大地简化了 URL 创建。 路由名称必须在应用程序范围内唯一。

路由名称不影响请求的 URL 匹配或处理;它们仅用于 URL 生成。 路由提供了有关 URL 生成(包括 MVC 特定帮助程序中的 URL 生成)的更多详细信息。

属性路由

属性路由使用一组属性将操作直接映射到路由模板。 在下面的示例中,Configure 方法使用 app.UseMvc();,不传递任何路由。 HomeController 将匹配一组 URL,这组 URL 与默认路由 {controller=Home}/{action=Index}/{id?} 匹配的 URL 类似:

public class HomeController : Controller
{
   [Route("")]
   [Route("Home")]
   [Route("Home/Index")]
   public IActionResult Index()
   {
      return View();
   }
   [Route("Home/About")]
   public IActionResult About()
   {
      return View();
   }
   [Route("Home/Contact")]
   public IActionResult Contact()
   {
      return View();
   }
}

将针对任意 URL 路径 //Home/Home/Index 执行 HomeController.Index() 操作。

备注

此示例重点介绍属性路由与传统路由之间的主要编程差异。 属性路由需要更多输入来指定路由;传统的默认路由处理路由的方式则更简洁。 但是,属性路由允许(并需要)精确控制应用于每项操作的路由模板。

使用属性路由时,控制器名称和操作名称对于操作的选择没有影响。 此示例匹配的 URL 与上一示例相同。

public class MyDemoController : Controller
{
   [Route("")]
   [Route("Home")]
   [Route("Home/Index")]
   public IActionResult MyIndex()
   {
      return View("Index");
   }
   [Route("Home/About")]
   public IActionResult MyAbout()
   {
      return View("About");
   }
   [Route("Home/Contact")]
   public IActionResult MyContact()
   {
      return View("Contact");
   }
}

备注

上述路由模板未定义 actionareacontroller 的路由参数。 事实上,属性路由中不允许使用这些路由参数。 由于路由模板已与某项操作关联,因此,分析 URL 中的操作名称毫无意义。

使用 Http[Verb] 属性的属性路由

属性路由还可以使用 Http[Verb] 属性,比如 HttpPostAttribute 所有这些属性都可采用路由模板。 此示例展示与同一路由模板匹配的两项操作:

[HttpGet("/products")]
public IActionResult ListProducts()
{
   // ...
}

[HttpPost("/products")]
public IActionResult CreateProduct(...)
{
   // ...
}

对于诸如 /products 之类的 URL 路径,当 Http 谓词为 GET 时将执行 ProductsApi.ListProducts 操作,当 Http 谓词为 POST 时将执行 ProductsApi.CreateProduct 属性路由首先将 URL 与路由属性定义的路由模板集进行匹配。 一旦某个路由模板匹配,就会应用 IActionConstraint 约束来确定可以执行的操作。

提示

生成 REST API 时,很少会在操作方法上使用 [Route(...)]这是因为该操作将接受所有 HTTP 方法。 建议使用更特定的 Http*Verb*Attributes 来明确 API 所支持的操作。 REST API 的客户端需要知道映射到特定逻辑操作的路径和 Http 谓词。

由于属性路由适用于特定操作,因此,使参数变成路由模板定义中的必需参数很简单。 在此示例中,id 是 URL 路径中的必需参数。

public class ProductsApiController : Controller
{
   [HttpGet("/products/{id}", Name = "Products_List")]
   public IActionResult GetProduct(int id) { ... }
}

将针对诸如 /products/3(而非 /products)之类的 URL 路径执行 ProductsApi.GetProduct(int) 操作。 请参阅路由了解路由模板和相关选项的完整说明。

路由名称

以下代码定义 Products_List路由名称

public class ProductsApiController : Controller
{
   [HttpGet("/products/{id}", Name = "Products_List")]
   public IActionResult GetProduct(int id) { ... }
}

可以使用路由名称基于特定路由生成 URL。 路由名称不影响路由的 URL 匹配行为,仅用于生成 URL。 路由名称必须在应用程序范围内唯一。

备注

这一点与传统的默认路由相反,后者将 id 参数定义为可选参数 ({id?})。 这种精确指定 API 的功能可带来一些好处,比如允许将 /products/products/5 分派到不同的操作。

合并路由

若要使属性路由减少重复,可将控制器上的路由属性与各个操作上的路由属性合并。 控制器上定义的所有路由模板均作为操作上路由模板的前缀。 在控制器上放置路由属性会使控制器中的所有操作都使用属性路由。

[Route("products")]
public class ProductsApiController : Controller
{
   [HttpGet]
   public IActionResult ListProducts() { ... }

   [HttpGet("{id}")]
   public ActionResult GetProduct(int id) { ... }
}

在此示例中,URL 路径 /products 可以匹配 ProductsApi.ListProducts,URL 路径 /products/5 可以匹配 ProductsApi.GetProduct(int) 这两项操作仅匹配 HTTP GET,因为它们用 HttpGetAttribute 标记。

应用于操作的以 /~/ 开头的路由模板不与应用于控制器的路由模板合并。 此示例匹配一组与默认路由类似的 URL 路径。

[Route("Home")]
public class HomeController : Controller
{
    [Route("")]      // Combines to define the route template "Home"
    [Route("Index")] // Combines to define the route template "Home/Index"
    [Route("/")]     // Doesn't combine, defines the route template ""
    public IActionResult Index()
    {
        ViewData["Message"] = "Home index";
        var url = Url.Action("Index", "Home");
        ViewData["Message"] = "Home index" + "var url = Url.Action; =  " + url;
        return View();
    }

    [Route("About")] // Combines to define the route template "Home/About"
    public IActionResult About()
    {
        return View();
    }   
}

对属性路由排序

与按照已定义顺序执行的传统路由相反,属性路由会生成树,并同时匹配所有路由。 其行为就像路由条目是以理想排序方式放置的一样;最特定的路由有机会比较一般的路由先执行。

例如,像 blog/search/{topic} 这样的路由比像 blog/{*article} 这样的路由更特定。 从逻辑上讲,blog/search/{topic} 路由默认情况下先“运行”,因为这是唯一合理的排序。 使用传统路由时,开发人员负责按所需顺序放置路由。

属性路由可以使用框架提供的所有路由属性的 Order 属性来配置顺序。 路由按 Order 属性的升序进行处理。 默认顺序为 0 使用 Order = -1 设置的路由比未设置顺序的路由先运行。 使用 Order = 1 设置的路由在默认路由排序后运行。

提示

避免依赖 Order 如果 URL 空间需要有显式顺序值才能正确进行路由,则同样可能使客户端混淆不清。 属性路由通常选择与 URL 匹配的正确路由。 如果用于 URL 生成的默认顺序不起作用,使用路由名称作为替代项通常比应用 Order 属性更简单。

Razor Pages 路由和 MVC 控制器路由共享一个实现。 可在 Razor Pages 路由和应用约定:路由顺序中找到有关 Razor Pages 主题中路由顺序的信息。

路由模板中的标记替换([controller]、[action]、[area])

为方便起见,属性路由支持标记替换,方法是将标记用大括号([])括起来。 标记 [action][area][controller] 替换为定义了路由的操作中的操作名称值、区域名称值和控制器名称值。 在接下来的示例中,操作与注释中所述的 URL 路径匹配:

[Route("[controller]/[action]")]
public class ProductsController : Controller
{
    [HttpGet] // Matches '/Products/List'
    public IActionResult List() {
        // ...
    }

    [HttpGet("{id}")] // Matches '/Products/Edit/{id}'
    public IActionResult Edit(int id) {
        // ...
    }
}

标记替换发生在属性路由生成的最后一步。 上述示例的行为方式将与以下代码相同:

public class ProductsController : Controller
{
    [HttpGet("[controller]/[action]")] // Matches '/Products/List'
    public IActionResult List() {
        // ...
    }

    [HttpGet("[controller]/[action]/{id}")] // Matches '/Products/Edit/{id}'
    public IActionResult Edit(int id) {
        // ...
    }
}

属性路由还可以与继承结合使用。 与标记替换结合使用时尤为强大。

[Route("api/[controller]")]
public abstract class MyBaseController : Controller { ... }

public class ProductsController : MyBaseController
{
   [HttpGet] // Matches '/api/Products'
   public IActionResult List() { ... }

   [HttpPut("{id}")] // Matches '/api/Products/{id}'
   public IActionResult Edit(int id) { ... }
}

标记替换也适用于属性路由定义的路由名称。 [Route("[controller]/[action]", Name="[controller]_[action]")] 为每项操作生成一个唯一的路由名称。

若要匹配文本标记替换分隔符 [],可通过重复该字符([[]])对其进行转义。

使用参数转换程序自定义标记替换

使用参数转换程序可以自定义标记替换。 参数转换程序实现 IOutboundParameterTransformer 并转换参数值。 例如,一个自定义 SlugifyParameterTransformer 参数转换程序可将 SubscriptionManagement 路由值更改为 subscription-management

RouteTokenTransformerConvention 是应用程序模型约定,可以:

  • 将参数转换程序应用到应用程序中的所有属性路由。
  • 在替换属性路由标记值时对其进行自定义。
public class SubscriptionManagementController : Controller
{
    [HttpGet("[controller]/[action]")] // Matches '/subscription-management/list-all'
    public IActionResult ListAll() { ... }
}

RouteTokenTransformerConventionConfigureServices 中注册为选项。

public void ConfigureServices(IServiceCollection services)
{
    services.AddMvc(options =>
    {
        options.Conventions.Add(new RouteTokenTransformerConvention(
                                     new SlugifyParameterTransformer()));
    });
}

public class SlugifyParameterTransformer : IOutboundParameterTransformer
{
    public string TransformOutbound(object value)
    {
        if (value == null) { return null; }

        // Slugify value
        return Regex.Replace(value.ToString(), "([a-z])([A-Z])", "$1-$2").ToLower();
    }
}

多个路由

属性路由支持定义多个访问同一操作的路由。 此操作最常用于模拟默认传统路由的行为,如以下示例所示:

[Route("[controller]")]
public class ProductsController : Controller
{
   [Route("")]     // Matches 'Products'
   [Route("Index")] // Matches 'Products/Index'
   public IActionResult Index()
}

在控制器上放置多个路由属性意味着,每个路由属性将与操作方法上的每个路由属性合并。

[Route("Store")]
[Route("[controller]")]
public class ProductsController : Controller
{
   [HttpPost("Buy")]     // Matches 'Products/Buy' and 'Store/Buy'
   [HttpPost("Checkout")] // Matches 'Products/Checkout' and 'Store/Checkout'
   public IActionResult Buy()
}

当在某个操作上放置多个路由属性(可实现 IActionConstraint)时,每个操作约束将与定义它的属性中的路由模板合并。

[Route("api/[controller]")]
public class ProductsController : Controller
{
   [HttpPut("Buy")]      // Matches PUT 'api/Products/Buy'
   [HttpPost("Checkout")] // Matches POST 'api/Products/Checkout'
   public IActionResult Buy()
}

提示

在操作上使用多个路由可能看起来很强大,但更建议使应用程序的 URL 空间保持简洁且定义完善。 仅在需要时,例如为了支持现有客户端,才在操作上使用多个路由。

指定属性路由的可选参数、默认值和约束

属性路由支持使用与传统路由相同的内联语法,来指定可选参数、默认值和约束。

[HttpPost("product/{id:int}")]
public IActionResult ShowProduct(int id)
{
   // ...
}

有关路由模板语法的详细说明,请参阅路由模板参考

使用 IRouteTemplateProvider 的自定义路由属性

该框架中提供的所有路由属性([Route(...)][HttpGet(...)] 等)都可实现 IRouteTemplateProvider 接口。 当应用启动时,MVC 会查找控制器类和操作方法上的属性,并使用可实现 IRouteTemplateProvider 的属性生成一组初始路由。

用户可以实现 IRouteTemplateProvider 来定义自己的路由属性。 每个 IRouteTemplateProvider 都允许定义一个包含自定义路由模板、顺序和名称的路由:

public class MyApiControllerAttribute : Attribute, IRouteTemplateProvider
{
   public string Template => "api/[controller]";

   public int? Order { get; set; }

   public string Name { get; set; }
}

应用 [MyApiController] 时,上述示例中的属性会自动将 Template 设置为 "api/[controller]"

使用应用程序模型自定义属性路由

应用程序模型是一个在启动时创建的对象模型,MVC 可使用其中的所有元数据来路由和执行操作。 应用程序模型包含从路由属性收集(通过 IRouteTemplateProvider)的所有数据。 可通过编写约定在启动时修改应用程序模型,以便自定义路由的行为方式。 此部分通过一个简单的示例说明了如何使用应用程序模型自定义路由。

using Microsoft.AspNetCore.Mvc.ApplicationModels;
using System.Linq;
using System.Text;
public class NamespaceRoutingConvention : IControllerModelConvention
{
    private readonly string _baseNamespace;

    public NamespaceRoutingConvention(string baseNamespace)
    {
        _baseNamespace = baseNamespace;
    }

    public void Apply(ControllerModel controller)
    {
        var hasRouteAttributes = controller.Selectors.Any(selector =>
                                                selector.AttributeRouteModel != null);
        if (hasRouteAttributes)
        {
            // This controller manually defined some routes, so treat this 
            // as an override and not apply the convention here.
            return;
        }

        // Use the namespace and controller name to infer a route for the controller.
        //
        // Example:
        //
        //  controller.ControllerTypeInfo ->    "My.Application.Admin.UsersController"
        //  baseNamespace ->                    "My.Application"
        //
        //  template =>                         "Admin/[controller]"
        //
        // This makes your routes roughly line up with the folder structure of your project.
        //
        var namespc = controller.ControllerType.Namespace;
        if (namespc == null)
            return;
        var template = new StringBuilder();
        template.Append(namespc, _baseNamespace.Length + 1,
                        namespc.Length - _baseNamespace.Length - 1);
        template.Replace('.', '/');
        template.Append("/[controller]");

        foreach (var selector in controller.Selectors)
        {
            selector.AttributeRouteModel = new AttributeRouteModel()
            {
                Template = template.ToString()
            };
        }
    }
}

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

MVC 应用程序可以混合使用传统路由与属性路由。 通常将传统路由用于为浏览器处理 HTML 页面的控制器,将属性路由用于处理 REST API 的控制器。

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

备注

这两种路由系统的区别在于 URL 与路由模板匹配后所应用的过程。 在传统路由中,将使用匹配项中的路由值,从包含所有传统路由操作的查找表中选择操作和控制器。 在属性路由中,每个模板都与某项操作关联,无需进行进一步的查找。

复杂段

复杂段(例如,[Route("/dog{token}cat")])通过非贪婪的方式从右到左匹配文字进行处理。 有关说明,请参阅源代码 有关详细信息,请参阅此问题

URL 生成

MVC 应用程序可以使用路由的 URL 生成功能,生成指向操作的 URL 链接。 生成 URL 可消除硬编码 URL,使代码更稳定、更易维护。 此部分重点介绍 MVC 提供的 URL 生成功能,并且仅涵盖 URL 生成工作原理的基础知识。 有关 URL 生成的详细说明,请参阅路由

IUrlHelper 接口用于生成 URL,是 MVC 与路由之间的基础结构的基础部分。 在控制器、视图和视图组件中,可通过 Url 属性找到 IUrlHelper 的实例。

在此示例中,将通过 Controller.Url 属性使用 IUrlHelper 接口来生成指向另一项操作的 URL。

using Microsoft.AspNetCore.Mvc;

public class UrlGenerationController : Controller
{
    public IActionResult Source()
    {
        // Generates /UrlGeneration/Destination
        var url = Url.Action("Destination");
        return Content($"Go check out {url}, it's really great.");
    }

    public IActionResult Destination()
    {
        return View();
    }
}

如果应用程序使用的是传统默认路由,则 url 变量的值将为 URL 路径字符串 /UrlGeneration/Destination 此 URL 路径由路由创建,方法是将当前请求中的路由值(环境值)与传递到 Url.Action 的值合并,并将这些值替换到路由模板中:

ambient values: { controller = "UrlGeneration", action = "Source" }
values passed to Url.Action: { controller = "UrlGeneration", action = "Destination" }
route template: {controller}/{action}/{id?}

result: /UrlGeneration/Destination

路由模板中的每个路由参数都会通过将名称与这些值和环境值匹配,来替换掉原来的值。 没有值的路由参数如果有默认值,则可使用默认值;如果本身是可选参数(比如此示例中的 id),则可直接跳过。 如果任何所需路由参数没有对应的值,URL 生成将失败。 如果某个路由的 URL 生成失败,则尝试下一个路由,直到尝试所有路由或找到匹配项为止。

上面的 Url.Action 示例假定使用传统路由,但 URL 生成功能的工作方式与属性路由相似,只不过概念不同。 在传统路由中,路由值用于扩展模板,controlleraction 的路由值通常出现在该模板中 — 这种做法可行是因为通过路由匹配的 URL 遵守某项约定 在属性路由中,controlleraction 的路由值不能出现在模板中,它们用于查找要使用的模板。

此示例使用属性路由:

// In Startup class
public void Configure(IApplicationBuilder app)
{
    app.UseMvc();
}
using Microsoft.AspNetCore.Mvc;

public class UrlGenerationController : Controller
{
    [HttpGet("")]
    public IActionResult Source()
    {
        var url = Url.Action("Destination"); // Generates /custom/url/to/destination
        return Content($"Go check out {url}, it's really great.");
    }

    [HttpGet("custom/url/to/destination")]
    public IActionResult Destination() {
        return View();
    }
}

MVC 生成一个包含所有属性路由操作的查找表,并匹配 controlleraction 的值,以选择要用于生成 URL 的路由模板。 在上述示例中,生成了 custom/url/to/destination

根据操作名称生成 URL

Url.Action (IUrlHelper . Action) 以及所有相关重载都基于这样一种想法:用户想通过指定控制器名称和操作名称来指定要链接的内容。

备注

使用 Url.Action 时,将为用户指定 controlleraction 的当前路由值,controlleraction 的值是环境值 和 值 的一部分。 Url.Action 方法始终使用 actioncontroller 的当前值,并将生成将路由到当前操作的 URL 路径。

路由尝试使用环境值中的值来填充生成 URL 时未提供的信息。 通过使用路由(比如 {a}/{b}/{c}/{d})和环境值 { a = Alice, b = Bob, c = Carol, d = David },路由就具有足够的信息来生成 URL,而无需任何附加值,因为所有路由参数都有值。 如果添加了值 { d = Donovan },则会忽略值 { d = David },生成的 URL 路径将为 Alice/Bob/Carol/Donovan

警告

URL 路径是分层的。 在上述示例中,如果添加了值 { c = Cheryl },则会忽略 { c = Carol, d = David } 这两个值。 在这种情况下,d 不再具有任何值,URL 生成将失败。 用户需要指定 cd 所需的值。 使用默认路由 ({controller}/{action}/{id?}) 时可能会遇到此问题,但在实际操作中很少遇到此行为,因为 Url.Action 始终显式指定 controlleraction 值。

较长的 Url.Action 重载还采用附加路由值对象,为 controlleraction 以外的路由参数提供值。 此重载最常与 id 结合使用,比如 Url.Action("Buy", "Products", new { id = 17 }) 按照惯例,路由值对象通常是匿名类型的对象,但它也可以是 IDictionary<>普通旧 .NET 对象 任何与路由参数不匹配的附加路由值都放在查询字符串中。

using Microsoft.AspNetCore.Mvc;

public class TestController : Controller
{
    public IActionResult Index()
    {
        // Generates /Products/Buy/17?color=red
        var url = Url.Action("Buy", "Products", new { id = 17, color = "red" });
        return Content(url);
    }
}

提示

若要创建绝对 URL,请使用采用 protocol 的重载:Url.Action("Buy", "Products", new { id = 17 }, protocol: Request.Scheme)

根据路由生成 URL

上面的代码演示了如何通过传入控制器和操作名称来生成 URL。 IUrlHelper 还提供 Url.RouteUrl 系列的方法。 这些方法类似于 Url.Action,但它们不会将 actioncontroller 的当前值复制到路由值。 最常见的用法是指定一个路由名称,以使用特定路由来生成 URL,通常指定控制器或操作名称。

using Microsoft.AspNetCore.Mvc;

public class UrlGenerationController : Controller
{
    [HttpGet("")]
    public IActionResult Source()
    {
        var url = Url.RouteUrl("Destination_Route"); // Generates /custom/url/to/destination
        return Content($"See {url}, it's really great.");
    }

    [HttpGet("custom/url/to/destination", Name = "Destination_Route")]
    public IActionResult Destination() {
        return View();
    }
}

在 HTML 中生成 URL

IHtmlHelper 提供 HtmlHelper 方法 Html.BeginFormHtml.ActionLink,可分别生成 <form><a> 元素。 这些方法使用 Url.Action 方法来生成 URL,并且采用相似的参数。 HtmlHelper 的配套 Url.RouteUrlHtml.BeginRouteFormHtml.RouteLink,两者具有相似的功能。

TagHelper 通过 form TagHelper 和 <a> TagHelper 生成 URL。 两者均通过 IUrlHelper 来实现。 有关详细信息,请参阅使用表单

在视图内,可通过 Url 属性将 IUrlHelper 用于前文未涵盖的任何临时 URL 生成。

在操作结果中生成 URL

以上示例展示了如何在控制器中使用 IUrlHelper,不过,控制器中最常见的用法是将 URL 生成为操作结果的一部分。

ControllerBaseController 基类为操作结果提供简便的方法来引用另一项操作。 一种典型用法是在接受用户输入后进行重定向。

public IActionResult Edit(int id, Customer customer)
{
    if (ModelState.IsValid)
    {
        // Update DB with new details.
        return RedirectToAction("Index");
    }
    return View(customer);
}

操作结果工厂方法遵循与 IUrlHelper 上的方法类似的模式。

专用传统路由的特殊情况

传统路由可以使用一种特殊的路由定义,称为专用传统路由 在下面的示例中,名为 blog 的路由是一种专用传统路由。

app.UseMvc(routes =>
{
    routes.MapRoute("blog", "blog/{*article}",
        defaults: new { controller = "Blog", action = "Article" });
    routes.MapRoute("default", "{controller=Home}/{action=Index}/{id?}");
});

使用这些路由定义,Url.Action("Index", "Home") 将通过 default 路由生成 URL 路径 /,但是,为什么会这样? 用户可能认为使用 blog,路由值 { controller = Home, action = Index } 就足以生成 URL,且结果为 /blog?action=Index&controller=Home

专用传统路由依赖于不具有相应路由参数的默认值的特殊行为,以防止路由在 URL 生成过程中“太贪婪”。 在此例中,默认值是为 { controller = Blog, action = Article }controlleraction 均未显示为路由参数。 当路由执行 URL 生成时,提供的值必须与默认值匹配。 使用 blog 的 URL 生成将失败,因为值 { controller = Home, action = Index }{ controller = Blog, action = Article } 不匹配。 然后,路由回退,尝试使用 default,并最终成功。

Areas

区域是一种 MVC 功能,用于将相关功能整理到一个组中,作为单独的路由命名空间(用于控制器操作)和文件夹结构(用于视图)。 通过使用区域,应用程序可以有多个名称相同的控制器,只要它们具有不同的区域 通过向 controlleraction 添加另一个路由参数 area,可使用区域为路由创建层次结构。 此部分将讨论路由如何与区域交互;有关如何将区域与视图结合使用的详细信息,请参阅区域

下面的示例将 MVC 配置为使用默认传统路由和区域路由(用于名为 Blog 的区域):

app.UseMvc(routes =>
{
    routes.MapAreaRoute("blog_route", "Blog",
        "Manage/{controller}/{action}/{id?}");
    routes.MapRoute("default_route", "{controller}/{action}/{id?}");
});

与 URL 路径(比如 /Manage/Users/AddUser)匹配时,第一个路由将生成路由值 { area = Blog, controller = Users, action = AddUser } area 路由值由 area 的默认值生成,事实上,通过 MapAreaRoute 创建的路由等效于以下路由:

app.UseMvc(routes =>
{
    routes.MapRoute("blog_route", "Manage/{controller}/{action}/{id?}",
        defaults: new { area = "Blog" }, constraints: new { area = "Blog" });
    routes.MapRoute("default_route", "{controller}/{action}/{id?}");
});

MapAreaRoute 通过为使用所提供的区域名称(本例中为 Blog)的 area 提供默认值和约束,来创建路由。 默认值确保路由始终生成 { area = Blog, ... },约束要求在生成 URL 时使用值 { area = Blog, ... }

提示

传统路由依赖于顺序。 一般情况下,具有区域的路由应放在路由表中靠前的位置,因为它们比没有区域的路由更特定。

在上面的示例中,路由值将与以下操作匹配:

using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace1
{
    [Area("Blog")]
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();
        }        
    }
}

AreaAttribute 用于将控制器表示为某个区域的一部分,比方说,此控制器位于 Blog 区域中。 没有 [Area] 属性的控制器不是任何区域的成员,在路由提供 area 路由值时匹配。 在下面的示例中,只有所列出的第一个控制器才能与路由值 { area = Blog, controller = Users, action = AddUser } 匹配。

using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace1
{
    [Area("Blog")]
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();
        }        
    }
}
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace2
{
    // Matches { area = Zebra, controller = Users, action = AddUser }
    [Area("Zebra")]
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();
        }        
    }
}
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace3
{
    // Matches { area = string.Empty, controller = Users, action = AddUser }
    // Matches { area = null, controller = Users, action = AddUser }
    // Matches { controller = Users, action = AddUser }
    public class UsersController : Controller
    {
        public IActionResult AddUser()
        {
            return View();

        }
    }
}

备注

出于完整性考虑,此处显示了每个控制器的命名空间,否则,控制器会发生命名冲突并生成编译器错误。 类命名空间对 MVC 的路由没有影响。

前两个控制器是区域成员,仅在 area 路由值提供其各自的区域名称时匹配。 第三个控制器不是任何区域的成员,只能在路由没有为 area 提供任何值时匹配。

备注

不匹配任何值而言,缺少 area 值相当于 area 的值为 NULL 或空字符串。

在某个区域内执行某项操作时,area 的路由值将以环境值的形式提供,以便路由用于生成 URL。 这意味着默认情况下,区域在 URL 生成中具有粘性,如以下示例所示。

app.UseMvc(routes =>
{
    routes.MapAreaRoute("duck_route", "Duck",
        "Manage/{controller}/{action}/{id?}");
    routes.MapRoute("default", "Manage/{controller=Home}/{action=Index}/{id?}");
});
using Microsoft.AspNetCore.Mvc;

namespace MyApp.Namespace4
{
    [Area("Duck")]
    public class UsersController : Controller
    {
        public IActionResult GenerateURLInArea()
        {
            // Uses the 'ambient' value of area
            var url = Url.Action("Index", "Home"); 
            // returns /Manage
            return Content(url);
        }

        public IActionResult GenerateURLOutsideOfArea()
        {
            // Uses the empty value for area
            var url = Url.Action("Index", "Home", new { area = "" }); 
            // returns /Manage/Home/Index
            return Content(url);
        }
    }
}

了解 IActionConstraint

备注

此部分深入介绍框架内部结构以及 MVC 如何选择要执行的操作。 典型的应用程序不需要自定义 IActionConstraint

即使不熟悉 IActionConstraint,也可能已经用过该接口。 [HttpGet] 属性和类似的 [Http-VERB] 属性可实现 IActionConstraint 来限制操作方法的执行。

public class ProductsController : Controller
{
    [HttpGet]
    public IActionResult Edit() { }

    public IActionResult Edit(...) { }
}

假定使用默认传统路由,URL 路径 /Products/Edit 将生成值 { controller = Products, action = Edit },这将匹配此处所示的两项操作。 IActionConstraint 术语中,我们会说,这两项操作都被视为候选项,因为它们都与该路由数据匹配。

HttpGetAttribute 执行时,它认为 Edit()GET 的匹配项,而不是任何其他 Http 谓词的匹配项。 Edit(...) 操作未定义任何约束,因此将匹配任何 Http 谓词。 因此,假定 Http 谓词为 POST,则仅 Edit(...) 匹配。 不过,对于 GET,这两项操作仍然都能匹配,只是具有 IActionConstraint 的操作始终被认为比没有该接口的操作更匹配 因此,由于 Edit() 具有 [HttpGet],则认为它更特定,在两项操作都能匹配的情况将选择它。

从概念上讲,IActionConstraint 是一种重载形式,但它并不重载具有相同名称的方法,而在匹配相同 URL 的操作之间重载。 属性路由也使用 IActionConstraint,这可能会导致将不同控制器中的操作都视为候选项。

实现 IActionConstraint

实现 IActionConstraint 最简单的方法是创建派生自 System.Attribute 的类,并将其置于操作和控制器上。 MVC 将自动发现任何应用为属性的 IActionConstraint 可使用应用程序模型应用约束,这可能是最灵活的一种方法,因为它允许对其应用方式进行元编程。

在下面的示例中,约束基于路由数据中的国家/地区代码选择操作。 GitHub 上的完整示例

public class CountrySpecificAttribute : Attribute, IActionConstraint
{
    private readonly string _countryCode;

    public CountrySpecificAttribute(string countryCode)
    {
        _countryCode = countryCode;
    }

    public int Order
    {
        get
        {
            return 0;
        }
    }

    public bool Accept(ActionConstraintContext context)
    {
        return string.Equals(
            context.RouteContext.RouteData.Values["country"].ToString(),
            _countryCode,
            StringComparison.OrdinalIgnoreCase);
    }
}

用户负责实现 Accept 方法,并为要执行的约束选择“顺序”。 在此例中,当 country 路由值匹配时,Accept 方法返回 true 以表示该操作是匹配项。 它与 RouteValueAttribute 的不同之处在于,它允许回退到非属性化操作。 通过该示例可以了解到,如果定义 en-US 操作,则像 fr-FR 这样的国家/地区代码将回退到一个未应用 [CountrySpecific(...)] 的较通用的控制器。

Order 属性决定约束所属的阶段 操作约束基于 Order 分组运行。 例如,该框架提供的所有 HTTP 方法属性均使用相同的 Order 值,以便在相同的阶段运行。 用户可以按需设置阶段数来实现所需的策略。

提示

若要确定 Order 的值,请考虑是否应在 HTTP 方法前应用约束。 数值较低的先运行。