c# - 如何将 ModelExpression 绑定(bind)到 ASP.NET Core 中的 ViewComponent？

Question

我想将模型表达式(例如属性)绑定(bind)到 View 组件——就像我使用 HTML 助手(例如，@Html.EditorFor())或标签助手(例如，<partial for />)一样——并重用这个模型在带有嵌套 HTML 和/或标签助手的 View 中。我能够定义一个 ModelExpression作为 View 组件上的参数，并从中检索许多有用的元数据。除此之外，我开始遇到障碍:

我如何中继和绑定(bind)到底层源模型，例如asp-for标签助手？

如何确保来自 ViewData.ModelMetadata 的属性元数据(例如验证属性)很荣幸？

我如何组装一个完全合格的 HtmlFieldPrefix领域name属性？

我在下面提供了一个(简化的)场景，其中包含代码和结果——但代码暴露的未知数比答案更多。已知大部分代码是不正确的，但我将其包含在内，以便我们可以有一个具体的基线来评估和讨论替代方案。

设想
<select> 的值列表需要通过数据存储库填充。假设填充可能的值作为例如的一部分是不切实际或不可取的。原始 View 模型(请参阅下面的“替代选项”)。

示例代码
/Components/SelectListViewComponent.cs

using system;
using Microsoft.AspNetCore.Mvc.Rendering;

public class SelectViewComponent 
{

  private readonly IRepository _repository;

  public SelectViewComponent(IRepository repository) 
  {
    _repository = repository?? throw new ArgumentNullException(nameof(repository));
  }

  public IViewComponentResult Invoke(ModelExpression aspFor) 
  {
    var sourceList = _repository.Get($"{aspFor.Metadata.Name}Model");
    var model = new SelectViewModel() 
    {
      Options = new SelectList(sourceList, "Id", "Name")
    };
    ViewData.TemplateInfo.HtmlFieldPrefix = ViewData.TemplateInfo.GetFullHtmlFieldName(modelMetadata.Name);
    return View(model);
  }

}

备注

使用 ModelExpression不仅允许我使用模型表达式调用 View 组件，而且还通过反射为我提供了许多有用的元数据，例如验证参数。

参数名称 for在 C# 中是非法的，因为它是一个保留关键字。因此，我改为使用 aspFor ，它将暴露给标签助手格式为 asp-for .这有点小技巧，但为开发人员提供了一个熟悉的界面。

显然，_repository代码和逻辑会随着实现的不同而有很大差异。在我自己的用例中，我实际上从一些自定义属性中提取参数。

GetFullHtmlFieldName()不构造完整的 HTML 字段名称；它总是返回我提交给它的任何值，这只是模型表达式名称。在下面的“问题”下有更多关于这个的信息。

/Models/SelectViewModel.cs

using Microsoft.AspNetCore.Mvc.Rendering;

public class SelectViewModel {
  public SelectList Options { get; set; }
}

备注

从技术上讲，在这种情况下，我可以只返回 SelectList直接到 View ，因为它将处理当前值。但是，如果您将模型绑定(bind)到 <select>的 asp-for标签助手，然后它会自动启用 multiple ，这是绑定(bind)到集合模型时的默认行为。

/Views/Shared/Select/Default.cshtml

@model SelectViewModel

<select asp-for=@Model asp-items="Model.Options">
  <option value="">Select one…</option>
</select>

备注

从技术上讲，@Model 的值将返回 SelectViewModel .如果这是 <input />那将是显而易见的。由于 SelectList，这个问题被掩盖了。确定正确的值，大概来自 ViewData.ModelMetadata .

我可以改为设置 aspFor.Model例如UnderlyingModel SelectViewModel 上的属性(property).这将导致 {HtmlFieldPrefix}.UnderlyingModel 的 HTML 字段名称。 ——并且仍然无法从原始属性中检索任何元数据(例如验证属性)。

变化

如果我不设置 HtmlFieldPrefix ，并将 View 组件放置在例如的上下文中<partial for />或 @Html.EditorFor()那么字段名称将是正确的，如 HtmlFieldPrefix正在父上下文中定义。但是，如果我将其直接放在顶级 View 中，则会由于 HtmlFieldPrefix 而出现以下错误。未定义:

ArgumentException: The name of an HTML field cannot be null or empty. Instead use methods Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper.Editor or Microsoft.AspNetCore.Mvc.Rendering.IHtmlHelper``1.EditorFor with a non-empty htmlFieldName argument value. (Parameter 'expression')

问题

HtmlFieldPrefix没有正确填充完全限定的值。例如，如果模型属性名称是 Country它总是会返回 Country ，即使实际模型路径是，比如说， ShippingAddress.Country或 Addresses[2].Country .

