ASP.NET MVC的Localization本地化多语言支持

OStack程序员社区-中国程序员成长平台 › 门户 › 编程› ASP.NET›ASP.NET编程经验

原作者: [db:作者] 来自: [db:来源] 收藏邀请

一、ASP.NET MVC的本地化支持

ASP.NET MVC的是基于ASP.NET运行，所以由ASP.NET提供的所有功能，都可以在MVC里使用，例如缓存，会话状态和本地化。在传统的ASP.NET Web窗体时代我们使用资源文件存储不同语言中的内容和使用由Visual Studio自动生成的ResourceManager类来检索它们。在ASP.NET MVC他们一样有效的。

让我创建一个标准的ASP.NET MVC的一个示例应用程序。该网站是中文的，我们可以看到所有的内容都是在视图和控制器类里写死的。

我使用的框架是mvc3的基于Razor模板的网站。

使用Visual Studio 2010 创建 MVC3的Web应用程序，在随后出现的选择中选择Internet 应用程序，视图引擎为Razor；

可以看出来现在网站是中文的，而且我们可以看到所有的内容在视图和控制器里都是硬编码的。

现在我需要做的是把所有的内容从页面和控制器里分离出来，Asp.Net给我们一个名为App_GlobalResources的文件，它里面包含各种语言的全局资源文件。我们只需要在解决方案管理器里的Web项目上右击鼠标，添加->添加至Asp.Net文件夹->App_GlobalResources

我创建了中文、英文两个语言的资源文件，中文是程序的默认语言，所以我先创建Global.resx文件，然后是Global.en.resx，中间的“en”是英语的Culture Name。如果你需要法语，那么你只需要再创建Global.fr.resx文件，Visual Studio会自动生成对应的类。

现在让我在资源文件里添加一些内容，在主页上我们需要替换三处：标题、消息还有描述，所以我们在这两个资源文件里添加3个项。

标题和描述都在视图页面里定义了，所以我将更改视图。

复制代码代码如下:

@{
ViewBag.Title = Resources.Global.Home_Index_Title;
}
<h2>@ViewBag.Message</h2>
<p>
@Resources.Global.Home_Index_Desc
<a href="http://asp.net/mvc" title="@Resources.Global.Home_Index_DescLink">http://asp.net/mvc</a>。
</p>

复制代码代码如下:

public ActionResult Index()

{

    ViewBag.Message = Resources.Global.Home_Index_Message;

    return View();

}

二、通过URL指定语言

我们已经把内容转移到了资源文件，但是我们的程序还不支持本地化，因为没有任何地方我们可以设置指定语言的地方。为了简单起见，我们将使用url来标明选择使用的语言（就类似微软网站），意思就是如果我的URL是http://localhost/en-US/Home/Index ，则网站会体现为英文;而http://localhost/zh-CN/Home/Index 则是简体中文。用户可以在任何停留的页面更改语言，而且当他想共享网址的时候也会保留语言设置。

为了达到效果，我更改了程序的路由，在最前头新增一个名为“lang”的路由规则：

复制代码代码如下:

public static void RegisterRoutes(RouteCollection routes)

{

    routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

    routes.MapRoute(

        "Localization", // 路由名称

        "{lang}/{controller}/{action}/{id}", // 带有参数的 URL

        new { controller = "Home", action = "Index", id = UrlParameter.Optional }//参数默认值

        );

    routes.MapRoute(

        "Default", // 路由名称

        "{controller}/{action}/{id}", // 带有参数的 URL

        new { controller = "Home", action = "Index", id = UrlParameter.Optional } // 参数默认值

    );

}

要注意，代码里并没有设置lang的默认值，而且没有删除默认的路由，这个是为了防止如 http://localhost/ and http://localhost/Home/Index之类地址时程序无法解析。

因为我们需要URL设置语言，所以我们需要在每个action执行前执行写逻辑处理，这里ActionFilter将是个不错的解决方案。

复制代码代码如下:

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Web.Mvc;

using System.Threading;

using System.Globalization;

namespace ShaunXu.MvcLocalization

{

    public class LocalizationAttribute : ActionFilterAttribute

    {

        public override void OnActionExecuting(ActionExecutingContext filterContext)

        {

            if (filterContext.RouteData.Values["lang"] != null &&

                     !string.IsNullOrWhiteSpace(filterContext.RouteData.Values["lang"].ToString()))

            {

                ///从路由数据(url)里设置语言

                var lang = filterContext.RouteData.Values["lang"].ToString();

                Thread.CurrentThread.CurrentUICulture = CultureInfo.CreateSpecificCulture(lang);

            }

            else

            {

                ///从cookie里读取语言设置

                var cookie = filterContext.HttpContext.Request.Cookies["ShaunXu.MvcLocalization.CurrentUICulture"];

                var langHeader = string.Empty;

                if (cookie != null)

                {

                    ///根据cookie设置语言

                    langHeader = cookie.Value;

                    Thread.CurrentThread.CurrentUICulture = CultureInfo.CreateSpecificCulture(langHeader);

                }

                else

                {

                    ///如果读取cookie失败则设置默认语言

                    langHeader = filterContext.HttpContext.Request.UserLanguages[0];

                    Thread.CurrentThread.CurrentUICulture = CultureInfo.CreateSpecificCulture(langHeader);

                }

                ///把语言值设置到路由值里

                filterContext.RouteData.Values["lang"] = langHeader;

            }

            /// 把设置保存进cookie

            HttpCookie _cookie = new HttpCookie("ShaunXu.MvcLocalization.CurrentUICulture", Thread.CurrentThread.CurrentUICulture.Name);

            _cookie.Expires = DateTime.Now.AddYears(1);

            filterContext.HttpContext.Response.SetCookie(_cookie);

            base.OnActionExecuting(filterContext);

        }

    }

}

我创建了一个继承自ActionFilterAttribute的"LocalizationAttribute"并重写了OnActionExecuting方法的属性，首先检查路由里的值，如果包含了语言设置，则设置当前进程的当前区域值，它指示资源管理器（Visual Studio根据资源文件自动生成）获取相关的值。如果找不到路由里的语言值，则读取cookie值来设置，否则使用默认语言。最后把值放进路由，并保存到cookie里。

我在home控制器里使用这个属性这样所有action都可以执行我的本地化逻辑。

复制代码代码如下:

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using System.Web.Mvc;

using ShowLocal.Models;

namespace ShowLocal.Controllers

{

    [Localization]

    public class HomeController : Controller

    {

        public ActionResult Index()

        {

            ViewBag.Message = Resources.Global.Home_Index_Message;

            return View();

        }

        public ActionResult About()

        {

            return View();

        }

    }

}