ASP.NET Core使用View Component报错Invoke不能返回Task如何解决

错误提示：InvalidOperationException: Method 'Invoke' of view component 'UI.ViewComponents.NavbarViewComponent' cannot return a Task.

错误原因 #

ASP.NET Core 对视图组件的方法命名有强制约定：

• 同步执行的视图组件方法必须命名为 Invoke，仅允许返回 IViewComponentResult 类型，不可返回Task
• 异步执行的视图组件方法必须命名为 InvokeAsync，才允许返回 Task<IViewComponentResult> 类型使用async/await逻辑

你当前的代码是异步逻辑，但方法名用了同步方法专用的Invoke，所以触发了规则校验报错。

修复方案 #

1. 修改后端视图组件的方法名，将Invoke改为InvokeAsync，原有业务逻辑无需调整：

public async Task<IViewComponentResult> InvokeAsync()
{
    var settings = await _db.Settings.ToListAsync();
    return View(settings);
}

2. 视图中的调用代码@await Component.InvokeAsync("Navbar")无需修改，本身就适配异步视图组件的调用规则。

补充说明 #

如果你的视图组件没有异步IO操作（比如不需要查库、调外部接口），也可以改成同步写法：

public IViewComponentResult Invoke()
{
    var settings = _db.Settings.ToList();
    return View(settings);
}

对应视图调用改为@Component.Invoke("Navbar")即可。

内容的提问来源于stack exchange，提问作者jack