程序中經常會出現一些錯誤碼、狀態標識或枚舉值,為了編程方便,這些內容通常不用漢字,而是 FileError 之類的標識或數字。但這些信息往往需要直接或間接地呈現給用戶,而用戶真正需要的是易於理解的中文描述。
以往的做法要麼把標識與枚舉的轉換規則硬編碼進程序,擴展性差;要麼直接把內碼拋給用戶,讓人一頭霧水。如今可以改用流行的 XML(作為配置文件)來保存提示信息,再透過一個對象把機器內碼轉換成人們易讀的信息。
下面是一個名為 Translation 的翻譯類,它根據配置文件把系統內部碼(錯誤碼、成功碼)翻譯成中文:
public static class Translation
{
private static System.IO.FileSystemWatcher watcher;
private static XmlDocument content;
private static string configFile;
private static object locker = new object();
// 加載指定配置文件
public static void Configure(string configFile)
{
LoadFile(configFile);
if (watcher != null) { watcher.Dispose(); }
watcher = new FileSystemWatcher(
Path.GetDirectoryName(configFile),
Path.GetFileName(configFile));
watcher.Changed += new FileSystemEventHandler(watcher_Changed);
}
// 加載默認配置文件
public static void Configure()
{
if (System.Web.HttpContext.Current != null)
{
Configure(System.Web.HttpContext.Current.Server
.MapPath("~/translation.config"));
}
else
{
Configure(System.AppDomain.CurrentDomain
.SetupInformation.ApplicationBase + "translation.config");
}
}
// 加載文件內容
private static void LoadFile(string configFile)
{
lock (locker)
{
XmlDocument doc = new XmlDocument();
doc.Load(configFile);
content = doc;
Translation.configFile = configFile;
}
}
// 文件變更時重新加載
private static void watcher_Changed(object sender, FileSystemEventArgs e)
{
LoadFile(configFile);
}
...
}
這個類的設計有幾個亮點:
/translation/description[@group='...']/add[@key='...']/@value,從配置中取出對應的可讀文本。整個思路很清晰:把易變的文案從代碼中剝離到 XML 配置,讓翻譯規則的維護變得靈活而直觀。