如何在 ASP.NET MVC 中设置多语言和本地化视图？

Question

我已经有一个英文的 MVC 网站。现在我需要添加阿拉伯语。为此，我想使用下面的结构来存储我的本地化 .cshtml 文件

英文视图
~/Views/index.cshtml
~/Views/about.cshtml

阿拉伯语视图
~/ar/Views/index.cshtml
~/ar/Views/about.cshtml

英文 URL (It's working)
www.samplesite.com/home/index
www.samplesite.com/home/index

阿拉伯语 URL（不起作用）
www.samplesite.com/ar/home/index
www.samplesite.com/ar/home/index

如果 url 带有 /en 或没有语言参数，我需要返回英文视图，如果 URL 以 /ar 开头，我需要返回 ar/Views 文件夹中的视图。我应该在路由配置和操作中更改什么才能根据 URL 获得正确的视图？

Answer 1

为了使用针对不同语言和文化的不同视图本地化 ASP.NET MVC 应用程序，您至少需要执行以下操作：

1. 保存 URL 中的语言代码以路由数据收集（如果存在）
2. 根据语言代码设置当前文化（如果存在）
3. 如果出现语言代码，则将请求路由到本地化视图

1. 保存 URL 中的语言代码以路由数据收集（如果存在）

您需要定义路由映射，以便每当 URL 上有语言代码时，就会将其放入路由数据集合中。

您可以在以下文件中定义额外的路由映射RouteConfig：

namespace DL.SO.Globalization.DotNet.Web.UI
{
    public class RouteConfig
    {
        public static void RegisterRoutes(RouteCollection routes)
        {
            routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

            routes.LowercaseUrls = true;

            routes.MapRoute(
                name: "DefaultWithLang",
                url: "{lang}/{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional },
                constraints: new { lang = new LanguageRouteConstraint() }
            );

            routes.MapRoute(
                name: "Default",
                url: "{controller}/{action}/{id}",
                defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
            );
        }
    }
}

我们将回到路由约束，但这里的想法是首先运行这个“DefaultWithLang”映射，看看传入的请求是否附加了语言代码。如果是，则使用 key 将其保存到路由集合中lang。否则，只需照常处理即可。

路线限制

想象一下，我们定义了这 2 个映射，传入的请求看起来像/home/index. 如果没有那个路由约束，这将被映射到“DefaultWithLang”，lang并且是“home”，这是不正确的。

我们需要一种方法来测试语言代码是否是有效的 2 字母代码。为此，您可以创建一个路由约束：

using System.Text.RegularExpressions;
using System.Web;
using System.Web.Routing;

namespace DL.SO.Globalization.DotNet.Web.UI.RouteConstraints
{
    public class LanguageRouteConstraint : IRouteConstraint
    {
        public bool Match(HttpContextBase httpContext, Route route, string parameterName, 
            RouteValueDictionary values, RouteDirection routeDirection)
        {
            return Regex.IsMatch((string)values[parameterName], @"^[a-z]{2}$");
        }
    }
}

有了这个，请求“/home/index”将首先以“home”作为语言代码进入，但它会失败这个路由约束，因为它有两个以上的字母。这将导致“DefaultWithLang”映射不匹配。然后MVC将继续使用第二个映射并查看请求是否是有效请求，它是！

2.根据语言代码设置当前文化（如果存在）

现在我们知道语言代码将被放入路由数据集合中。我们可以在此基础上设置当前文化和当前线程的当前 UI 文化。

为此，我们可以创建一个ActionFilter：

namespace DL.SO.Globalization.DotNet.Web.UI.Filters
{
    public class LanguageFilter : ActionFilterAttribute
    {
        public override void OnActionExecuting(ActionExecutingContext filterContext)
        {
            var values = filterContext.RouteData.Values;

            string languageCode = (string)values["lang"] ?? "en";

            var cultureInfo = new CultureInfo(languageCode);

            Thread.CurrentThread.CurrentCulture = cultureInfo;
            Thread.CurrentThread.CurrentUICulture = CultureInfo.CreateSpecificCulture(cultureInfo.Name);
        }
    }
}

这里我从路由数据集合中读取语言代码值，如果不存在则默认为“en”。

要为整个应用程序启用它，您可以将其添加到FilterConfig.cs：

namespace DL.SO.Globalization.DotNet.Web.UI
{
    public class FilterConfig
    {
        public static void RegisterGlobalFilters(GlobalFilterCollection filters)
        {
            filters.Add(new LanguageFilter());
            filters.Add(new HandleErrorAttribute());
        }
    }
}

3. 将请求路由到本地化视图，如果出现语言代码

与步骤#2 类似，现在我们有了语言代码，我们需要创建一个自定义视图引擎来将请求路由到不同的视图：

namespace DL.SO.Globalization.DotNet.Web.UI
{
    public class GlobalizationRazorViewEngine : RazorViewEngine
    {
        protected override IView CreatePartialView(ControllerContext controllerContext, 
            string partialPath)
        {
            partialPath = GetGlobalizeViewPath(controllerContext, partialPath);
            return base.CreatePartialView(controllerContext, partialPath);
        }

        protected override IView CreateView(ControllerContext controllerContext, 
            string viewPath, string masterPath)
        {
            viewPath = GetGlobalizeViewPath(controllerContext, viewPath);
            return base.CreateView(controllerContext, viewPath, masterPath);
        }

        private string GetGlobalizeViewPath(ControllerContext controllerContext, 
            string viewPath)
        {
            var request = controllerContext.HttpContext.Request;
            var values = controllerContext.RouteData.Values;

            string languageCode = (string)values["lang"];
            if (!String.IsNullOrWhiteSpace(languageCode))
            {
                string localizedViewPath = Regex.Replace(viewPath,
                    "^~/Views/",
                    String.Format("~/{0}/Views/", languageCode)
                );

                if (File.Exists(request.MapPath(localizedViewPath)))
                {
                    viewPath = localizedViewPath;
                }
            }

            return viewPath;
        }
    }
}

这里的逻辑应该是直截了当的：如果语言代码存在，请尝试将其附加到 MVC 应用程序将用来查找相应视图的原始视图路径。

注意：您需要复制_viewStart.cshtml以及web.config从原始Views文件夹复制到新的本地化Views文件夹。您可以考虑使用不同的文件夹结构来包含所有本地化视图。一种可能的方法是将它们全部放在~/Views文件夹中。

要使用此自定义视图引擎，您需要将其添加到视图引擎集合中Application_Start()：

namespace DL.SO.Globalization.DotNet.Web.UI
{
    public class MvcApplication : System.Web.HttpApplication
    {
        protected void Application_Start()
        {
            ViewEngines.Engines.Clear();
            ViewEngines.Engines.Add(new GlobalizationRazorViewEngine());

            AreaRegistration.RegisterAllAreas();
            FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
            RouteConfig.RegisterRoutes(RouteTable.Routes);
            BundleConfig.RegisterBundles(BundleTable.Bundles);
        }
    }
}

截图

随着zh/上的网址：

文件夹结构：

Github 源码： https : //github.com/davidliang2008/DL.SO.Globalization.DotNet/tree/master/DL.SO.Globalization.DotNet.Web.UI