ASP.NET Core 中的定位点标记帮助程序Anchor Tag Helper in ASP.NET Core

本文内容

作者:Peter KellnerScott Addie

定位点标记帮助程序可通过添加新属性来增强标准的 HTML 定位点 (<a … ></a>) 标记。按照约定,属性名称将使用前缀 asp-href 属性的值决定呈现的定位点元素的 asp- 属性值。

有关标记帮助程序的概述,请参阅 ASP.NET Core 中的标记帮助程序

查看或下载示例代码如何下载

本文档中的示例均使用 SpeakerController:

  1. using Microsoft.AspNetCore.Mvc;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. public class SpeakerController : Controller
  5. {
  6. private List<Speaker> Speakers =
  7. new List<Speaker>
  8. {
  9. new Speaker {SpeakerId = 10},
  10. new Speaker {SpeakerId = 11},
  11. new Speaker {SpeakerId = 12}
  12. };
  13. [Route("Speaker/{id:int}")]
  14. public IActionResult Detail(int id) =>
  15. View(Speakers.FirstOrDefault(a => a.SpeakerId == id));
  16. [Route("/Speaker/Evaluations",
  17. Name = "speakerevals")]
  18. public IActionResult Evaluations() => View();
  19. [Route("/Speaker/EvaluationsCurrent",
  20. Name = "speakerevalscurrent")]
  21. public IActionResult Evaluations(
  22. int speakerId,
  23. bool currentYear) => View();
  24. public IActionResult Index() => View(Speakers);
  25. }
  26. public class Speaker
  27. {
  28. public int SpeakerId { get; set; }
  29. }

定位点标记帮助程序属性Anchor Tag Helper attributes

asp-controllerasp-controller

asp-controller 属性可分配用于生成 URL 的控制器。下面的标记列出了所有发言人:

  1. <a asp-controller="Speaker"
  2. asp-action="Index">All Speakers</a>

生成的 HTML:

  1. <a href="/Speaker">All Speakers</a>

如果指定了 asp-controller 属性,而未指定 asp-action 属性,则默认的 asp-action 值为与当前正在执行的视图关联的控制器操作。如果前面的标记中省略了 asp-action,并在 HomeController 的索引视图 (/Home) 中使用了定位点标记帮助程序,则生成的 HTML 为:

  1. <a href="/Home">All Speakers</a>

asp-actionasp-action

asp-action 属性值表示生成的 href 属性中包含的控制器操作名称。下面的标记可将生成的 href 属性值设置为发言人评估页:

  1. <a asp-controller="Speaker"
  2. asp-action="Evaluations">Speaker Evaluations</a>

生成的 HTML:

  1. <a href="/Speaker/Evaluations">Speaker Evaluations</a>

如果未指定 asp-controller 属性,则使用默认控制器,该控制器调用执行当前视图的视图。

如果 asp-action 属性值为 Index,则不向 URL 追加任何操作,从而导致调用默认的 Index 操作。asp-controller 引用的控制器中必须存在指定的(或默认的)操作。

asp-route-{value}asp-route-{value}

asp-route-{value} 属性可实现通配符路由前缀。占用 {value} 占位符的所有值都解释为潜在的路由参数。如果找不到默认路由,则将此路由前缀作为请求参数和值追加到生成的 href 属性。否则,将在路由模板中替换它。

考虑以下控制器操作:

  1. public IActionResult AnchorTagHelper(int id)
  2. {
  3. var speaker = new Speaker
  4. {
  5. SpeakerId = id
  6. };
  7. return View(speaker);
  8. }

在 Startup.Configure 中定义默认路由模板:

  1. app.UseMvc(routes =>
  2. {
  3. // need route and attribute on controller: [Area("Blogs")]
  4. routes.MapRoute(name: "mvcAreaRoute",
  5. template: "{area:exists}/{controller=Home}/{action=Index}");
  6. // default route for non-areas
  7. routes.MapRoute(
  8. name: "default",
  9. template: "{controller=Home}/{action=Index}/{id?}");
  10. });

