在 ASP.NET Core 3.x MVC 中使用 nameof() 和 Url.Action() 和异步方法

Question

假设我有一个 ASP.NET Core 3.0 MVC 应用程序，它具有一个简单的控制器，其中包含两个操作并使用基于属性的路由：

[Route("home")]
public class HomeController : Controller
{
    public static string ControllerName { get; } = "Home";

    public HomeController()
    {
    }

    string GenerateUrls()
    {
        string url1 = Url.Action(nameof(Action1), ControllerName);
        string url2 = Url.Action(nameof(Action2Async), ControllerName);
        return $"Action1: '{url1}'\nAction2: '{url2}'";
    }

    [HttpGet("a1")]
    public IActionResult Action1()
    {
        return Ok(GenerateUrls());
    }

    [HttpGet("a2")]
    public async Task<IActionResult> Action2Async()
    {
        await Task.CompletedTask;

        return Ok(GenerateUrls());
    }
}

因此，调用任一操作应该只生成一个显示这两个操作的 URL 的页面。

打开/home/a1 和/home/a2 正确调用了各自的操作，但输出有点出乎意料：

Action1: '/home/a1'
Action2: ''

这表明Url.Action() 为第二个操作返回了一个空字符串，而它在第一个操作中运行良好。

在调试了一段时间后，我发现 blog post 将这个问题追溯到 ASP.NET Core 3.0 中的一个重大变化，其中 Async 后缀被 Url.Action() 以某种方式忽略了。

作者通过将字符串硬编码为操作名称（在我的例子中为"Action1" 和"Action2"）解决了这个问题。他还上传了一些example code复制这种行为。

但是，我真的更愿意保留 nameof，以避免以后出现重命名/重构问题。

有没有一种干净的方法来使用nameof 或其他类型安全的构造来为Url.Action 函数提供带有Async 后缀的方法？

Answer 1

所描述的行为是由 ASP.NET Core 3.0 引入的重大更改引起的。

您可以通过禁用SuppressAsyncSuffixInActionNames 来恢复原来的行为：

获取或设置一个值，该值确定 MVC 是否会删除应用于控制器操作名称的后缀“Async”。

在配置应用程序服务时，在您的AddControllers 调用中禁用此开关：

services.AddControllers(options => {
    options.SuppressAsyncSuffixInActionNames = false;
});

您可以在official announcement 和docs 中找到有关此更改的更多信息。

Answer 2

如果您将方法名称 Action2Async 更改为 Action2，问题将得到解决。

来自链接的blog post：

在 ASP.NET Core 3 中，如果您有以 Async 为后缀的 Action 方法，但路由路径不包含 Async，则在通过类似 Url.Action() 解析 URL 时引用它们而不带 Async 后缀。这似乎是 ASP.NET Core 2.2 的一个重大变化，没有正式记录。

public static string ControllerName { get; } = "Home";

string GenerateUrls()
{
    string url1 = Url.Action(nameof(Action1), ControllerName);
    string url2 = Url.Action(nameof(Action2), ControllerName);
    return $"Action1: '{url1}'\nAction2: '{url2}'";
}

[HttpGet("action1")]
public IActionResult Action1()
{
    return Ok(GenerateUrls());
}

[HttpGet("action2")]
public async Task<IActionResult> Action2()
{
    await Task.CompletedTask;

    return Ok(GenerateUrls());
}