NopCommerce架構分析之八------多語言

系統支持的語言是有類：Language表示；

多語言資源對應的類爲：LocalizedProperty；

當先選擇某種語言存儲在類中：GenericAttribute；

多語言能夠導出爲XML文件，固然也支持導出。

IWorkContext及其實體類WebWorkContext爲當前運行上下文；用戶的登陸信息以及一些上下文環境設置都保存在此類中。

具體包括：當前用戶信息：CurrentCustomer；當前用戶Cookie；貨幣；語言；稅的類型；供應商等；

展示多語言資源的方式有幾種：

1、在自定義類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();
    }

2、經過擴展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());
        }