在Magnolia CMS中以编程方式渲染模板区域

Question

我正在使用Magnolia CMS 5.4，我想构建一个模块，该模块将呈现页面的某些内容并通过REST API公开它。该任务很简单，但不确定如何进行和/或从何处开始。

我希望我的模块为给定的引用生成部分模板或模板的区域，假设这是“ header”。我需要呈现标题模板/区域以获取HTML并将其返回作为对另一个系统的响应。

所以问题是：这有可能吗？从哪里开始？

Answer 1

在这里和在Magnolia论坛上提问后确定，我在源代码中找到了答案并找到了解决方法。

渲染首先要基于不同的渲染器，并且可以是JCR，纯文本或Freemarker渲染器。在木兰属植物中，这些已决定并在RenderingEngine和实现中使用：DefaultRenderingEngine。渲染引擎将允许您渲染整个页面节点，这比我要实现的目标更近了一步。因此，让我们看看如何做到这一点：

我将跳过一些步骤，但是我添加了命令并使其在REST上起作用，因此我可以看到将请求发送到端点时发生了什么。该命令扩展了BaseRepositoryCommand以允许访问JCR存储库。

@Inject
public setDefaultRenderingEngine(
    final RendererRegistry rendererRegistry,
    final TemplateDefinitionAssignment templateDefinitionAssignment,
    final RenderableVariationResolver variationResolver,
    final Provider<RenderingContext> renderingContextProvider
) {
    renderingEngine = new DefaultRenderingEngine(rendererRegistry, templateDefinitionAssignment,
            variationResolver, renderingContextProvider);
}

这会创建您的渲染引擎，您可以从此处开始渲染具有少量小陷阱的节点。我曾尝试直接注入渲染引擎，但是由于所有内部部件均为空/无效，因此无法正常工作，因此决定获取所有构造属性并初始化我自己的版本。

下一步是我们要渲染页面节点。首先，渲染引擎基于HttpServletResponse的渲染以及与请求/响应流之间的联系的思想而工作，尽管我们需要将生成的标记放入变量中，所以我添加了新的实现FilteringResponseOutputProvider：

public class AppendableFilteringResponseOutputProvider extends FilteringResponseOutputProvider {

    private final FilteringAppendableWrapper appendable;

    private OutputStream outputStream = new ByteArrayOutputStream();

    public AppendableFilteringResponseOutputProvider(HttpServletResponse aResponse) {
        super(aResponse);

        OutputStreamWriter writer = new OutputStreamWriter(outputStream);
        appendable = Components.newInstance(FilteringAppendableWrapper.class);
        appendable.setWrappedAppendable(writer);
    }

    @Override
    public Appendable getAppendable() throws IOException {
        return appendable;
    }

    @Override
    public OutputStream getOutputStream() throws IOException {
        ((Writer) appendable.getWrappedAppendable()).flush();

        return outputStream;
    }

    @Override
    public void setWriteEnabled(boolean writeEnabled) {
        super.setWriteEnabled(writeEnabled);
        appendable.setWriteEnabled(writeEnabled);
    }
}

因此，该类的想法是公开输出流，并仍然保留FilteringAppendableWrapper，这将使我们可以过滤要编写的内容。通常情况下不需要这样做，您可以坚持将AppendableOnlyOutputProvider与StringBuilder附加使用，并轻松检索整个页面标记。

// here I needed to create a fake HttpServletResponse
OutputProvider outputProvider = new AppendableFilteringResponseOutputProvider(new FakeResponse());

一旦有了输出提供程序，您就需要一个页面节点，并且由于您是伪造的，因此需要将Magnolia全局环境设置为能够检索JCR节点：

// populate repository and root node as those are not set for commands
super.setRepository(RepositoryConstants.WEBSITE);
super.setPath(nodePath); // this can be any existing path like: "/home/page"
Node pageNode = getJCRNode(context);

现在我们有了内容提供者，我们要渲染的下一节点实际上正在运行渲染引擎：

renderingEngine.render(pageNode, outputProvider);
outputProvider.getOutputStream().toString();

就是这样，您应该呈现您的内容，并且可以根据需要使用它。

现在进入我的特例，我只想呈现整个页面的一个区域，在这种情况下，这就是页面的页眉。尽管您需要添加一个覆盖编写过程的渲染侦听器，但这全部由相同的renderingEngine处理。首先将其注入命令：

@Inject
public void setAreaFilteringListener(final AreaFilteringListener aAreaFilteringListener) {
    areaFilteringListener = aAreaFilteringListener;
}

这是发生魔术的地方，AreaFilteringListener将检查您当前是否正在渲染请求的区域，如果执行了此操作，则将启用输出提供程序进行写入，否则将其锁定并跳过所有不相关的区域。您需要像这样将侦听器添加到渲染引擎：

// add the area filtering listener that generates specific area HTML only
LinkedList<AbstractRenderingListener> listeners = new LinkedList<>();
listeners.add(areaFilteringListener);
renderingEngine.setListeners(listeners);

// we need to provide the exact same Response instance that the WebContext is using
// otherwise the voters against the AreaFilteringListener will skip the execution
renderingEngine.initListeners(outputProvider, MgnlContext.getWebContext().getResponse());

[我听到你问：“但是我们在哪里指定要渲染的区域？”，啊哈来了：

// enable the area filtering listener through a global flag
MgnlContext.setAttribute(AreaFilteringListener.MGNL_AREA_PARAMETER, areaName);
MgnlContext.getAggregationState().setMainContentNode(pageNode);

区域过滤监听器正在检查要设置的特定木兰上下文属性：“ mgnlArea”，如果发现它将读取其值并将其用作区域名称，请检查该区域是否存在于节点中，然后启用一次写入我们击中了该地区。也可以通过https://demopublic.magnolia-cms.com/~mgnlArea=footer~.html这样的URL来使用它，这只会为您提供作为HTML页面生成的页脚区域。

这里是完整的解决方案：http://yysource.com/2016/03/programatically-render-template-area-in-magnolia-cms/

Answer 2

只需使用该区域的路径，然后使用该网址发出http请求，例如http://localhost:9080/magnoliaAuthor/travel/main/0.html据我所知，您无需像您一样以编程方式遍历所有内容。Direct component rendering