在WinForm应用程序中快速实现多语言的处理的方法

程序员文章站 2023-12-17 15:10:58

在国际化环境下，越来越多的程序需要做多语言版本，以适应各种业务需求的变化。在winform应用程序中实现多语言也有常规的处理方式处理，不过需要针对每个语言版本，重新修改wi...

在国际化环境下，越来越多的程序需要做多语言版本，以适应各种业务需求的变化。在winform应用程序中实现多语言也有常规的处理方式处理，不过需要针对每个语言版本，重新修改winform界面的显示，对一些常规的辅助类，也需要引入一个统一的资源管理类来处理多语言的问题，相对比较繁琐。本篇随笔针对多语言的需求，希望尽量避免繁琐的操作，既能符合本地语种开发人员的开发习惯，又能快速实现winform程序的多语言场景处理。

1、多语言开发的困惑和思路

在常规的多语言版本程序中，开发总是伴随着很多不愉快的事情，大概列举一些仅供参考：

1）对窗体的多语言处理时，维护多个语言版本的界面非常繁琐；

2）多语言处理的时候，以资源参照的时候，默认键值为一些英文字符串或者单词，不太符合如中文语境的开发，调整代码则需要很多工作量；

3）对于已开发好的程序，全面引入多语言的处理代码，需要大量修改；

4）对于大量中文的多语言处理，工作量望而却步；

5）对于常规resx文件的处理觉得繁琐

6）缺乏一个统一处理多语言需求的方案

在多语言的处理上，我一直希望找出一种高效的处理方式，由于我的winform开发框架中很多模块是现成的，希望能够使用继承处理的方式，实现最简化的处理；

同时大量中文的英文（针对英文版本）翻译也是一个头痛的事情，突然想到百度的翻译api接口可以利用，那么我们可以利用翻译接口实现开始的翻译，然后对资源进行一定的调整则可以提高效率和准确率。

对于编辑和承载多语言的信息，我一直觉得json格式挺好的，可以利用它序列化为字典集合，通过字典获取对应键值的多语言版本字符串也是很高效的一种方式，那么就决定用json来存储多语言信息了，易读好用。

对于多余的处理逻辑，尽量封装为独立的模块，可以在多个模块中进行调用处理。

2、多语言的处理实现

在思考多语言的合理处理方案过程中，参考了另一位博友的文章《分享两种实现winform程序的多语言支持的解决方案》，思路有点符合我的期望，因此吸收了一些处理思想进行处理，目的就是提高开发效率。

1）多语言的信息存储和加载

首先，我们来看看多语言处理的目录和格式问题，目录大概是根据多语言的简称进行放置，如下所示。

在WinForm应用程序中快速实现多语言的处理的方法

这个目录就是会输出到debug或者release的运行目录中，我们就是根据相对于运行目录进行资源读取即可，所有模块共用同一的多语言文件，我们可以把各个模块基础通用的多语言文件放在basic.json文件中，也可以根据模块独立起名，主程序如testmultilanguage的多语言文件我则放在testmultilanguage.json文件中。实际上目录名称是为了区分而已，程序加载的时候，会把目录下面所有的json文件进行加载，读取里面的键值作为资源的字典参照。

多语言的json文件是标准的json格式，只是我们只用键值的字典参考即可，不需要使用复杂的json对象格式，如下是basic.json文件的部分内容。

在WinForm应用程序中快速实现多语言的处理的方法

这些资源文件采用中文-英文的参照方式，我们以我们常规的母语开发，即使我们不做多语言，也不影响代码的正常处理，我们只需要把窗体上和代码里面的中文提取出来，然后进行多语言处理（如变为英文）即可。

由于我们使用键值字典对象的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翻译也可以，增加接口实现即可）

百度翻译接口的使用，你先注册一个开发账户，获得相应的秘钥信息就可以使用免费的翻译接口了（）。

在WinForm应用程序中快速实现多语言的处理的方法

有了这些准备后，就可以利用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);

在多语言处理的时候，我们一般不必要一次填写完毕中英文对照的资源，我们可以先把字典键值的键写出来，值保留为空，如下文件所示。

在WinForm应用程序中快速实现多语言的处理的方法

运行程序的时候，让翻译的接口先行翻译，然后我们再对翻译的资源进行调整，适应我们程序的语境即可，翻译后的内容后如下所示。

在WinForm应用程序中快速实现多语言的处理的方法

好了，弹药都准备好了，就看我们如何使用，下一步介绍如何使用这些资源。

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程序中开发设计我们的界面内容，例如设计一个普通的界面如下所示。

在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导航栏、菜单、按钮等资源进行统一的多语言处理，而这里面对于我们开发应用程序界面，都不需要额外的担心，极大的提高了效率。

下面是几个常规的界面，我们来体验下英文版本的界面效果。

在WinForm应用程序中快速实现多语言的处理的方法