如何在.NET Framework 4.8中实现按客户自定义CSHTML视图覆盖？

要实现按客户覆盖默认CSHTML视图的需求，核心是自定义Razor视图引擎，调整视图查找优先级，优先加载客户专属的覆盖视图，找不到时回退到默认视图。具体步骤如下：

1. 实现当前客户标识的获取逻辑 #

首先需要从请求上下文里拿到当前访问的客户名称，可根据业务场景从Cookie、Session、路由参数或域名中读取，示例代码如下：

private static string GetCurrentCustomerName(HttpContextBase context)
{
    // 示例：从Cookie获取客户名称
    return context.Request.Cookies["CustomerName"]?.Value ?? string.Empty;
    // 可选方式：从路由参数获取
    // return context.Request.RequestContext.RouteData.Values["customerName"]?.ToString() ?? string.Empty;
}

2. 自定义Razor视图引擎 #

继承RazorViewEngine，重写视图查找逻辑，优先检查客户专属的视图路径：

public class CustomerOverrideViewEngine : RazorViewEngine
{
    protected override ViewEngineResult FindView(ControllerContext controllerContext, string viewName, string masterName, bool useCache)
    {
        var customerName = GetCurrentCustomerName(controllerContext.HttpContext);
        
        // 有有效客户标识时，优先查找覆盖视图
        if (!string.IsNullOrEmpty(customerName))
        {
            // 检查控制器专属视图
            var customerViewPath = $"~/Views/Overrides/{customerName}/{controllerContext.RouteData.Values["controller"]}/{viewName}.cshtml";
            if (FileExists(controllerContext, customerViewPath))
            {
                return new ViewEngineResult(CreateView(controllerContext, customerViewPath, masterName), this);
            }

            // 检查共享视图
            var customerSharedPath = $"~/Views/Overrides/{customerName}/Shared/{viewName}.cshtml";
            if (FileExists(controllerContext, customerSharedPath))
            {
                return new ViewEngineResult(CreateView(controllerContext, customerSharedPath, masterName), this);
            }
        }

        // 找不到覆盖视图，回退到默认视图查找逻辑
        return base.FindView(controllerContext, viewName, masterName, useCache);
    }

    private static string GetCurrentCustomerName(HttpContextBase context)
    {
        // 替换为你的实际客户标识获取逻辑
        return context.Request.Cookies["CustomerName"]?.Value ?? string.Empty;
    }
}

如果你更倾向于通过扩展视图位置格式实现，可在构造函数中修改路径优先级（简洁但灵活性稍弱）：

public class CustomerOverrideViewEngine : RazorViewEngine
{
    public CustomerOverrideViewEngine()
    {
        // 将客户覆盖路径放在最前面，优先查找
        var customerViewLocations = new[]
        {
            "~/Views/Overrides/{2}/{1}/{0}.cshtml",
            "~/Views/Overrides/{2}/Shared/{0}.cshtml"
        };

        // 合并原有默认路径，客户路径优先级更高
        ViewLocationFormats = customerViewLocations.Concat(ViewLocationFormats).ToArray();
        PartialViewLocationFormats = customerViewLocations.Concat(PartialViewLocationFormats).ToArray();
        MasterLocationFormats = customerViewLocations.Concat(MasterLocationFormats).ToArray();
    }
}

注：这里的{2}代表客户名称，需确保视图查找逻辑能正确传递该参数，或结合前面的GetCurrentCustomerName方法动态替换。

3. 注册自定义视图引擎 #

在Global.asax的Application_Start方法中，替换默认的Razor视图引擎：

protected void Application_Start()
{
    // 移除默认Razor视图引擎
    var defaultRazorEngine = ViewEngines.Engines.OfType<RazorViewEngine>().FirstOrDefault();
    if (defaultRazorEngine != null)
    {
        ViewEngines.Engines.Remove(defaultRazorEngine);
    }

    // 添加自定义视图引擎
    ViewEngines.Engines.Add(new CustomerOverrideViewEngine());

    // ... 其他初始化代码（如路由注册、Area注册等）
}

关键注意事项 #

• 路径安全：对获取到的customerName做合法性校验，只允许字母、数字、下划线等合法字符，过滤../等特殊字符，避免路径遍历漏洞。
• 视图缓存：若启用视图缓存，需确保缓存键包含客户名称，防止不同客户视图互相干扰；客户视图更新时，可通过ViewEngines.Engines.Clear()或重启应用清理缓存。
• 测试验证：创建测试目录/Views/Overrides/CustomerA/Account/Login.cshtml，设置当前客户为CustomerA后访问/Account/Login，验证是否加载自定义视图，切换客户后是否回退到默认视图。

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