Asp.Net Core MVC項目實現多語言（Globalization/Localization）

正好最近手上在給一個Razor MVC項目實現一個多語言功能，叫Globalization也好，Localization也好，whatever。最終要實現的效果呢，就是一鍵切換全站語言，並且開發的時候只需要寫一套頁面。

下麵進入正題

首先，我們要創建一個CultureConfigurer類，用於管理本地化資源，完成“翻譯”環節：

這裡我用了靜態類，然後在MVC項目StartUp的時候執行Init()方法，其實有點蠢，當然你們也可以先寫一個介面然後用依賴註入成單例。

 1 using System.Collections.Generic;
 2 using System.IO;
 3 using System.Reflection;
 4 using Newtonsoft.Json;
 5 
 6 namespace Localization
 7 {
 8     public enum Culture
 9     {
10         Cn,
11         En
12     }
13 
14     public static class CultureConfigurer
15     {
16         private static Dictionary<string, string> _enDictionary;
17         private static Dictionary<string, string> _cnDictionary;
18 
19         public static void Init()
20         {
21             var assembly = Assembly.Load(new AssemblyName("Localization"));
22 
23             var resourceNames = assembly.GetManifestResourceNames();
24             foreach (var resourceName in resourceNames)
25             {
26                 if (resourceName.EndsWith("en-US.json") || resourceName.EndsWith("zh-CN.json"))
27                 {
28                     using (var stream = assembly.GetManifestResourceStream(resourceName))
29                     {
30                         if (stream != null)
31                         {
32                             using (StreamReader reader = new StreamReader(stream))
33                             {
34                                 var content = reader.ReadToEnd();
35                                 Dictionary<string, string> localizationDictionary =
36                                     JsonConvert.DeserializeObject<Dictionary<string, string>>(content);
37                                 if (resourceName.EndsWith("en-US.json"))
38                                 {
39                                     _enDictionary = localizationDictionary;
40                                 }
41                                 else
42                                 {
43                                     _cnDictionary = localizationDictionary;
44                                 }
45                             }
46                         }
47                     }
48                 }
49             }
50         }
51 
52         public static string GetValue(string key, Culture culture)
53         {
54             switch (culture)
55             {
56                 case (Culture.Cn):
57                     {
58                         if (_cnDictionary.ContainsKey(key))
59                         {
60                             return _cnDictionary[key];
61                         }
62                         else
63                         {
64                             return $"[{key}]";
65                         }
66                     }
67                 case (Culture.En):
68                     {
69                         if (_enDictionary.ContainsKey(key))
70                         {
71                             return _enDictionary[key];
72                         }
73                         else
74                         {
75                             return $"[{key}]";
76                         }
77                     }
78                 default:
79                     {
80                         return $"[{key}]";
81                     }
82             }
83         }
84     }
85 }

這裡需要註意幾點：

　　1. enum類Culture用於代表要實現的語言，這裡我只是簡單的實現了中文和英文（其他我也不懂），對應的CultureConfigurer類就有中文和英文兩個Dictionary

　　2. 使用了Assembly.Load載入了程式集，參數為你自己的程式集名稱，我這裡就隨便寫了一個

　　3. 資源文件我選擇了json文件，也是為了方便js中調用，當然你也可以用xml或者任何你想要用的格式，只需要調整解析方法，把文件內容載入到對應的Dictionary中就可以了

　　4. 看到GetValue方法，相信大家都已經明白了，其實就是多語言不管是什麼語言，都用某個詞做key，然後調用這個方法“翻譯”成當前語言的詞。比如以“Open”作為Key，那麼中文Dictionary中就應該有一個KeyValuePair是"Open":"打開"，而相應的英文中應該有一個"Open":"Open"，那麼Culture為中文時，顯示就是“打開”，英文就是“Open”。

　　5. 資源文件可以創建在程式集中的任何位置，如果你的項目有project.json文件，那麼就在buildOptions裡面添加，註意根據自己的文件位置修改路徑

"embed": {
      "include": [
        "Localization/SourceFiles/*.json"
      ]
    }

　　如果是VS2017，是csproj文件，那麼右擊要添加的資源文件，選擇“屬性”，配置改為“所有配置”，配置屬性的高級中“生成操作”修改為“嵌入的資源”，如下圖：

到這裡，我們已經寫好了實現本地化的核心類，下麵要解決如何在頁面上顯示的問題：

　　在MVC項目中新建一個類MyRazorPage

 1 using System;
 2 using Microsoft.AspNetCore.Mvc.Razor;
 3 using Localization;
 4 
 5 namespace MVC.Views
 6 {
 7     public abstract class MyRazorPage<TModel> : RazorPage<TModel>
 8     {
 9         public virtual string L(string source)
10         {
11             var value = Context.Request.Cookies["__culture"];
12             Culture c;
13             if (string.IsNullOrEmpty(value) || !Enum.TryParse(value, out c))
14             {
15                 c = Culture.Cn;
16             }
17             return CultureConfigurer.GetValue(source, c);
18         }
19     }
20 }

　　註意這個類是一個抽象類，繼承了RazorPage<TModel>。然後在Views文件夾下找到_ViewImports.cshtml文件，在裡面添加一行“@inherits MVC.Views.MyRazorPage<TModel>”，這樣你的所有RazorPage就會繼承MyRazorPage這個類，也就是說你可以在MyRazorPage里寫自己想要用的方法，在cshtml里就可以直接調用啦。這裡我寫了一個L方法，調用了CultureConfigurer的GetValue方法。那麼，在頁面上需要翻譯的文字就只要寫成@L("Open")這樣的就可以啦。　　

　　可以看到，我是將用戶語言保存在Cookie中的，這裡大家可以有各自的實現方法。我的實現方法很簡單，用戶切換語言的時候就訪問一個介面，修改了代表語言的Cookie，然後刷新頁面就可以了。

　　有問題的話歡迎在下麵留言，這是我的第一篇博客，希望對大家有用吧！