国际化集成解决方案

更新记录

版本 日期 修改人 修改内容
1.0.0 2020年7月28日 蔺浪(510525) 新建文档

概念

  • 以下提到“器材”泛指管理平台上的实验器材/组件/药品等实验资源,下文不再累述。

方案总览

2.2.1.2 下载器材语言包(键值对)
2.2.1.1 下载器材资源包
2.2.2. 使用器材语言包进行翻译
2.2.1. 通过资源中心组件下载器材资源
2.1.2. 通过请求响应数据获取器材信息(协定:已翻译)
2.1.1. 通过资源中心组件请求器材列表数据
2.2 器材参数
2.1 器材列表
1.2. 使用多语言文件进行翻译
1.1. 本地配置多语言文件(键值对)
2. 器材
1. 应用/UI组件
国际化方案

方案细述

应用国际化

  • 应用国际化指的是应用自己的UI文本显示当前语言环境下的翻译文本,如下图所示:
  1. 多语言文件配置
    以键值对方式配置多语言文本文件(建议key命名最好遵循某种特定的规范),如下图所示:

    一种语言配置一个单独的多语言文本文件,如下图所示:

  2. 多语言文件载入
    翻译组件提供接口,可以将上述多语言文本文件内容载入,存为字典。

  3. 多语言文本翻译
    翻译组件提供接口,设置当前语言环境;
    翻译组件提供接口,可以获取指定Key对应的当前语言环境下的翻译文本。

UI组件国际化

  • UI组件国际化指的是PlayerCoreUI组件自己的UI文本显示当前语言环境下的翻译文本,如下图所示:
  1. 多语言文件配置
    以键值对方式配置多语言文本文件(key命名最好遵循某种特定的规范),如下图所示:

    一种语言配置一个单独的多语言文本文件,如下图所示:

  2. 多语言文件载入
    翻译组件提供接口,可以将上述多语言文本文件内容载入,存为字典。

  3. 多语言文本翻译
    翻译组件提供接口,设置当前语言环境;
    翻译组件提供接口,可以获取指定Key对应的当前语言环境下的翻译文本。

器材国际化

器材列表国际化

  • 若应用中需要以列表方式显示管理平台上的器材,如下图所示:
  1. 器材名称翻译
    器材名称多语言翻译在管理平台上进行,如下图所示:

  2. 器材列表请求
    资源中心组件提供接口,获取管理平台上的器材列表数据;

  3. 器材名称获取
    通过资源中心组件获取到的器材列表数据来自于管理平台响应的数据,按照协定,器材数据中的器材名称在管理平台上已经处理翻译,直接取用即可。

器材参数国际化

  • 器材参数因器材不用而有差异,器材参数的翻译依赖的是器材多语言包文件;器材参数面板如下图所示:

器材资源下载

  • 资源中心组件提供接口,从管理平台下载器材资源以及当前语言环境下的语言包文件(内容为语言文本键值对),如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):



器材参数翻译

  1. 器材参数Key说明
    Key统一以“I18N/{Code}/{SubKeyName}的形式;
    在需要国际化的地方必须以完整的Key来传递, 其中{Code}可以是管理平台上个的器材或组件,{SubKeyName} 由器材的开发发人员自行定义使用,保证器材内不重复即可;参见器材国际化方案
    例如器材菜单,如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):

  2. 器材名称Key翻译
    例如key:I18N/TuoPanTianPing/ObjName
    则:器材编码为“TuoPanTianPing”,PC下缓存资源目录为“TuoPanTianPing_PC”;多语言key为“ObjName”
    获取翻译如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):

  3. 器材别名Key翻译
    器材别名Key配置在颗粒文件(.lab)文件中
    例如key:I18N/BoLiShuiCaoElement/ObjAnotherName
    则:器材编码为“BoLiShuiCaoElement”,PC下缓存资源目录为“BoLiShuiCaoElement_PC”;多语言key为“ObjAnotherName”
    获取翻译如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):

  4. 器材参数常规Key翻译
    例如key:I18N/TuoPanTianPing/ValueParas0WeiTiaoPing
    则:器材编码为“TuoPanTianPing”,PC下缓存资源目录为“TuoPanTianPing_PC”;多语言key为“ValueParas0WeiTiaoPing”
    获取翻译如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):

  5. 器材参数格式化Key翻译
    例如key:I18N/TuoPanTianPing/YouMa2,3.80
    这是种协定格式的多语言key
    则:器材编码为“TuoPanTianPing”,PC下缓存资源目录为“TuoPanTianPing_PC”;多语言key为“YouMa2”
    获取翻译如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):

  6. 器材参数公用Key翻译
    例如key:I18N/VLabElementBase/Oxide
    这是器材公用的资源中配置的,需要用到的器材都可以传入这个key来获取翻译文本;
    例如器材“DaTiePianElement”就会传入这个key来获取翻译文本;
    则:器材编码为“VLabElementBase”,PC下缓存资源目录为“VLabElementBase_PC”;多语言key为“Oxide”
    获取翻译如下图所示(图示旨在举例说明逻辑,因平台上资源更新变动,该例子可能不复见):

方案实施

  • 生产器材资源与多语言包资源,上传管理平台;
  • 资源中心组件实现管理平台上器材资源,器材多语言包下载以及资源缓存,支持资源信息获取;
  • 翻译组件实现多语言文件载入与多语言key文本翻译;
  • 应用接入资源中心组件以及翻译组件,实现UI显示翻译文本。

干系人清单

干系人 干系
黄金民 方案设计
蔺浪(510525) 参与方案讨论,方案文档输出

相关链接