NopCommerce架构分析之(八)多语言支持

系统支持的语言是有类：Language表示；

多语言资源对应的类为：LocalizedProperty；

当先选择某种语言存储在类中：GenericAttribute；

多语言可以导出为XML文件，当然也支持导出。

IWorkContext及其实体类WebWorkContext为当前运行上下文；用户的登录信息以及一些上下文环境设置都保存在此类中。

具体包括：当前用户信息：CurrentCustomer；当前用户Cookie；货币；语言；税的类型；供应商等；

展现多语言资源的方式有几种：

一、在自定义类WebViewPage<TModel>中放置了方法：T()，通过此方法，网页在展现时获取对应语言的文字。

其实T只是一个代理，代理的定义为：

namespace Nop.Web.Framework.Localization
{
  public delegate LocalizedString Localizer(string text, params object[] args);
}

此代理返回值类型为LocalizedString，此类继承接口IHtmlString，以保证能正确显示本地化的文字资源。

IHtmlString的定义为：

// 摘要:
//   表示不应再次进行编码的 HTML 编码的字符串。
public interface IHtmlString
{
  // 摘要:
  //   返回 HTML 编码的字符串。
  //
  // 返回结果:
  //   HTML 编码的字符串。
  string ToHtmlString();
} 

二、通过扩展HtmlHelper

类HtmlExtensions扩展了HtmlHelper类，

主要是对一些控件的封装，并支持多语言。

方法 LocalizedEditor<T, TLocalizedModelLocal>是对Telerik的TabStrip控件的封装（也就是多页签控件---Tab控件），的。系统同时支持有多种语言时，多为每种语言显示一个页签，当然仅当需要时才这么做。这里面用到了接口ILocalizedModel和接口ILocalizedModelLocal。接口ILocalizedModel用来标示某Model类支持这种多语言显示，其中里面包括多种语言数据列表Locales，实现接口ILocalizedModelLocal的类就是特定一种语言的数据。LocalizedEditor方法就是根据这些接口的配合实现了支持多种语言页签了。Admin项目使用此方法，Web项目没有使用。

public static HelperResult LocalizedEditor<T, TLocalizedModelLocal>(this HtmlHelper<T> helper, string name,
  Func<int, HelperResult> localizedTemplate,
  Func<T, HelperResult> standardTemplate)
  where T : ILocalizedModel<TLocalizedModelLocal>
  where TLocalizedModelLocal : ILocalizedModelLocal
{
  return new HelperResult(writer =>
  {
    if (helper.ViewData.Model.Locales.Count > 1)
    {
      var tabStrip = helper.Telerik().TabStrip().Name(name).Items(x =>
      {
        x.Add().Text("Standard").Content(standardTemplate(helper.ViewData.Model).ToHtmlString()).Selected(true);
        for (int i = 0; i < helper.ViewData.Model.Locales.Count; i++)
        {
          var locale = helper.ViewData.Model.Locales[i];
          var language = EngineContext.Current.Resolve<ILanguageService>().GetLanguageById(locale.LanguageId);
          x.Add().Text(language.Name)
            .Content(localizedTemplate
              (i).
              ToHtmlString
              ())
            .ImageUrl("~/Content/images/flags/" + language.FlagImageFileName);
        }
      }).ToHtmlString();
      writer.Write(tabStrip);
    }
    else
    {
      standardTemplate(helper.ViewData.Model).WriteTo(writer);
    }
  });
}

扩展方法NopLabelFor<TModel, TValue>是另外一种多语言实现方式。

此方法主要是根据特性DisplayNameAttribute的子类NopResourceDisplayName实现对属性名称的描述。此特性是对Model属性的修饰，以指定属性的名称。

例如类AddNewsCommentModel的属性用NopResourceDisplayName特性指定：

namespace Nop.Web.Models.News
{
  public partial class AddNewsCommentModel : BaseNopModel
  {
    [NopResourceDisplayName("News.Comments.CommentTitle")]
    [AllowHtml]
    public string CommentTitle { get; set; } 

    [NopResourceDisplayName("News.Comments.CommentText")]
    [AllowHtml]
    public string CommentText { get; set; } 

    public bool DisplayCaptcha { get; set; }
  }
}

HtmlHelper的扩展方法NopLabelFor的实现如下：

public static MvcHtmlString NopLabelFor<TModel, TValue>(this HtmlHelper<TModel> helper, Expression<Func<TModel, TValue>> expression, bool displayHint = true)
{
  var result = new StringBuilder();
  var metadata = ModelMetadata.FromLambdaExpression(expression, helper.ViewData);
  var hintResource = string.Empty;
  object value = null;
  if (metadata.AdditionalValues.TryGetValue("NopResourceDisplayName", out value))
  {
    var resourceDisplayName = value as NopResourceDisplayName;
    if (resourceDisplayName != null && displayHint)
    {
      var langId = EngineContext.Current.Resolve<IWorkContext>().WorkingLanguage.Id;
      hintResource =
        EngineContext.Current.Resolve<ILocalizationService>()
        .GetResource(resourceDisplayName.ResourceKey + ".Hint", langId); 

      result.Append(helper.Hint(hintResource).ToHtmlString());
    }
  }
  result.Append(helper.LabelFor(expression, new { title = hintResource }));
  return MvcHtmlString.Create(result.ToString());
}