Question

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

我希望我的模块为给定的引用生成部分模板或模板区域，让我们说是＆＃34; header＆＃34;。我需要渲染标题模板/区域获取HTML并将其作为对另一个系统的响应返回。

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

Answer 1

确定在这里询问并且在Magnolia论坛上找不到答案我在源代码中挖掘并找到了一种方法来实现它。

渲染首先根据不同的渲染器工作，可能是JCR，纯文本或Freemarker渲染器。在Magnolia中，这些是在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);
}

这将创建您的渲染引擎，从这里您可以开始渲染具有少量小陷阱的节点。我已经尝试直接注入渲染引擎，但由于所有内部都是空/ null所以没有工作，因此决定获取所有构造属性并初始化我自己的版本。

下一步是我们要渲染页面节点。首先，渲染引擎基于它为HttpServletResponse渲染的想法而工作，并且与请求/响应流的关系非常好，尽管我们需要将生成的标记放在变量中，所以我＆＃39 ; ve添加了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());

我听到你问：＆＃34;但是我们在哪里指定要渲染的区域？＆＃34;，aha来了：

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

区域过滤侦听器正在检查要设置的特定Magnolia上下文属性：＆＃34; mgnlArea＆＃34;如果发现它将读取其值并将其用作区域名称，请检查节点中是否存在该区域，然后在我们到达该区域后启用写入。这也可以通过以下网址使用，例如：https://demopublic.magnolia-cms.com/~mgnlArea=footer~.html，这样您就可以只显示作为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

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

2 个答案: