CMS组件渲染器和控制器之间的区别

时间:2019-05-24 12:34:38

标签: hybris

我们正在使用Hybris v5.7,并且我已将addOn添加到项目中。我想渲染一些CMS组件,并且发现有两种方法可以填充用于渲染组件的模型对象:创建DefaultAddOnCMSComponentRenderer或AbstractCMSAddOnComponentController的子类并将其注册为bean。哪种方法更好?也许其中一种方法已经过时了?

<Notes/>

@Controller
@RequestMapping("/view/MarketingNotificationFormComponentController")
public class MarketingNotificationFormComponentController extends AbstractCMSAddOnComponentController<MarketingNotificationFormComponentModel> {
    @Override
    protected void fillModel(HttpServletRequest request, Model model, MarketingNotificationFormComponentModel component) {
        //populate model here
    }
}

1 个答案:

答案 0 :(得分:2)

  

哪种方法更好?也许其中一种方法已经过时了?

实际上,ComponentController和ComponentRenderer都有不同的用途。

ComponentController 是您可以处理传入请求,处理数据或某些业务逻辑,然后再将其馈送以查看最终输出的地方。在这里,您需要在JSP文件中编写视图。请参阅CMSPageUrlResolvingControllerSimpleResponsiveBannerComponentControllerDynamicBannerComponentController等。

ComponentRenderer 用于View。这意味着您将直接在渲染器内部的页面上下文上编写视图内容。在这里,您不需要JSP来呈现视图。请参阅CMSParagraphComponentRendererCMSLinkComponentRendererImageMapComponentRenderer

如果只想将组件属性填充到模型中,则不需要定义自定义控制器或渲染器,OOTB GenericCMSAddOnComponentController会处理它。

请注意,如果已经定义了相应的自定义componentRenderer,则不会调用componentContoller,前提是自定义componentRenderer和自定义componentContoller不能一起工作。


如何在内部调用自定义组件控制器或渲染器?

DefaultCMSComponentRendererRegistry.java

@Override
public void renderComponent(final PageContext pageContext, final C component)
{
    final String typeCode = getTypeService().getComposedTypeForClass(component.getClass()).getCode();
    final Map<String, CMSComponentRenderer> renderersMap = getRenderers();
    try
    {
        // To check for any custom renderer present
        if (renderersMap != null && renderersMap.containsKey(typeCode))
        {
            renderersMap.get(typeCode).renderComponent(pageContext, component);
        }
        else
        {
            // If no custom renderer, call GenericViewCMSComponentRenderer
            getDefaultCmsComponentRenderer().renderComponent(pageContext, component);
        }
    }
    catch (final Exception e)
    {
        handleException(e, component);
    }
}

GenericViewCMSComponentRenderer.java
调用自定义组件控制器或默认控制器

    @Override
    public void renderComponent(final PageContext pageContext, final AbstractCMSComponentModel component)
            throws ServletException, IOException
    {

     // ...
     // ...

            final String typeCode = component.getTypeCode();
            String controllerName = typeCode + "Controller";
            if (!getBeanFactory().containsBean(controllerName))
            {
                if (LOG.isDebugEnabled())
                {
                    LOG.debug("No controller defined for ContentElement [" + typeCode + "]. Using default Controller");
                }
                controllerName = DEFAULT_CONTROLLER;
            }

            final String includePath = "/view/" + controllerName;

            if (LOG.isDebugEnabled())
            {
                LOG.debug("Rendering CMS Component type [" + typeCode + "] uid [" + component.getUid() + "], include path ["
                        + includePath + "]");
            }
            renderView(pageContext, component, includePath);

     // ...
     // ...

}