在國際化環境下，越來越多的程序需要做多語言版本，以適應各種業務需求的變化。在Winform應用程序中實現多語言也有常規的處理方式處理，不過需要針對每個語言版本，重新修改Winform界面的顯示，對一些常規的輔助類，也需要引入一個統一的資源管理類來處理多語言的問題，相對比較繁瑣。本篇隨筆針對多語言的需求，希望盡量避免繁瑣的操作，既能符合本地語種開發人員的開發習慣，又能快速實現Winform程序的多語言場景處理。
1、多語言開發的困惑和思路
在常規的多語言版本程序中，開發總是伴隨著很多不愉快的事情，大概列舉一些僅供參考：
1）對窗體的多語言處理時，維護多個語言版本的界面非常繁瑣；
2）多語言處理的時候，以資源參照的時候，默認鍵值為一些英文字符串或者單詞，不太符合如中文語境的開發，調整代碼則需要很多工作量；
3）對于已開發好的程序，全面引入多語言的處理代碼，需要大量修改；
4）對于大量中文的多語言處理，工作量望而卻步；
5）對于常規Resx文件的處理覺得繁瑣
6）缺乏一個統一處理多語言需求的方案
在多語言的處理上，我一直希望找出一種高效的處理方式，由于我的Winform開發框架中很多模塊是現成的，希望能夠使用繼承處理的方式，實現最簡化的處理；
同時大量中文的英文（針對英文版本）翻譯也是一個頭痛的事情，突然想到百度的翻譯API接口可以利用，那么我們可以利用翻譯接口實現開始的翻譯，然后對資源進行一定的調整則可以提高效率和準確率。
對于編輯和承載多語言的信息，我一直覺得JSON格式挺好的，可以利用它序列化為字典集合，通過字典獲取對應鍵值的多語言版本字符串也是很高效的一種方式，那么就決定用JSON來存儲多語言信息了，易讀好用。
對于多余的處理邏輯，盡量封裝為獨立的模塊，可以在多個模塊中進行調用處理。
2、多語言的處理實現
在思考多語言的合理處理方案過程中，參考了另一位博友的文章《分享兩種實現Winform程序的多語言支持的解決方案》，思路有點符合我的期望，因此吸收了一些處理思想進行處理，目的就是提高開發效率。
1）多語言的信息存儲和加載
首先，我們來看看多語言處理的目錄和格式問題，目錄大概是根據多語言的簡稱進行放置，如下所示。
這個目錄就是會輸出到debug或者Release的運行目錄中，我們就是根據相對于運行目錄進行資源讀取即可，所有模塊共用同一的多語言文件，我們可以把各個模塊基礎通用的多語言文件放在Basic.json文件中，也可以根據模塊獨立起名，主程序如TestMultiLanguage的多語言文件我則放在TestMultiLanguage.json文件中。實際上目錄名稱是為了區分而已，程序加載的時候，會把目錄下面所有的JSON文件進行加載，讀取里面的鍵值作為資源的字典參照。
多語言的JSON文件是標準的Json格式，只是我們只用鍵值的字典參考即可，不需要使用復雜的JSON對象格式，如下是basic.json文件的部分內容。
這些資源文件采用中文-英文的參照方式，我們以我們常規的母語開發，即使我們不做多語言，也不影響代碼的正常處理，我們只需要把窗體上和代碼里面的中文提取出來，然后進行多語言處理（如變為英文）即可。
由于我們使用鍵值字典對象的JSON內容，那么我們就可以把這些內容序列號為字典集合，如下代碼我們可以通過 JSON.NET 組件把它們序列化為字典集合，這些字典集合就是我們用來做多語言的關鍵。
var content = File.ReadAllText(file, Encoding.UTF8);
if (!string.IsNullOrEmpty(content))
{
var dict = JsonConvert.DeserializeObject<Dictionary<string, string>>(content);
foreach (string key in dict.Keys)
{
//遍歷集合如果語言資源鍵值不存在，則創建，否則更新
if (!resources.ContainsKey(key))
{
resources.Add(key, dict[key]);
}
else
{
resources[key] = dict[key];
}
}
}
加載多語言處理的時候，我們遍歷相對目錄下的lang/***里面的文件即可實現多語言信息的加載，如下代碼所示。
/// <summary>
/// 根據語言初始化信息。
/// 加載對應語言的JSON信息，把翻譯信息存儲在全屬性resources里面。
/// </summary>
/// <param name="language">默認的語言類型，如zh-Hans，en-US等</param>
private void LoadLanguage(string language = "")
{
if (string.IsNullOrEmpty(language))
{
language = System.Threading.Thread.CurrentThread.CurrentUICulture.Name;
}
this.resources = new Dictionary<string, string>();
string dir = Path.Combine(AppDomain.CurrentDomain.BaseDirectory, string.Format("lang/{0}", language));
if (Directory.Exists(dir))
{
var jsonFiles = Directory.GetFiles(dir, "*.json", SearchOption.AllDirectories);
foreach (string file in jsonFiles)
{
LoadFile(file);
}
}
}
我們把多語言的加載和翻譯處理，放在一個獨立的項目上，如我定義為框架的一個模塊：WHC.Framework.Language
這樣我們在各個模塊中使用多語言處理過程的時候，包含這個模塊就可以了。
2）多語言信息的翻譯
做多語言的版本程序，翻譯工作也是一個繁瑣的工作，如果你是非常精通各種語言（如中文、英文、日文等等），那當然不在話下，不過我們做開發的多少也是會一些的，如英語吧，即時不能非常準確，那么也可以做到差不多，但是做這個還是累，還容易敲打錯別字，那么用第三方提供的翻譯API來預處理后調整，結果就簡化很多了，可以極大提高效率的。
這里以我們經常使用的百度翻譯來實現（用Google翻譯也可以，增加接口實現即可）
百度翻譯接口的使用，你先注冊一個開發賬戶，獲得相應的秘鑰信息就可以使用免費的翻譯接口了（http://api.fanyi.baidu.com/api/trans/product/index）。
有了這些準備后，就可以利用C#代碼進行翻譯處理了。
百度翻譯的接口處理代碼如下所示。
/// <summary>
/// 百度接口翻譯
/// </summary>
/// <param name="inputString">輸入字符串</param>
/// <param name="from">源內容語言</param>
/// <param name="to">目標語言</param>
/// <returns></returns>
private static string BaiduTranslate(string inputString, string from = "zh", string to = "en")
{
string content = "";
string appId = "你的APPID";
string securityId = "你的秘鑰";
int salt = 0;
StringBuilder signString = new StringBuilder();
string md5Result = string.Empty;
//1.拼接字符,為了生成sign
signString.Append(appId);
signString.Append(inputString);
signString.Append(salt);
signString.Append(securityId);
//2.通過md5獲取sign
byte[] sourceMd5Byte = Encoding.UTF8.GetBytes(signString.ToString());
MD5 md5 = new MD5CryptoServiceProvider();
byte[] destMd5Byte = md5.ComputeHash(sourceMd5Byte);
md5Result = BitConverter.ToString(destMd5Byte).Replace("-", "");
md5Result = md5Result.ToLower();
try
{
//3.獲取web翻譯的json結果
WebClient client = new WebClient();
string url = string.Format("http://api.fanyi.baidu.com/api/trans/vip/translate?q={0}&from=zh&to=en&appid={1}&salt={2}&sign={3}", inputString, appId, salt, md5Result);
byte[] buffer = client.DownloadData(url);
string result = Encoding.UTF8.GetString(buffer);
var trans = JsonConvert.DeserializeObject<TranslationJson>(result);
if (trans != null)
{
content = trans.trans_result[0].dst;
content = StringUtil.ToProperCase(content);
}
}
catch(Exception ex)
{
Debug.WriteLine(ex);
}
return content;
}
其中把JSON轉換為類對象需要兩個類，對翻譯結果進行轉換，如下代碼所示。
internal class TranslationJson
{
public string from { get; set; }
public string to { get; set; }
public List<TranslationResult> trans_result { get; set; }
}
internal class TranslationResult
{
public string src { get; set; }
public string dst { get; set; }
}
這樣我們在多語言處理的時候，可以對默認輸入為空的鍵值進行翻譯即可（如英文翻譯）。
//遍歷集合進行翻譯
var value = dict[key];
if (string.IsNullOrWhiteSpace(value))
{
//如果值為空，那么調用翻譯接口處理
var newValue = TranslationHelper.Translate(key, from, to);
if (!string.IsNullOrWhiteSpace(newValue))
{
dict[key] = newValue;
}
}
然后重新更新我們的資源文件就可以了
//不排序
var newContent = JsonConvert.SerializeObject(dict, Formatting.Indented);
File.WriteAllText(file, newContent, Encoding.UTF8);
如果需要對鍵值進行排序，那么使用SortDictionary進行包裝下即可
//進行排序
SortedDictionary<string, string> sortedDict = new SortedDictionary<string, string>(dict);
var newContent = JsonConvert.SerializeObject(sortedDict, Formatting.Indented);
在多語言處理的時候，我們一般不必要一次填寫完畢中英文對照的資源，我們可以先把字典鍵值的鍵寫出來，值保留為空，如下文件所示。
運行程序的時候，讓翻譯的接口先行翻譯，然后我們再對翻譯的資源進行調整，適應我們程序的語境即可，翻譯后的內容后如下所示。
好了，彈藥都準備好了，就看我們如何使用， 下一步介紹如何使用這些資源。
3、多語言在界面中的應用
前面介紹都是為程序界面準備好對應的多語言資源內容，我們在程序啟動的時候，可以通過常規的方式，設置界面的CurrentUICulture區域信息，如下代碼所示。
//界面多語言
//System.Threading.Thread.CurrentThread.CurrentUICulture = new System.Globalization.CultureInfo("zh-Hans");//中文界面
System.Threading.Thread.CurrentThread.CurrentUICulture = new System.Globalization.CultureInfo("en-US");//英文界面
然后我們在Winform程序中開發設計我們的界面內容，例如設計一個普通的界面如下所示。
這個窗體我們添加了幾個按鈕，并設置它的中文顯示內容，它的基類默認還是保持它的DevExpress基類 XtraForm，如下所示。
/// <summary>
/// 測試多語言的窗體界面
/// </summary>
public partial class Form1 : XtraForm
那么我們如果要自動實現多語言的處理，那么還需要在窗體的Load或者Shown事件里面實現處理，如下代碼所示。
private void Form1_Shown(object sender, EventArgs e)
{
//窗體加載并顯示后，對窗體實現多語言處理
if (!this.DesignMode)
{
LanguageHelper.InitLanguage(this);
}
}
如果我們為每個窗體都需要添加這些代碼，也是繁瑣的事情，那么我們可以把這個處理邏輯，放到我們常規自定義的窗體基類里面（如BaseForm），那么我們就不需要任何額外的代碼了。
所需的就是集成窗體基類即可，這也是我們一般開發都做的事情，通過繼承使得我們的代碼又省去了。
/// <summary>
/// 測試多語言的窗體界面
/// </summary>
public partial class Form1 : BaseForm
那么我們真正關注的就是我們前面介紹的邏輯代碼實現了
LanguageHelper.InitLanguage(this);
這個輔助類，主要就是在窗體初始化后，遍歷界面的所有類型控件，對控件進行相應的多語言處理。
/// <summary>
/// 對界面控件進行多語言的處理輔助類
/// </summary>
public class LanguageHelper
{
/// <summary>
/// 初始化語言
/// </summary>
public static void InitLanguage(Control control)
{
//如果沒有資源，那么不必遍歷控件，提高速度
if (!JsonLanguage.Default.HasResource)
return;
//使用遞歸的方式對控件及其子控件進行處理
SetControlLanguage(control);
foreach (Control ctrl in control.Controls)
{
InitLanguage(ctrl);
}
//工具欄或者菜單動態構建窗體或者控件的時候，重新對子控件進行處理
control.ControlAdded += (sender, e) =>
{
InitLanguage(e.Control);
};
}
通過遞歸的方式，我們可以對常規的如GridControl，工具欄、NavBar導航欄、菜單、按鈕等資源進行統一的多語言處理，而這里面對于我們開發應用程序界面，都不需要額外的擔心，極大的提高了效率。
下面是幾個常規的界面，我們來體驗下英文版本的界面效果。
這些英文界面我們只需要把界面的中文提取出來放到JSON文件中，自動翻譯再調整即可，然后界面繼承保持BaseForm或者BaseDock這些窗體基類不變，只是調整了這些基類的加載，增加一行代碼就可以順利實現了多語言的效果了。
這樣我們就把核心的工作放在提取界面中的中文資源并進行整理即可，這是核心的工作但翻譯也基本不用自己從頭做，窗體代碼幾乎不需要做其他修改就實現了我們所需要的多語言效果了，這樣做極大提高了開發效率，對于我們已經開發好的模塊，更是四兩撥千斤了。