jQuery 验证不显眼 功能没有触发。例如，如果绑定(bind)到的属性被标记为 [Required]那么这里就不会被标记了。这大概是因为它绑定(bind)到 SelectViewModel ，而不是父属性。

原始模型不会以任何方式传递到 View 组件的 View ； SelectList能够从 ViewData 推断出原始值，但这在 View 中丢失了。我可以转发 aspFor.Model通过 View 模型，但它无法访问原始元数据(例如验证属性)。

替代选项

我考虑过的其他一些选择，但在我的用例中被拒绝。

标签助手:这很容易通过标签助手实现。将依赖项(例如存储库)注入(inject)标签助手不太优雅，因为没有办法通过组合根实例化标签助手，例如可以这样做IViewComponentActivator .

Controller :在这个简化的示例中，还可以在顶级 View 模型上定义源集合，紧邻实际属性(例如，Country 表示值，CountryList 表示选项)。在更复杂的示例中，这可能不实用或不优雅。

AJAX:可以通过对 Web 服务的 JavaScript 调用检索这些值，将 JSON 输出绑定(bind)到 <select>客户端上的元素。我在其他应用程序中使用了这种方法，但在这里是不可取的，因为我不想将所有潜在的查询逻辑暴露给公共(public)接口(interface)。

显式值:我可以明确地将父模型与 ModelExpression 一起传递为了在 View 组件下重新创建父上下文。这有点麻烦，所以我想玩玩ModelExpression首先接近。

以前的研究

这个问题之前曾被问过(并回答过):

StackOverflow .

forums.ASP.net .

然而，在这两种情况下，接受的答案(OP 的一个答案)并没有完全探索这个问题，而是决定标签助手更适合他们的场景。标签助手很棒，有他们的目的；但是，对于 View 组件更合适的场景(例如依赖于外部服务)，我想充分探讨原始问题。

我是在追兔子吗？或者社区对模型表达式的更深入理解可以解决哪些选项？

Answer 1

否定地回答我自己的问题:我最终得出的结论是，虽然就我们的父 View 而言，这可能是直观且理想的功能，但就我们的 View 组件而言，它最终是一个令人困惑的概念。

即使您通过提取完全合格的 HtmlFieldPrefix 解决了技术问题来自 ModelExpression ，更深层次的问题是概念性的。据推测， View 组件将组装额外的数据，并通过一个新的 View 模型将其传递给 View ——例如，SelectViewModel问题中提出。否则，使用 View 组件没有真正的好处。 然而，在 View 组件的 View 中，没有将 subview 模型的属性映射回父 View 模型的逻辑方法。

因此，例如，假设在您的父 View 中，您将 View 组件绑定(bind)到 UserViewModel.Country属性(property):

@model UserViewModel

<vc:select asp-for="Country" />

那么，你在 subview 中绑定(bind)了哪些属性？

@model SelectViewModel

<select asp-for=@??? asp-items="Model.Options">
  <option value="">Select one…</option>
</select>

在我最初的问题中，我提出了 @Model ，这类似于您在例如通过 @Html.EditorFor() 调用的编辑器模板:

<select asp-for=@Model asp-items="Model.Options">
  <option value="">Select one…</option>
</select>

那可能会返回正确的 id和 name属性，因为它回退到 HtmlFieldPrefix的ViewData .但是，它不会访问任何例如数据验证属性，因为它绑定(bind)到 SelectViewModel而不是对原始 UserViewModel.Country 的引用属性，就像在编辑器模板中一样。

同样，您可以中继 ModelExpression.Model通过例如向下SelectViewModel.Model属性(property)…

<select asp-for=@Model asp-items="Model.Options">
  <option value="">Select one…</option>
</select>

……但这也不能解决问题，因为很明显，传递值并不能传递源属性的属性。

最终，您想要的是绑定(bind)您的 asp-for到原始对象上的原始属性 ModelExpression正在解决。虽然您可以从 ModelExpression 获取元数据描述该属性和对象，似乎没有办法以 asp-for 的方式传递对它的引用。标签助手识别。

显然，可以设想微软将低级工具构建到 ModelExpression 中。以及 asp-for 的核心实现允许中继的标签助手 ModelExpression对象一直沿线向下。或者，他们可能会建立一个关键字——例如 @ParentModel ——允许从父 View 引用模型。然而，如果没有这一点，这似乎是不可行的。

我不会将此标记为答案，希望有人在某个时候找到我遗漏的东西。然而，我想把这些笔记留在这里，以防其他人试图完成这项工作，并记录我自己的结论。