ASP.NET Core 中的定位点标记帮助程序

项目
11/30/2023

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

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

using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
using System.Linq;

public class SpeakerController : Controller
{
    private List<Speaker> Speakers =
        new List<Speaker>
        {
            new Speaker {SpeakerId = 10},
            new Speaker {SpeakerId = 11},
            new Speaker {SpeakerId = 12}
        };

    [Route("Speaker/{id:int}")]
    public IActionResult Detail(int id) =>
        View(Speakers.FirstOrDefault(a => a.SpeakerId == id));

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

    [Route("/Speaker/EvaluationsCurrent",
           Name = "speakerevalscurrent")]
    public IActionResult Evaluations(
        int speakerId,
        bool currentYear) => View();

    public IActionResult Index() => View(Speakers);
}

public class Speaker
{
    public int SpeakerId { get; set; }
}

定位点标记帮助程序属性

asp-controller

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

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

生成的 HTML：

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

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

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

asp-action

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

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

生成的 HTML：

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

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

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

asp-route-{value}

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

考虑以下控制器操作：

private List<Speaker> Speakers =
    new List<Speaker>
    {
        new Speaker {SpeakerId = 10},
        new Speaker {SpeakerId = 11},
        new Speaker {SpeakerId = 12}
    };

[Route("Speaker/{id:int}")]
public IActionResult Detail(int id) =>
    View(Speakers.FirstOrDefault(a => a.SpeakerId == id));

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

app.UseMvc(routes =>
{
    // need route and attribute on controller: [Area("Blogs")]
    routes.MapRoute(name: "mvcAreaRoute",
                    template: "{area:exists}/{controller=Home}/{action=Index}");

    // default route for non-areas
    routes.MapRoute(
        name: "default",
        template: "{controller=Home}/{action=Index}/{id?}");
});

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

@model Speaker
<!DOCTYPE html>
<html>
<body>
    <a asp-controller="Speaker"
       asp-action="Detail" 
       asp-route-id="@Model.SpeakerId">SpeakerId: @Model.SpeakerId</a>
</body>
</html>

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

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

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

@model Speaker
<!DOCTYPE html>
<html>
<body>
    <a asp-controller="Speaker"
       asp-action="Detail"
       asp-route-speakerid="@Model.SpeakerId">SpeakerId: @Model.SpeakerId</a>
<body>
</html>

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

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

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

asp-route

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

[Route("/Speaker/Evaluations", 
       Name = "speakerevals")]

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

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

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

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

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

asp-all-route-data

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

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

@{
var parms = new Dictionary<string, string>
            {
                { "speakerId", "11" },
                { "currentYear", "true" }
            };
}

<a asp-route="speakerevalscurrent"
   asp-all-route-data="parms">Speaker Evaluations</a>

前面的代码生成以下 HTML：

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

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

public IActionResult Evaluations() => View();

[Route("/Speaker/EvaluationsCurrent",
       Name = "speakerevalscurrent")]
public IActionResult Evaluations(

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

asp-fragment

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

<a asp-controller="Speaker"
   asp-action="Evaluations"
   asp-fragment="SpeakerEvaluations">Speaker Evaluations</a>

生成的 HTML：

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

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

asp-area

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

Razor Pages 中的使用情况

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

考虑以下目录层次结构：

{项目名称}
- wwwroot
- Areas
  - 会话
    - 页
      - _ViewStart.cshtml
      - Index.cshtml
      - Index.cshtml.cs
- 页

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

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

生成的 HTML：

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

提示

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

将兼容性版本设置为 2.1 或更高版本。

将 RazorPagesOptions.AllowAreas 属性设为 true：

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

MVC 中的使用情况

考虑以下目录层次结构：

{项目名称}
- wwwroot
- Areas
  - 博客
    - Controllers
      - HomeController.cs
    - Views
      - Home
        
        AboutBlog.cshtml
        
        Index.cshtml
      - _ViewStart.cshtml
- Controllers

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

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

生成的 HTML：

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

提示

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

app.UseMvc(routes =>
{
    // need route and attribute on controller: [Area("Blogs")]
    routes.MapRoute(name: "mvcAreaRoute",
                    template: "{area:exists}/{controller=Home}/{action=Index}");

    // default route for non-areas
    routes.MapRoute(
        name: "default",
        template: "{controller=Home}/{action=Index}/{id?}");
});

asp-protocol

asp-protocol 属性用于在 URL 中指定协议（比如 https）。例如：

<a asp-protocol="https"
   asp-controller="Home"
   asp-action="About">About</a>

生成的 HTML：

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

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

asp-host

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

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

生成的 HTML：

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

asp-page

asp-page 属性用于 Razor Pages。使用它向特定页设置定位点标记的 href 属性值。使用 / 作为页面名称前缀会从应用的根目录创建匹配页面的 URL：

通过示例代码，以下标记将创建指向与会者 Razor 页面的链接：

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

生成的 HTML：

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

asp-page 属性与 asp-route、asp-controller 和 asp-action 属性互斥。但是，asp-page 可与 asp-route-{value} 结合使用以控制路由，如以下标记所示：

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

生成的 HTML：

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

如果引用的页面不存在，则会使用请求中的环境值生成指向当前页的链接。未指示任何警告，但调试日志级别除外。

asp-page-handler

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

请考虑以下页处理程序：

public void OnGetProfile(int attendeeId)
{
    ViewData["AttendeeId"] = attendeeId;

    // code omitted for brevity
}

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

<a asp-page="/Attendee"
   asp-page-handler="Profile"
   asp-route-attendeeid="12">Attendee Profile</a>

生成的 HTML：

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

ASP.NET Core 中的定位点标记帮助程序

定位点标记帮助程序属性

asp-controller

asp-action

asp-route-{value}

asp-route

asp-all-route-data

asp-fragment

asp-area

Razor Pages 中的使用情况

MVC 中的使用情况

asp-protocol

asp-host

asp-page

asp-page-handler

其他资源

反馈

其他资源