在 Magnolia CMS 中以编程方式呈现模板区域
Programmatically render template area in Magnolia CMS
我正在使用 Magnolia CMS 5.4,我想构建一个模块来呈现页面的某些内容并通过 REST 公开它 API。任务很简单,但不确定如何处理它 and/or 从哪里开始。
我希望我的模块为给定参考生成部分模板或模板区域,假设是 "header"。我需要渲染 header template/area 得到 HTML 和 return 作为对另一个系统的响应。
所以问题是:这是否可能以及从哪里开始?
好的,在这里和 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);
}
这将创建您的渲染引擎,您可以从这里开始渲染节点,但有一些小问题。我试过直接注入渲染引擎,但是没有用,因为所有的内部都是 empty/null 所以决定获取所有构造属性并初始化我自己的版本。
下一步是我们要呈现页面节点。首先,渲染引擎的工作原理是它为 HttpServletResponse
渲染并且与 request/response 流的关系非常好,尽管我们需要将生成的标记放在一个变量中,所以我添加了一个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);
}
}
所以 class 的想法是公开输出流并仍然保留 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());
我听到你问:"But where do we specify the area to be rendered?",啊哈来了:
// enable the area filtering listener through a global flag
MgnlContext.setAttribute(AreaFilteringListener.MGNL_AREA_PARAMETER, areaName);
MgnlContext.getAggregationState().setMainContentNode(pageNode);
区域过滤侦听器正在检查要设置的特定 Magnolia 上下文 属性:"mgnlArea" 如果找到,它将读取其值并将其用作区域名称,检查该区域是否存在于节点中,然后在我们到达该区域后启用写入。这也可以通过 URL 使用,例如:https://demopublic.magnolia-cms.com/~mgnlArea=footer~.html,这将为您提供作为 HTML 页面生成的页脚区域。
这里是完整的解决方案:http://yysource.com/2016/03/programatically-render-template-area-in-magnolia-cms/
只需使用该区域的路径并使用该路径发出 http 请求 url,例如http://localhost:9080/magnoliaAuthor/travel/main/0.html
据我所知,没有必要像您那样以编程方式完成所有操作。
Direct component rendering
我正在使用 Magnolia CMS 5.4,我想构建一个模块来呈现页面的某些内容并通过 REST 公开它 API。任务很简单,但不确定如何处理它 and/or 从哪里开始。
我希望我的模块为给定参考生成部分模板或模板区域,假设是 "header"。我需要渲染 header template/area 得到 HTML 和 return 作为对另一个系统的响应。
所以问题是:这是否可能以及从哪里开始?
好的,在这里和 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);
}
这将创建您的渲染引擎,您可以从这里开始渲染节点,但有一些小问题。我试过直接注入渲染引擎,但是没有用,因为所有的内部都是 empty/null 所以决定获取所有构造属性并初始化我自己的版本。
下一步是我们要呈现页面节点。首先,渲染引擎的工作原理是它为 HttpServletResponse
渲染并且与 request/response 流的关系非常好,尽管我们需要将生成的标记放在一个变量中,所以我添加了一个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);
}
}
所以 class 的想法是公开输出流并仍然保留 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());
我听到你问:"But where do we specify the area to be rendered?",啊哈来了:
// enable the area filtering listener through a global flag
MgnlContext.setAttribute(AreaFilteringListener.MGNL_AREA_PARAMETER, areaName);
MgnlContext.getAggregationState().setMainContentNode(pageNode);
区域过滤侦听器正在检查要设置的特定 Magnolia 上下文 属性:"mgnlArea" 如果找到,它将读取其值并将其用作区域名称,检查该区域是否存在于节点中,然后在我们到达该区域后启用写入。这也可以通过 URL 使用,例如:https://demopublic.magnolia-cms.com/~mgnlArea=footer~.html,这将为您提供作为 HTML 页面生成的页脚区域。
这里是完整的解决方案:http://yysource.com/2016/03/programatically-render-template-area-in-magnolia-cms/
只需使用该区域的路径并使用该路径发出 http 请求 url,例如http://localhost:9080/magnoliaAuthor/travel/main/0.html 据我所知,没有必要像您那样以编程方式完成所有操作。 Direct component rendering