ASP.NET MVC實現功能：通過URL路由實現對多語言的支持

2020-07-14 13:37:43

字體：大中小

來源：轉載

供稿：網友

對于一個需要支持多語言的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
2: {
3: public ActionResult Index()
4: {
5: return View(new LoginInfo());
6: }
7: }
8:
9: public class LoginInfo
10: {
11: [Display(Name ="UserName", ResourceType = typeof(Resources))]
12: public string UserName { get; set; }
13:
14: [Display(Name="Password", ResourceType = typeof(Resources))]
15: [DataType(DataType.Password)]
16: public string Password { get; set; }
17: }
如下所示的Action方法Index對應的View的定義，這是一個基于LogInfo的強類型View。
1: @model MvcApp.Models.LoginInfo
2: @using (Html.BeginForm())
3: {
4: @Html.EditorForModel()
5: <input type="submit" value="@MvcApp.Properties.Resources.Login" />
6: <input type="button" value="@MvcApp.Properties.Resources.Cancel" />
7: }
在Global.asax中，我們修改了默認添加的URL路由注冊代碼，使請求URL中包含相應的語言文化信息（{culture}）。
1: public class MvcApplication : System.Web.HttpApplication
2: {
3: //其他成員
4: public static void RegisterRoutes(RouteCollection routes)
5: {
6: //其他操作
7: routes.MapRoute(
8: name: "Default",
9: url: "{culture}/{controller}/{action}/{id}",
10: defaults: new { culture="en", controller = "Home", action = "Index", id = UrlParameter.Optional }
11: );
12: }
13: }
我們直接運行該程序，并在請求地址中指定不同的Culture（en和zh），界面呈現基于的語言正是我們期望的。
實際上針對URL路由的本地化可以通過具有如下定義的名為CultureAwareHttpModule的自定義HttpModule來實現。我們通過CultureAwareHttpModule注冊了HttpApplication的BeginRequest和EndRequest事件，通過 URL路由系統得到表示語言文化的路由變量culture，并對當前線程的Culture和UICulture進行了相應的設置和恢復。
1: public class CultureAwareHttpModule : IHttpModule
2: {
3: private CultureInfo currentCulture;
4: private CultureInfo currentUICulture;
5:
6: public void Dispose(){}
7: public void Init(HttpApplication context)
8: {
9: context.BeginRequest += SetCurrentCulture;
10: context.EndRequest += RecoverCulture;
11: }
12: private void SetCurrentCulture(object sender, EventArgs args)
13: {
14: currentCulture = Thread.CurrentThread.CurrentCulture;
15: currentUICulture = Thread.CurrentThread.CurrentUICulture;
16: HttpContextBase contextWrapper = new HttpContextWrapper(HttpContext.Current);
17: RouteData routeData = RouteTable.Routes.GetRouteData(contextWrapper);
18: object culture;
19: if (routeData.Values.TryGetValue("culture", out culture))
20: {
21:
22: try
23: {
24: Thread.CurrentThread.CurrentCulture = new CultureInfo(culture.ToString());
25: Thread.CurrentThread.CurrentUICulture = new CultureInfo(culture.ToString());
26: }
27: catch
28: { }
29: }
30: }
31: private void RecoverCulture(object sender, EventArgs args)
32: {
33: Thread.CurrentThread.CurrentCulture = currentCulture;
34: Thread.CurrentThread.CurrentUICulture = currentUICulture;
35: }
36: }
我們只需要通過如下配置對CultureAwareHttpModule進行注冊即可。
1: <configuration>
2: <system.web>
3: <httpModules>
4: <add name="CultureAwareHttpModule" type="MvcApp.CultureAwareHttpModule, MvcApp"/>
5: </httpModules>
6: ...
7: </configuration>