VUE+.NET應用系統的國際化-多語言詞條服務

Eric zhou發表於2023-03-11
Vue

上篇文章我們介紹了

VUE+.NET應用系統的國際化-整體設計思路

系統國際化改造整體設計思路如下：

  1. 提供一個工具，識別前後端程式碼中的中文，形成多語言詞條，按語言、介面、模組統一管理多有的多語言詞條
  2. 提供一個翻譯服務，批次翻譯多語言詞條
  3. 提供一個詞條服務，支援後端程式碼在執行時根據使用者登入的語言，動態獲取對應的多語言文字
  4. 提供前端多語言JS生成服務，按介面動態生成對應的多語言JS檔案，方便前端VUE檔案使用。
  5. 提供程式碼替換工具，將VUE前端程式碼中的中文替換為$t("詞條ID")，後端程式碼中的中文替換為TermService.Current.GetText("詞條ID")

今天，我們繼續介紹多語言詞條服務的設計和實現。

一、多語言詞條設計

什麼是多語言詞條，即程式碼中需要支援多語言的文字。例如後臺提示、前端介面的各類顯示元素（Label、Button文字、Tooltips、標題、列表標題等等）。這些內容統一抽象為多語言詞條。

多語言詞條是產品多語言包的組成部分。支援在不同的語言下，顯示對應的文字。

 上圖中：

 I18NTerm代表多語言詞條物件，主要描述了多語言詞條的各個屬性，主要的幾個屬性有：

        /// <summary>
        /// 詞條的key
        /// </summary>
        public string Code { get; set; }

        /// <summary>
        /// 詞條的名稱
        /// </summary>
        public string Name { get; set; }

        /// <summary>
        /// 原始文字
        /// </summary>
        public string OriginalText { get; set; }

        /// <summary>
        /// 多語言詞條子項
        /// </summary>
        public List<I18NTermItem> TranslateItems { get; set; } = new List<I18NTermItem>();

        /// <summary>
        /// 隸屬的產品
        /// </summary>
        public string Product { get; set; }

        /// <summary>
        /// 隸屬的關鍵應用/系統
        /// </summary>
        /// <remarks>
        /// 用於批次打包國際化JS檔案
        /// </remarks>
        public string SubSystem { get; set; }

        /// <summary>
        /// 隸屬的關鍵應用/系統編號
        /// </summary>
        /// <remarks>
        /// 用於批次打包國際化JS檔案
        /// </remarks>
        public string SubSystemCode { get; set; }

 一條詞條，包含多個詞條子項I18NTermItem，每一個詞條子項，都代表了一種語言的翻譯結果

 public class I18NTermItem : CacheElement
    {
        /// <summary>
        /// 詞條ID
        /// </summary>
        public string TermID { get; set; }

        /// <summary>
        /// 語言
        /// </summary>
        public string Language { get; set; }

        /// <summary>
        /// 翻譯的文字
        /// </summary>
        public string TranslateText { get; set; }

        /// <summary>
        /// 使用者自定義文字
        /// </summary>
        public string CustomText { get; set; }

        public string GetText()
        {
            if (string.IsNullOrEmpty(CustomText))
            {
                return TranslateText;
            }

            return CustomText;
        }
    }

 二、多語言詞條管理服務

 有了多語言詞條物件後，需要增加其對應的多語言詞條管理服務，用於對詞條的增刪查改

 先定義一個多語言詞條管理的介面II18NTermManageService

public interface II18NTermManageService
    {
        void Add(I18NTerm term);

        void Remove(string termId);

        void AddTerms(List<I18NTerm> terms);

        void RemoveTerms(List<string> terms);

        void Update(I18NTerm term);

        I18NTerm GetTerm(string termId);

        List<I18NTerm> GetTerms();

        List<I18NTerm> GetTerms(string sourceId);

        List<I18NTerm> GetTermsByApplication(string applicationId);

        List<I18NTerm> GetTermByConditions(string applicationId, string sourceId = null, string sourceLocation = null, string Dimension1 = null, string Dimension2 = null, string Dimension3 = null);

    }

