Module Zero之语言管理

返回《Module Zero学习目录》


概览介绍

ABP定义了一个健壮的UI本地化系统,它可用于服务端和客户端。它允许在不同的资源中(Resource文件和XML文件是两种预定义的资源)轻松地配置应用语言以及定义本地化文本(字符串)。

虽然这对于大多数情况是没问题的,但是我们可能想要将语言和文本动态地定义到数据库中。Module-zero允许我们动态地管理每个租户的应用语言和文本。

如何开启

启动模板

如果你是从ABP官网的启动模板创建的项目,那么你可以跳过本节。因为该模板自带的基于数据库的本地化默认是开启的。如果你在这个特征之前创建了项目,那么请通过阅读本节来为你的应用开启此功能。

基于数据库的本地化是为了向后兼容ABP中已存在的本地化系统而设计的。它实际上取代了所有基于MultiTenantLocalizationSource本地化资源的字典。

MultiTenantLocalizationSource包装了基于资源的DictionaryBasedLocalizationSource。因此,我们一般包装基于XML的本地化资源。它可能不会包装Resource文件资源,因为resource文件是为硬编码设计的,而且静态文件也不适合动态本地化。

因为它是一个包装器,所以如果一个文本没有在数据库中本地化,那么潜在的XML文件就会用作回退资源(我理解为xml文件就是退而求其次的资源,也就是优先级小于数据库资源)。可能看着很复杂,但是对于你的应用实现起来很简单。下面让我们看一下如何开启基于数据库的本地化。

开启数据库本地化(EnableDbLocalization)

首先要开启它:

Configuration.Modules.Zero().LanguageManagement.EnableDbLocalization();

这一步应该在高级别的模块中的PreInitialize方法中完成(对于Web应用,它是web module。导入Abp.Zero.Configuration命名空间查看Zero()扩展方法)。

实际上,该配置使得一切变得富有魔力。但是,我们应该多做一点来使它更合适地工作。

种子数据库语言

因为ABP会从数据库中获得所有的语言列表,因此我们应该将默认的语言插入数据库。如果你正在使用的是EF,那么你可以像这里一样使用种子代码。

移除静态的语言配置

如果你使用了像下面一样的静态语言配置,那么你可以删除它们,因为以后会从数据库中获得它们。

Configuration.Localization.Languages.Add(new LanguageInfo("en", "English", "famfamfam-flag-england", true));

注意已存在的XML本地化资源

不要删除XML本地化资源和资源配置代码。因为如果数据库中没有相应的资源的话,这些文件会用作回退资源,并且所有的本地化键值会从这些资源中获得。

这样,当你需要一个新的本地化文本时,你可以像往常一样将它定义到XML文件中。你至少应该将它定义到默认语言的XML文件中。也只有这样,你才不用将默认的本地化文本的值添加到数据库迁移代码中。

管理语言

可以将接口IApplicationLanguageManager进行注入,然后使用它管理语言。该接口有诸如GetLanguagesAsync ,AddAsync,RemoveAsync,UpdateAsync...的方法,可以用来管理租主和租户的语言。

语言列表逻辑

语言列表为每个租户和租主单独存储和计算,如下:

  • 存在一个为租主定义的语言列表。该列表对所有租户都是默认的。
  • 存在为每个租户独立的语言列表。该列表继承了租主的语言列表,并加入了租户特定的语言。租户可以不删除或更新租主定义(默认)的语言(但是可以重写本地化文本,后面会看到)。

应用语言实体(ApplicationLanguage Entity)

应用语言实体表示了一个租户或租主的语言。

[Serializable]
[Table("AbpLanguages")]
public class ApplicationLanguage : FullAuditedEntity, IMayHaveTenant
{
    //...
}

基本属性有:

  • TenantId(nullable):如果该语言是特定租户的,那么该属性就包含相关的租户Id。如果该语言是租主的,那么就是null。
  • Name:语言的名字。该属性必须是来自这里的列表里的文化代码
  • DisplayName:该语言的展示名称。可以是任意的名字,一般是CultureInfo.DisplayName
  • Icon:该语言的一个任意图标或旗帜。这个可用于在UI上展示该语言的旗帜。

而且,应用语言实体继承了FullAuditedEntity。这意味着,它是一个软删除且自动 审计的实体。
应用语言实体存储在数据库中的AbpLanguages表中。

管理本地化文本

可以通过注入IApplicationLanguageTextManager接口来管理本地化文本。该接口拥有为一个租户或租主获取或设置本地化文本需要的方法。

使文本本地化

当你想要本地化一个文本时,让我们看一下发生了什么:

  • 尝试获取当前文化(使用CurrentThread.CurrentUICulture获得)。
    • 检查给定的文本在数据库中是否以当前的文化当前的租户(使用IAbpSession.TenantId获得)已经定义(或重写)。如果定义了就返回该值。
    • 然后检查给定的文本在数据库中是否以当前的文化为该租主已定义(或重写)。如果定义了就返回该值。
    • 然后检查给定的文本是否以当前的文化在潜在的XML文件中已经定义。若定义则返回该值。
  • 尝试找出该回退文化。它是这样计算的:如果当前文化是“en-GB”,那么回退文化就是“en”。
    • 检查给定的文本在数据库中是否以回退文化当前的租户(使用IAbpSession.TenantId获得)已经定义(或重写)。如果定义了就返回该值。
    • 然后检查给定的文本在数据库中是否以回退文化为该租主已定义(或重写)。如果定义了就返回该值。
    • 然后检查给定的文本是否以回退文化在潜在的XML文件中已经定义。若定义则返回该值。
  • 尝试找出默认的文化
    • 检查给定的文本在数据库中是否以默认的文化当前的租户(使用IAbpSession.TenantId获得)已经定义(或重写)。如果定义了就返回该值。
    • 然后检查给定的文本在数据库中是否以默认的文化为该租主已定义(或重写)。如果定义了就返回该值。
    • 然后检查给定的文本是否以默认的文化在潜在的XML文件中已经定义。若定义则返回该值。
  • 获得相同的文本或者抛出异常
    • 如果给定的文本(或键值)压根没有找到,那么ABP会抛出异常或者返回相同的使用[and]包装的文本(或键值)。(可以在启动时配置,详情查看

因此,获得一个本地化的文本有点复杂。但是它运行起来很快,因为它使用了缓存(cache)。

应用语言文本实体(ApplicationLanguageText Entity)

在数据库中,应用语言文本实体存储了本地化的值。

[Serializable]
[Table("AbpLanguageTexts")]
public class ApplicationLanguageText : AuditedEntity<long>, IMayHaveTenant
{
    //...
}

它的基本的属性是:

  • TenantId(nullable):若该本地化的文本是特定租户的,那么它包含了与之相关的租户的Id。如果这是租主本地化的文本,那么该值为null。
  • LanguageName:语言的名称。该属性必须是来自这里的列表里的文化代码。这个和ApplicationLanguage.Name是匹配的,但是没有强制的外键从而使它独立于语言实体。IApplicationLanguageTextManager会合适地对它处理。
  • Source:本地化资源名称。
  • Key:本地化文本的Key或者名称。
  • Value:本地化的值。

ApplicationLanguageText实体存储在数据库中的“AbpLanguageTexts ”表。

posted @ 2015-12-09 21:29 tkbSimplest 阅读(...) 评论(...) 编辑 收藏