类库中相对路径相同的Razor视图被错误加载的解决方法

当ASP.NET Core MVC项目引用多个Razor类库，且存在相同相对路径的视图时，除了修改视图路径外，可通过以下几种方式解决冲突：

1. 自定义视图查找优先级 #

通过配置RazorViewEngineOptions，将目标类库的视图路径添加到查找列表的最前端，让框架优先加载指定类库的视图。

在Program.cs中添加配置：

builder.Services.AddControllersWithViews()
    .AddRazorOptions(options =>
    {
        // 优先加载第一个类库的视图
        options.ViewLocationFormats.Insert(0, "/Lib1/Views/{1}/{0}.cshtml");
        // 如果涉及区域视图，同步调整区域视图的查找顺序
        options.AreaViewLocationFormats.Insert(0, "/Lib1/Areas/{2}/Views/{1}/{0}.cshtml");
        
        // 若需要优先加载第二个类库，替换为对应路径即可
        // options.ViewLocationFormats.Insert(0, "/Lib2/Views/{1}/{0}.cshtml");
    });

其中{1}代表控制器名称，{0}代表视图名称，{2}代表区域名称，根据你的类库目录结构调整路径前缀。

2. 使用视图组件（View Components） #

将类库中的重复路径视图封装为独立的视图组件，通过唯一的组件名称区分不同类库的视图，避免路径冲突。

类库中定义视图组件 #

// 第一个类库的视图组件
public class Lib1HomeIndexViewComponent : ViewComponent
{
    public IViewComponentResult Invoke()
    {
        // 可传入模型数据
        return View();
    }
}

// 第二个类库的视图组件
public class Lib2HomeIndexViewComponent : ViewComponent
{
    public IViewComponentResult Invoke()
    {
        return View();
    }
}

每个视图组件对应的视图需放在类库的Views/Shared/Components/{组件名}/Default.cshtml路径下（比如Views/Shared/Components/Lib1HomeIndex/Default.cshtml）。

主项目中调用视图组件 #

在主项目的视图里通过组件名称调用：

<!-- 调用第一个类库的视图 -->
<vc:lib1-home-index />

<!-- 调用第二个类库的视图 -->
<vc:lib2-home-index />

3. 利用区域（Areas）划分视图 #

为每个Razor类库的视图分配独立的区域，通过区域名称明确指定要加载的视图。

调整类库的目录结构 #

将第一个类库的视图放在Areas/Lib1/Views/Home/Index.cshtml，第二个类库的视图放在Areas/Lib2/Views/Home/Index.cshtml。

控制器中指定区域加载视图 #

public IActionResult LoadLib1Index()
{
    // 指定加载Lib1区域的Home/Index视图
    return View("Index", new { area = "Lib1" });
}

public IActionResult LoadLib2Index()
{
    // 指定加载Lib2区域的Home/Index视图
    return View("Index", new { area = "Lib2" });
}

4. 自定义视图定位扩展器 #

实现IViewLocationExpander接口，自定义视图查找逻辑，根据业务需求筛选正确的视图来源。

实现自定义扩展器 #

public class ClassLibraryViewLocationExpander : IViewLocationExpander
{
    public IEnumerable<string> ExpandViewLocations(ViewLocationExpanderContext context, IEnumerable<string> viewLocations)
    {
        // 可根据请求上下文、控制器信息等动态添加目标类库的视图路径
        var targetLibraryPaths = new List<string>
        {
            "/Lib1/Views/{1}/{0}.cshtml"
        };
        // 让自定义路径优先于默认路径
        return targetLibraryPaths.Concat(viewLocations);
    }

    public void PopulateValues(ViewLocationExpanderContext context)
    {
        // 可添加上下文标识，用于后续查找逻辑的判断
        context.Values.Add("TargetLibrary", "Lib1");
    }
}

注册扩展器 #

在Program.cs中注册自定义扩展器：

builder.Services.AddControllersWithViews()
    .AddRazorOptions(options =>
    {
        options.ViewLocationExpanders.Add(new ClassLibraryViewLocationExpander());
    });

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