這個介面對應的實現中，可以採用EF完成詞條資料的持久化操作，在這裡不再詳細展示了，大家根據需求自行實現即可。

三、多語言詞條查詢服務

系統在執行時，需要呼叫詞條服務查詢各類詞條的翻譯文字。因此，抽象一個多語言詞條查詢服務介面II18NTermService

    /// <summary>
    /// 詞條查詢服務介面
    /// </summary>
    public interface II18NTermService
    {
        /// <summary>
        /// 根據詞條編號獲取對應的詞條翻譯
        /// </summary>
        /// <param name="termCode">詞條編號</param>
        /// <param name="defaultText">預設值，如果根據編號找不到詞條或者詞條對應的翻譯將返回預設值</param>
        /// <returns></returns>
        string GetText(string termCode, string defaultText);

        /// <summary>
        /// 根據詞條編號獲取對應的詞條翻譯並格式化輸出
        /// </summary>
        /// <param name="termCode">詞條編號</param>
        /// <param name="defaultText">預設值，如果根據編號找不到詞條或者詞條對應的翻譯將返回預設值</param>
        /// <param name="args">包含零個或多個要格式化的物件的物件陣列</param>
        /// <returns></returns>
        string GetTextFormatted(string termCode, string defaultText, params object[] args);

        /// <summary>
        /// 根據詞條編號獲取對應的詞條翻譯
        /// </summary>
        /// <param name="termCode">詞條編號</param>
        /// <param name="language">語言標識</param>
        /// <param name="defaultText">預設值，如果根據編號找不到詞條或者詞條對應的翻譯將返回預設值</param>
        /// <returns></returns>
        string GetTextWithlanguage(string termCode,string language, string defaultText);

        /// <summary>
        /// 根據詞條編號獲取對應的詞條翻譯並格式化輸出
        /// </summary>
        /// <param name="termCode">詞條編號</param>
        /// <param name="language">語言標識</param>
        /// <param name="defaultText">預設值，如果根據編號找不到詞條或者詞條對應的翻譯將返回預設值</param>
        /// <param name="args">包含零個或多個要格式化的物件的物件陣列</param>
        /// <returns></returns>
        string GetTextFormattedWithlanguage(string termCode, string language, string defaultText, params object[] args);

        /// <summary>
        /// 批次獲取詞條，注意：此介面不能在特來電生產環境使用。
        /// </summary>
        /// <param name="termCodes"></param>
        /// <returns></returns>
        Dictionary<string,string> BatchGetText(List<string> termCodes);
    }

這個介面的具體實現中，可以增加詞條的Redis快取和記憶體快取，呼叫II18NTermManageService的實現邏輯，從資料庫中查詢持久化的詞條資料。快取到記憶體和Redis中，  以提升查詢效能。

例如：

 /// <summary>
        /// 獲取詞條翻譯
        /// </summary>
        /// <param name="termCode">詞條編號</param>
        /// <param name="defaultText">預設值，當找不到對應的詞條時將返回預設值</param>
        /// <returns></returns>
        /// <exception cref="ArgumentNullException"></exception>
        public string GetText(string termCode, string defaultText)
        {
            if (string.IsNullOrWhiteSpace(termCode))
                throw new ArgumentNullException($"Term Code is null, {termCode}");
            if (Teld.Core.Session.Service.AppContext.Current.Language == null)
            {
                return defaultText;
            }
            string language = T.Core.Session.Service.AppContext.Current.Language.DisplayCode;

            string key = termCode + "&" + language;

            if (cache.TryGetValue(key, out var val))
            {
                return val;
            }

            var termItem = termManageService.GetTermItem(termCode, language);

            if (termItem == null)
            {
                TermMonitor.NotFound(termCode, language);
                return defaultText;
            }
            else
            {
                string text = termItem.GetText();
                cache[key] = text;
                return text;
            }
        }

以上是多語言詞條服務的設計和實現。

分享給大家

 

周國慶

2023/3/11

 

相關文章