VUE+.NET应用系统的国际化-多语言词条服务

上篇文章我们介绍了
VUE+.NET应用系统的国际化-整体设计思路
系统国际化改造整体设计思路如下：

• 提供一个工具，识别前后端代码中的中文，形成多语言词条，按语言、界面、模块统一管理多有的多语言词条
  
• 提供一个翻译服务，批量翻译多语言词条
  
• 提供一个词条服务，支持后端代码在运行时根据用户登录的语言，动态获取对应的多语言文本
  
• 提供前端多语言JS生成服务，按界面动态生成对应的多语言JS文件，方便前端VUE文件使用。
  
• 提供代码替换工具，将VUE前端代码中的中文替换为$t("词条ID")，后端代码中的中文替换为TermService.Current.GetText("词条ID")
  

今天，我们继续介绍多语言词条服务的设计和实现。
一、多语言词条设计
什么是多语言词条，即代码中需要支持多语言的文本。例如后台提示、前端界面的各类显示元素（Label、Button文字、Tooltips、标题、列表标题等等）。这些内容统一抽象为多语言词条。
多语言词条是产品多语言包的组成部分。支持在不同的语言下，显示对应的文本。

 上图中：
 I18NTerm代表多语言词条对象，主要描述了多语言词条的各个属性，主要的几个属性有：

1.         /// <summary>
2.         /// 词条的key
3.         /// </summary>
4.         public string Code { get; set; }
6.         /// <summary>
7.         /// 词条的名称
8.         /// </summary>
9.         public string Name { get; set; }
11.         /// <summary>
12.         /// 原始文本
13.         /// </summary>
14.         public string OriginalText { get; set; }
16.         /// <summary>
17.         /// 多语言词条子项
18.         /// </summary>
19.         public List<I18NTermItem> TranslateItems { get; set; } = new List<I18NTermItem>();
21.         /// <summary>
22.         /// 隶属的产品
23.         /// </summary>
24.         public string Product { get; set; }
26.         /// <summary>
27.         /// 隶属的关键应用/系统
28.         /// </summary>
29.         /// <remarks>
30.         /// 用于批量打包国际化JS文件
31.         /// </remarks>
32.         public string SubSystem { get; set; }
34.         /// <summary>
35.         /// 隶属的关键应用/系统编号
36.         /// </summary>
37.         /// <remarks>
38.         /// 用于批量打包国际化JS文件
39.         /// </remarks>
40.         public string SubSystemCode { get; set; }

复制代码

 一条词条，包含多个词条子项I18NTermItem，每一个词条子项，都代表了一种语言的翻译结果

1. public class I18NTermItem : CacheElement
2.     {
3.         /// <summary>
4.         /// 词条ID
5.         /// </summary>
6.         public string TermID { get; set; }
8.         /// <summary>
9.         /// 语言
10.         /// </summary>
11.         public string Language { get; set; }
13.         /// <summary>
14.         /// 翻译的文本
15.         /// </summary>
16.         public string TranslateText { get; set; }
18.         /// <summary>
19.         /// 用户自定义文本
20.         /// </summary>
21.         public string CustomText { get; set; }
23.         public string GetText()
24.         {
25.             if (string.IsNullOrEmpty(CustomText))
26.             {
27.                 return TranslateText;
28.             }
30.             return CustomText;
31.         }
32.     }

复制代码

 二、多语言词条管理服务
 有了多语言词条对象后，需要增加其对应的多语言词条管理服务，用于对词条的增删查改
 先定义一个多语言词条管理的接口II18NTermManageService

1. public interface II18NTermManageService
2.     {
3.         void Add(I18NTerm term);
5.         void Remove(string termId);
7.         void AddTerms(List<I18NTerm> terms);
9.         void RemoveTerms(List<string> terms);
11.         void Update(I18NTerm term);
13.         I18NTerm GetTerm(string termId);
15.         List<I18NTerm> GetTerms();
17.         List<I18NTerm> GetTerms(string sourceId);
19.         List<I18NTerm> GetTermsByApplication(string applicationId);
21.         List<I18NTerm> GetTermByConditions(string applicationId, string sourceId = null, string sourceLocation = null, string Dimension1 = null, string Dimension2 = null, string Dimension3 = null);
23.     }