MVC 视图使用操作提供的模型,如下所示:

  1. @model Speaker
  2. <!DOCTYPE html>
  3. <html>
  4. <body>
  5. <a asp-controller="Speaker"
  6. asp-action="Detail"
  7. asp-route-id="@Model.SpeakerId">SpeakerId: @Model.SpeakerId</a>
  8. </body>
  9. </html>

默认路由的 {id?} 占位符得以匹配。生成的 HTML:

  1. <a href="/Speaker/Detail/12">SpeakerId: 12</a>

假设路由前缀不属于匹配路由模板的一部分,如下面的 MVC 视图所示:

  1. @model Speaker
  2. <!DOCTYPE html>
  3. <html>
  4. <body>
  5. <a asp-controller="Speaker"
  6. asp-action="Detail"
  7. asp-route-speakerid="@Model.SpeakerId">SpeakerId: @Model.SpeakerId</a>
  8. <body>
  9. </html>

生成以下 HTML,因为匹配的路由中未找到 speakerid

  1. <a href="/Speaker/Detail?speakerid=12">SpeakerId: 12</a>

如果 asp-controllerasp-action 均未指定,则会执行与 asp-route 属性中相同的默认处理。

asp-routeasp-route

asp-route 属性用于创建直接链接到命名路由的 URL。使用路由属性,路由可以按 SpeakerController 中所示进行命名并用于其 Evaluations 操作:

  1. [Route("/Speaker/Evaluations",
  2. Name = "speakerevals")]
  3. public IActionResult Evaluations() => View();

在下列标记中,asp-route 属性引用命名路由:

  1. <a asp-route="speakerevals">Speaker Evaluations</a>

定位点标记帮助程序使用 URL /Speaker/Evaluations 生成直接指向该控制器操作的路由。生成的 HTML:

  1. <a href="/Speaker/Evaluations">Speaker Evaluations</a>

如果除了 asp-controller,还指定了 asp-actionasp-route,则可能不会生成预期的路由。为了避免发生路由冲突,不应将 asp-routeasp-controllerasp-action 属性结合使用。

asp-all-route-dataasp-all-route-data

asp-all-route-data 属性支持创建键值对字典。键是参数名称,值是参数值。

在下面的示例中,将对字典进行初始化并将其传递给 Razor 视图。或者,也可以使用模型传入数据。

  1. @{
  2. var parms = new Dictionary<string, string>
  3. {
  4. { "speakerId", "11" },
  5. { "currentYear", "true" }
  6. };
  7. }
  8. <a asp-route="speakerevalscurrent"
  9. asp-all-route-data="parms">Speaker Evaluations</a>

前面的代码生成以下 HTML:

  1. <a href="/Speaker/EvaluationsCurrent?speakerId=11&currentYear=true">Speaker Evaluations</a>

平展 asp-all-route-data 字典,以生成满足重载 Evaluations 操作要求的查询字符串:

  1. [Route("/Speaker/EvaluationsCurrent",
  2. Name = "speakerevalscurrent")]
  3. public IActionResult Evaluations(
  4. int speakerId,
  5. bool currentYear) => View();

如果字典中的任何键匹配路由参数,则将根据需要在路由中替换这些值。其他不匹配的值作为请求参数生成。

asp-fragmentasp-fragment

