在ASP.NET MVC中通过URL路由实现对多语言的支持

对于一个需要支持多语言的Web应用，一个很常见的使用方式就是通过请求地址来控制界面呈现所基于的语言文化，比如我们在表示请求地址的URL中将上语言文化代码（比如en或者en-US）来指导服务器应该采用怎样的语言来显示界面的内容。对于一个ASP.NET MVC应用来说，我们很容易通过URL路由来实现这样一个功能。[本文已经同步到《How ASP.NET MVC Works?》中]

在具体介绍实现之前，我们通过一个简单的例子谈谈最终实现的效果。在通过ASP.NET MVC项目模板创建的空Web应用中，我们创建了如下一个HomeController，默认的Action方法Index用于呈现一个登录View。作为Model的LoginInfo类包含UserName和Password两个属性，分别表示登录输入的用户名和密码。需要注意的是，在两个属性上应用了DisplayAttribute并通过资源的方式指定了显示名称以实现对多语言的支持。[原代码从这里下载]

public class HomeController : Controller
{
    public ActionResult Index()
    {
        return View(new LoginInfo());
    }
}

public class LoginInfo
{
    [Display(Name ="UserName", ResourceType = typeof(Resources))]
    public string UserName { get; set; }

    [Display(Name="Password", ResourceType = typeof(Resources))]
    [DataType(DataType.Password)]
    public string Password { get; set; }
}

如下所示的Action方法Index对应的View的定义，这是一个基于LogInfo的强类型View。

@model MvcApp.Models.LoginInfo
@using (Html.BeginForm())
{
    @Html.EditorForModel()
    <input type="submit" value="@MvcApp.Properties.Resources.Login" />
    <input type="button" value="@MvcApp.Properties.Resources.Cancel" />
}

在Global.asax中，我们修改了默认添加的URL路由注册代码，使请求URL中包含相应的语言文化信息（{culture}）。

public class MvcApplication : System.Web.HttpApplication
{
    //其他成员
    public static void RegisterRoutes(RouteCollection routes)
    {
         //其他操作
        routes.MapRoute(
            name: "Default",
            url: "{culture}/{controller}/{action}/{id}",
            defaults: new { culture="en", controller = "Home", action = "Index", id = UrlParameter.Optional }
        );
    }
}

我们直接运行该程序，并在请求地址中指定不同的Culture（en和zh），界面呈现基于的语言正是我们期望的。

实际上针对URL路由的本地化可以通过具有如下定义的名为CultureAwareHttpModule的自定义HttpModule来实现。我们通过CultureAwareHttpModule注册了HttpApplication的BeginRequest和EndRequest事件，通过URL路由系统得到表示语言文化的路由变量culture，并对当前线程的Culture和UICulture进行了相应的设置和恢复。

public class CultureAwareHttpModule : IHttpModule
{
    private CultureInfo currentCulture;
    private CultureInfo currentUICulture;

    public void Dispose(){}
    public void Init(HttpApplication context)
    {
        context.BeginRequest += SetCurrentCulture;
        context.EndRequest   += RecoverCulture;
    }
    private  void SetCurrentCulture(object sender, EventArgs args)
    {
        currentCulture   = Thread.CurrentThread.CurrentCulture;
        currentUICulture = Thread.CurrentThread.CurrentUICulture;
        HttpContextBase contextWrapper = new HttpContextWrapper(HttpContext.Current);
        RouteData routeData = RouteTable.Routes.GetRouteData(contextWrapper);
        object culture;
        if (routeData.Values.TryGetValue("culture", out culture))
        {

            try
            {
                Thread.CurrentThread.CurrentCulture   = new CultureInfo(culture.ToString());
                Thread.CurrentThread.CurrentUICulture = new CultureInfo(culture.ToString());
            }
            catch
            { }
        }
    }
    private void RecoverCulture(object sender, EventArgs args)
    {
        Thread.CurrentThread.CurrentCulture   = currentCulture;
        Thread.CurrentThread.CurrentUICulture = currentUICulture;
    }
}

我们只需要通过如下配置对CultureAwareHttpModule进行注册即可。

<configuration>
  <system.web>
    <httpModules>
      <add name="CultureAwareHttpModule" type="MvcApp.CultureAwareHttpModule, MvcApp"/>
    </httpModules>
    ...
</configuration>