复制代码

这个接口对应的实现中，可以采用EF完成词条数据的持久化操作，在这里不再详细展示了，大家根据需求自行实现即可。
三、多语言词条查询服务
系统在运行时，需要调用词条服务查询各类词条的翻译文本。因此，抽象一个多语言词条查询服务接口II18NTermService

1.     /// <summary>
2.     /// 词条查询服务接口
3.     /// </summary>
4.     public interface II18NTermService
5.     {
6.         /// <summary>
7.         /// 根据词条编号获取对应的词条翻译
8.         /// </summary>
9.         /// <param name="termCode">词条编号</param>
10.         /// <param name="defaultText">默认值，如果根据编号找不到词条或者词条对应的翻译将返回默认值</param>
11.         /// <returns></returns>
12.         string GetText(string termCode, string defaultText);
14.         /// <summary>
15.         /// 根据词条编号获取对应的词条翻译并格式化输出
16.         /// </summary>
17.         /// <param name="termCode">词条编号</param>
18.         /// <param name="defaultText">默认值，如果根据编号找不到词条或者词条对应的翻译将返回默认值</param>
19.         /// <param name="args">包含零个或多个要格式化的对象的对象数组</param>
20.         /// <returns></returns>
21.         string GetTextFormatted(string termCode, string defaultText, params object[] args);
23.         /// <summary>
24.         /// 根据词条编号获取对应的词条翻译
25.         /// </summary>
26.         /// <param name="termCode">词条编号</param>
27.         /// <param name="language">语言标识</param>
28.         /// <param name="defaultText">默认值，如果根据编号找不到词条或者词条对应的翻译将返回默认值</param>
29.         /// <returns></returns>
30.         string GetTextWithlanguage(string termCode,string language, string defaultText);
32.         /// <summary>
33.         /// 根据词条编号获取对应的词条翻译并格式化输出
34.         /// </summary>
35.         /// <param name="termCode">词条编号</param>
36.         /// <param name="language">语言标识</param>
37.         /// <param name="defaultText">默认值，如果根据编号找不到词条或者词条对应的翻译将返回默认值</param>
38.         /// <param name="args">包含零个或多个要格式化的对象的对象数组</param>
39.         /// <returns></returns>
40.         string GetTextFormattedWithlanguage(string termCode, string language, string defaultText, params object[] args);
42.         /// <summary>
43.         /// 批量获取词条，注意：此接口不能在特来电生产环境使用。
44.         /// </summary>
45.         /// <param name="termCodes"></param>
46.         /// <returns></returns>
47.         Dictionary<string,string> BatchGetText(List<string> termCodes);
48.     }

复制代码

这个接口的具体实现中，可以增加词条的Redis缓存和内存缓存，调用II18NTermManageService的实现逻辑，从数据库中查询持久化的词条数据。缓存到内存和Redis中，  以提升查询性能。
例如：

1. /// <summary>
2.         /// 获取词条翻译
3.         /// </summary>
4.         /// <param name="termCode">词条编号</param>
5.         /// <param name="defaultText">默认值，当找不到对应的词条时将返回默认值</param>
6.         /// <returns></returns>
7.         /// <exception cref="ArgumentNullException"></exception>
8.         public string GetText(string termCode, string defaultText)
9.         {
10.             if (string.IsNullOrWhiteSpace(termCode))
11.                 throw new ArgumentNullException($"Term Code is null, {termCode}");
12.             if (Teld.Core.Session.Service.AppContext.Current.Language == null)
13.             {
14.                 return defaultText;
15.             }
16.             string language = T.Core.Session.Service.AppContext.Current.Language.DisplayCode;
18.             string key = termCode + "&" + language;
20.             if (cache.TryGetValue(key, out var val))
21.             {
22.                 return val;
23.             }
25.             var termItem = termManageService.GetTermItem(termCode, language);
27.             if (termItem == null)
28.             {
29.                 TermMonitor.NotFound(termCode, language);
30.                 return defaultText;
31.             }
32.             else
33.             {
34.                 string text = termItem.GetText();
35.                 cache[key] = text;
36.                 return text;
37.             }
38.         }

复制代码

以上是多语言词条服务的设计和实现。
分享给大家
 
周国庆
2023/3/11
 

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！