ASP.NET Core MVC 视图组件搜索路径

在此处的文档中：https://learn.microsoft.com/en-us/aspnet/core/mvc/views/view-components?view=aspnetcore-2.2 https://learn.microsoft.com/en-us/aspnet/core/mvc/views/view-components?view=aspnetcore-2.2

运行时在以下路径中搜索视图：

/Views/{Controller Name}/Components/{View Component Name}/{View Name}
/Views/Shared/Components/{View Component Name}/{View Name}
/Pages/Shared/Components/{View Component Name}/{View Name}

我如何在这里添加另一条路径？

我希望将我的视图组件及其各自的控制器放在一个名为组件的项目文件夹中，如下所示。

/Components/{View Component Name}/{View Name}

我的动机：

我发现我的视图组件有自己的 JS 和 CSS 文件。我将所有 JS 捆绑并最小化为一个site.min.js以及所有 CSS 捆绑并最小化在它们的site.min.css。 JS 总是这样的$(function() { ... })CSS 的编写方式始终与顺序无关，因此在不知道顺序的情况下捆绑所有 CSS 并不是问题。

其中一些视图组件具有可以更改其在服务器上的状态的 JavaScript，例如对控制器操作的 AJAX 调用返回一些 JSON 或整个视图组件的 HTML。

由于控制器只是一个 C# 类，它们可以位于任何文件夹中，但将具有相关 AJAX 操作的控制器移动到“Views”文件夹中感觉很愚蠢。

最后我想要一个像这样的“组件”（不仅仅是“视图组件”）：

/Components/SomeViewComponent/Default.cshtml
/Components/SomeViewComponent/SomeViewComponentController.cs
/Components/SomeViewComponent/SomeViewComponent.cs
/Components/SomeViewComponent/SomeViewComponent.css
/Components/SomeViewComponent/SomeViewComponent.js
/Components/SomeViewComponent/SomeViewComponent.en.resx
/Components/SomeViewComponent/SomeViewComponent.cs-CZ.resx

因此，在深入研究 aspnetcore 存储库一个小时后，我发现该组件的搜索路径是硬编码的 https://github.com/aspnet/AspNetCore/blob/master/src/Mvc/Mvc.ViewFeatures/src/ViewComponents/ViewViewComponentResult.cs然后与普通视图搜索路径结合。

// {0} is the component name, {1} is the view name.
private const string ViewPathFormat = "Components/{0}/{1}";

然后将该路径发送到视图引擎中

result = viewEngine.FindView(viewContext, qualifiedViewName, isMainPage: false);

然后，视图引擎使用可配置的视图路径生成完整路径。

• Views/Shared/Components/Cart/Default.cshtml
• Views/Home/Components/Cart/Default.cshtml
• Areas/Blog/Views/Shared/Components/Cart/Default.cshtml

如果您想按照我的意愿将视图组件放入名为“Components”的根文件夹中，您可以执行类似的操作。

services.Configure<RazorViewEngineOptions>(o =>
{
    // {2} is area, {1} is controller,{0} is the action
    // the component's path "Components/{ViewComponentName}/{ViewComponentViewName}" is in the action {0}
    o.ViewLocationFormats.Add("/{0}" + RazorViewEngine.ViewExtension);        
});

在我看来，这有点丑陋。但它有效。

您也可以像这样编写自己的扩展器。

namespace TestMvc
{
    using Microsoft.AspNetCore.Mvc.Razor;
    using System.Collections.Generic;

    public class ComponentViewLocationExpander : IViewLocationExpander
    {
        public IEnumerable<string> ExpandViewLocations(ViewLocationExpanderContext context, IEnumerable<string> viewLocations)
        {
            // this also feels ugly
            // I could not find another way to detect
            // whether the view name is related to a component
            // but it's somewhat better than adding the path globally
            if (context.ViewName.StartsWith("Components"))
                return new string[] { "/{0}" + RazorViewEngine.ViewExtension };

            return viewLocations;
        }

        public void PopulateValues(ViewLocationExpanderContext context) {}
    }
}

在 Startup.cs 中

services.Configure<RazorViewEngineOptions>(o =>
{
    o.ViewLocationExpanders.Add(new ComponentViewLocationExpander());   
});