如何在ASP.NET MVC中设置多语言和本地化的视图? 路线限制

问题描述

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

英语视图
〜/ Views / index.cshtml
〜/ Views / about.cshtml

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

英语URL(正在运行)
www.samplesite.com/home/index
www.samplesite.com/home/index

阿拉伯语网址(不起作用)
www.samplesite.com/ar/home/index
www.samplesite.com/ar/home/index

如果带有/ en的URL或没有语言参数,并且URL以/ ar开头,我需要返回英文视图,我需要在ar / Views文件夹中返回视图。我应该在路由配置和操作上进行哪些更改以基于URL获得正确的视图?

enter image description here

解决方法

要使用针对不同语言和文化的不同视图来本地化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}",id = UrlParameter.Optional }
            );
        }
    }
}

我们将回到路由约束,但是这里的想法是首先运行此“ DefaultWithLang”映射,并查看传入的请求是否附加了语言代码。如果是,请使用密钥lang将其保存到路由集合中。否则,请照常进行处理。

路线限制

想象一下,我们定义了这两个映射,传入的请求看起来像/home/index。如果没有该路由约束,则将其映射到lang为“ home”的“ DefaultWithLang”,这是不正确的。

我们将需要一种方法来测试语言代码是否为有效的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”作为语言代码进入,但由于该路由约束超过2个字母,因此将使此路由约束失败。这将导致与“ 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.cshtmlweb.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);
        }
    }
}

屏幕截图

enter image description here

在网址上带有zh/

enter image description here

文件夹结构:

enter image description here

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