asp-fragment 属性可定义要追加到 URL 的 URL 片段。定位点标记帮助程序添加哈希字符 (#)。请考虑以下标记:

  1. <a asp-controller="Speaker"
  2. asp-action="Evaluations"
  3. asp-fragment="SpeakerEvaluations">Speaker Evaluations</a>

生成的 HTML:

  1. <a href="/Speaker/Evaluations#SpeakerEvaluations">Speaker Evaluations</a>

生成客户端应用时,哈希标记很有用。它们可用于在 JavaScript 中轻松地执行标记和搜索等操作。

asp-areaasp-area

asp-area 属性可设置用来设置相应路由的区域名称。以下示例展示了 asp-area 属性如何导致重新映射路由。

Razor Pages 中的使用情况Usage in Razor Pages

ASP.NET Core 2.1 或更高版本中支持 Razor Pages 区域。

考虑以下目录层次结构:

  • {项目名称}
    • wwwroot
    • 区域
      • 会话
          • _ViewStart.cshtml
          • Index.cshtml
          • Index.cshtml.cs

用于引用“会话”区域“索引”Razor 页的标记是:

  1. <a asp-area="Sessions"
  2. asp-page="/Index">View Sessions</a>

生成的 HTML:

  1. <a href="/Sessions">View Sessions</a>

提示

若要支持 Razor Pages 应用中的区域,请执行以下 Startup.ConfigureServices 之一:

  1. services.AddMvc()
  2. .AddRazorPagesOptions(options => options.AllowAreas = true);

MVC 中的使用情况Usage in MVC

考虑以下目录层次结构:

  • {项目名称}
    • wwwroot
    • 区域
      • 博客
        • Controllers
          • HomeController.cs
        • 视图
          • 主页
            • AboutBlog.cshtml
            • Index.cshtml
          • _ViewStart.cshtml
    • Controllers

如果将 asp-area 设置为 “Blogs”,则会为此定位点标记的关联控制器和视图的路由添加目录 Areas/Blogs 作为前缀。用于引用 AboutBlog 视图的标记是:

  1. <a asp-area="Blogs"
  2. asp-controller="Home"
  3. asp-action="AboutBlog">About Blog</a>

生成的 HTML:

  1. <a href="/Blogs/Home/AboutBlog">About Blog</a>

提示

若要在 MVC 应用中支持区域,路由模板必须包含对该区域(如果存在)的引用。该模板由 Startup.Configure 中的 routes.MapRoute 方法调用的第二个参数表示:

  1. app.UseMvc(routes =>
  2. {
  3. // need route and attribute on controller: [Area("Blogs")]
  4. routes.MapRoute(name: "mvcAreaRoute",
  5. template: "{area:exists}/{controller=Home}/{action=Index}");
  6. // default route for non-areas
  7. routes.MapRoute(
  8. name: "default",
  9. template: "{controller=Home}/{action=Index}/{id?}");
  10. });

asp-protocolasp-protocol

asp-protocol 属性用于在 URL 中指定协议(比如 https)。例如:

  1. <a asp-protocol="https"
  2. asp-controller="Home"
  3. asp-action="About">About</a>

生成的 HTML:

  1. <a href="https://localhost/Home/About">About</a>

示例中的主机名为 localhost。生成 URL 时,定位点标记帮助程序会使用网站的公共域。

asp-hostasp-host

asp-host 属性用于在 URL 中指定主机名。例如:

  1. <a asp-protocol="https"
  2. asp-host="microsoft.com"
  3. asp-controller="Home"
  4. asp-action="About">About</a>

生成的 HTML:

  1. <a href="https://microsoft.com/Home/About">About</a>

asp-pageasp-page

asp-page 属性适用于 Razor 页面。使用它向特定页设置定位点标记的 href 属性值。通过在页面名称前面使用正斜杠 (“/”) 作为前缀,可创建 URL。

下列示例指向与会者 Razor 页面:

  1. <a asp-page="/Attendee">All Attendees</a>

生成的 HTML:

  1. <a href="/Attendee">All Attendees</a>

asp-page 属性与 asp-routeasp-controllerasp-action 属性互斥。但是,asp-page 可与 asp-route-{value} 结合使用以控制路由,如以下标记所示:

  1. <a asp-page="/Attendee"
  2. asp-route-attendeeid="10">View Attendee</a>

生成的 HTML:

  1. <a href="/Attendee?attendeeid=10">View Attendee</a>

asp-page-handlerasp-page-handler

asp-page-handler 属性适用于 Razor 页面。它用于链接到特定的页处理程序。

请考虑以下页处理程序:

  1. public void OnGetProfile(int attendeeId)
  2. {
  3. ViewData["AttendeeId"] = attendeeId;
  4. // code omitted for brevity
  5. }

页模型的关联标记链接到 OnGetProfile 页处理程序。注意,On<Verb> 属性值中省略了页处理程序方法名称的 asp-page-handler 前缀。如果方法是异步的,也省略 Async 后缀。

  1. <a asp-page="/Attendee"
  2. asp-page-handler="Profile"
  3. asp-route-attendeeid="12">Attendee Profile</a>

生成的 HTML:

  1. <a href="/Attendee?attendeeid=12&handler=Profile">Attendee Profile</a>

其他资源Additional resources