DDD開發框架ABP之本地化資源的數據庫存儲擴展

      在上一篇《DDD開發框架ABP之本地化/多語言支持》中，我們知道，ABP開發框架中本地化資源存儲可以采用XML文件，RESX資源文件，也提供了其他自定義的存儲方式的擴展接口。ABP框架默認實現了前面兩種方式，而數據庫存儲方式則需要自己擴展，大概是因為數據庫存儲涉及到了實體和倉儲等方面的具體內容，不適合放在基本框架里面。

      以數據庫的方式存儲本地化資源，一個最明顯的好處就是方便修改，尤其是對於基於數據庫的應用系統而言，可以提供統一的維護界面。接下來我們就來一步步地實現將本地化資源存儲在數據庫中。

第一步 建立實體

      如果以XML存儲資源，我們需要建立XML的資源文件，支持多少種語言則需要建立多少個資源文件。那么以數據庫存儲資源文本，自然也需要建立實體，然后實現實體的讀操作。

      為了存儲資源，我們需要建立一個實體：

public class DBLocalization : Entity
{
    [Required]
    [StringLength(10)]
    public virtual string Culture { get; set; }
    [Required]
    [StringLength(50)]
    public virtual string Name { get; set; }
    [Required]
    public virtual string Value { get; set; }
}

      其中Culture屬性為語言代碼，比如en, zh-TW, zh-CN等。Name屬性為名稱，Value屬性為對應的文本。基類Entity是ABP框架提供的通用領域實體類，默認具有整型Id，且實現了IEntity接口。

第二步 建立領域服務

      領域服務提供對實體的數據操作，比如取得語言種類和語言字典。

public class DBLocalizationManager : DomainService
{
    private readonly IRepository<DBLocalization> _localizationRepository; 
    public DBLocalizationManager(IRepository<DBLocalization> localizationRepository) 
    {
        _localizationRepository = localizationRepository;
    }
    public List<CultureInfo> GetCultures() 
    {
        return _localizationRepository.GetAllList()
        .Select(p => new CultureInfo(p.Culture))
        .Distinct()
        .ToList<CultureInfo>();
    }
    public List<DBLocalization> GetDictionary()
    {
        return _localizationRepository.GetAllList();
    }
}

      其中IRepository<DBLocalization>以構造函數方式注入。

第三步 實現本地化資源接口（ILocalizationSource）

      ILocalizationSource是本地化框架的核心接口，接口方法包括：

      Name：資源名稱，
      Initialize()：初始化方法，注冊時被ABP調用
      string GetString(string name) 根據名稱取得文本
      IReadOnlyList<LocalizedString> GetAllStrings() 取得當前語言的全部字典清單

      ABP已經有三個實現了ILocalizationSource接口的類：NullLocalizationSource、ResourceFileLocalizationSource 和 DictionaryBasedLocalizationSource。

      把資源文本存儲於數據庫中，每次取得文本時都訪問數據庫取得數據，但基於性能的考慮，顯然將資源文本提前在初始化時一次性加載到內存，應該是更好地方式。由於DictionaryBasedLocalizationSource已經實現了內存字典的通用方法，我們不太需要再另外寫一個DBLocalizationSource。查看DictionaryBasedLocalizationSource代碼，可以看到其構造函數需要傳入一個ILocalizationDictionaryProvider的實例，這個實例用於取得本地化字典的詳細內容。
      接下來我們建立一個類實現ILocalizationDictionaryProvider接口：

public class DBLocalizationDictionaryProvider : ILocalizationDictionaryProvider
{
    private DBLocalizationManager _dbLocalizationManager;
    public IEnumerable<LocalizationDictionaryInfo> GetDictionaries(string sourceName)
    {
        if (_dbLocalizationManager == null) 
        {
            if (IocManager.Instance.IsRegistered<DBLocalizationManager>())
            {
            _dbLocalizationManager = IocManager.Instance.Resolve<DBLocalizationManager>();
            }
        }
        var dictionaries = new List<LocalizationDictionaryInfo>();
        foreach (var culture in _dbLocalizationManager.GetCultures())
        {
            dictionaries.Add(
                new LocalizationDictionaryInfo(
                    DBLocalizationDictionary.Build(culture.Name,
                    _dbLocalizationManager.GetDictionary()) ,
                    isDefault: culture.Name == ZeroConsts.DefaultLanguage
                )
            );
        }
        return dictionaries;
    }
}

      該類實現了接口的GetDictionaries方法，取得字典對象DBLocalizationDictionary。方法首先利用依賴注入容器自動得到一個IDBLocalizationManager的實例。

      下面是DBLocalizationDictionary字典類的實現代碼：

public class DBLocalizationDictionary : LocalizationDictionary
{
    private DBLocalizationDictionary(CultureInfo cultureInfo)
        : base(cultureInfo)
    {
    }
    public static DBLocalizationDictionary Build(string cultureName, List<DBLocalization> dictList)
    {
        try
        {
            var dictionary = new DBLocalizationDictionary(new CultureInfo(cultureName));
            var dublicateNames = new List<string>();
            if (dictList != null && dictList.Count>0)
            {
                foreach (DBLocalization item in dictList.FindAll(c => c.Culture == cultureName))
                {
                    if (string.IsNullOrEmpty(item.Name))
                    {
                        throw new AbpException("name of a dictionary is empty in given data.");
                    }
                    if (dictionary.Contains(item.Name))
                    {
                        dublicateNames.Add(item.Name);
                    }
                    dictionary[item.Name] = item.Value.NormalizeLineEndings();
                }
            }
            if (dublicateNames.Count > 0)
            {
                throw new AbpException("A dictionary can not contain same key twice. There are some duplicated names: " + dublicateNames.JoinAsString(", "));
            }
            return dictionary;
        }
        catch (Exception ex)
        {
            throw new AbpException("Invalid localization data format! ", ex);
        }
    }
}

第四步 注冊資源

      在需要使用多語言本地化的模塊，我們可以在模塊的PreInitialize方法中，注冊資源。一個模塊可以在Configuration.Localization.Sources 集合中添加多個資源，只要實現了ILocalizationSource接口即可。

public override void PreInitialize()
{
    Configuration.Localization.Sources.Add(
        new DictionaryBasedLocalizationSource("Zero", new DBLocalizationDictionaryProvider()));
}

　　到這里，將本地化資源存儲在數據庫中就基本上已經全部實現，剩下的就是開發界面對本地化資源進行增刪改查的維護了。