nopcommerce的挂件技术之二

上一篇新建了一个插件的demo(http://www.cnblogs.com/SecondSun/p/7422036.html)，里面还有些问题没讲清楚，这篇，我将详细的讲解下。

关于 “ @Html.Widget("home_page_helloworld")”这个问题，这里面的参数需要和plugin中GetWidgetZones返回参数一致，否则无法加载插件。这个“home_page_helloworld”相当于一个ID，区分不同的插件，下面，我们来了解下是如何实现的。

首先@Html.Widget是HtmlHelper方法的扩展，代码如下：

  public static MvcHtmlString Widget(this HtmlHelper helper, string widgetZone, object additionalData = null, string area = null)
        {
            return helper.Action("WidgetsByZone", "Widget", new { widgetZone = widgetZone, additionalData = additionalData, area = area });
            //return helper.Action("WidgetsByZone", "Home", new { widgetZone = widgetZone, additionalData = additionalData, area = area });
        }

可以看到，该方法主要是调用“WidgetController”中的“WidgetsByZone”方法，真正的处理逻辑也是在这里的。具体的实现：

 [ChildActionOnly]
        public ActionResult WidgetsByZone(string widgetZone, object additionalData = null)
        {
            var cacheKey = string.Format(ModelCacheEventConsumer.WIDGET_MODEL_KEY, widgetZone);
            var cacheModel = _cacheManager.Get(cacheKey, () =>
            {
                //model
                var model = new List<RenderWidgetModel>();

                var widgets = _widgetService.LoadActiveWidgetsByWidgetZone(widgetZone);
                foreach (var widget in widgets)
                {
                    var widgetModel = new RenderWidgetModel();

                    string actionName;
                    string controllerName;
                    RouteValueDictionary routeValues;
                    widget.GetDisplayWidgetRoute(widgetZone, out actionName, out controllerName, out routeValues);
                    widgetModel.ActionName = actionName;
                    widgetModel.ControllerName = controllerName;
                    widgetModel.RouteValues = routeValues;

                    model.Add(widgetModel);
                }
                return model;
            });

            //如果没有Model返回为空字符串
            if (!cacheModel.Any())
                return Content("");
            var clonedModel = new List<RenderWidgetModel>();
            foreach (var widgetModel in cacheModel)
            {
                var clonedWidgetModel = new RenderWidgetModel();
                clonedWidgetModel.ActionName = widgetModel.ActionName;
                clonedWidgetModel.ControllerName = widgetModel.ControllerName;
                if (widgetModel.RouteValues != null)
                    clonedWidgetModel.RouteValues = new RouteValueDictionary(widgetModel.RouteValues);

                if (additionalData != null)
                {
                    if (clonedWidgetModel.RouteValues == null)
                        clonedWidgetModel.RouteValues = new RouteValueDictionary();
                    clonedWidgetModel.RouteValues.Add("additionalData", additionalData);
                }

                clonedModel.Add(clonedWidgetModel);
            }

            return PartialView(clonedModel);
        }

首先，根据键值对从缓存中读取数据，如果缓存中没有，则根据名称查找活动的组件LoadActiveWidgetsByWidgetZone(widgetZone)。查找返回实体。最后，我们需要在修改之前克隆缓存的模型（更新的模型不应被缓存），返回克隆的模型。

WidgetsByZone的视图如下所示：

@model List<RenderWidgetModel>
@using NopFramework.Web.Models.Cms;
@foreach (var widget in Model)
{
    @Html.Action(widget.ActionName, widget.ControllerName, widget.RouteValues)
}

遍历Model中的数据，并执行widget中指定Controller中的Action。该例子中的action、controller分别对应PublicInfo和WidgetsHelloWorld即直接加载插件，执行publicInfo方法，这样插件就显示出来了。