对于需要基于SPA框架的客户端渲染(例如,React或Angular)的项目,推荐使用SPA编辑器解决方案。
要使用SPA服务器端渲染功能,需要AEM 6.5.1.0或更高版本,如本文档中所述。
单页应用程序(SPA)可以为用户提供丰富的动态体验,这种体验可以以熟悉的方式反应和行为,通常与本机应用程序类似。 这是通过依靠客户端在前面加载内容,然后进行处理用户交互的重量提升来实现的 从而最大限度地减少客户端与服务器之间需要的通信量,从而使应用程序更加被动。
但是,这可能会导致较长的初始加载时间,尤其是当SPA较大且内容丰富时。 为了优化加载时间,某些内容可以在服务器端呈现。 使用服务器端渲染(SSR)可以加快页面的初始加载速度,然后将进一步的渲染传递到客户端。
并非所有项目都需要SSR。 尽管AEM完全支持SPA的JS SSR,但是,Adobe不建议为每个项目系统地实施它。
在决定实施SSR时,您必须首先估计项目实际上所代表的额外复杂性、工作量和增加成本,包括长期维护。 SSR架构只有在增值明显超过估计成本时才应选择。
SSR通常在以下任一问题出现明确的“是”时提供一些值:
只有在对您的项目至少回答了这两个问题中的一个并明确给出“是”时,Adobe才建议实施SSR。 以下各节介绍如何使用Adobe I/O Runtime实现此目的。
如果您 确信您的项目需要实施SSR,Adobe的推荐解决方案是使用Adobe I/O Runtime。
有关Adobe I/O Runtime的更多信息,请参阅
以下各节详细介绍了如何在两种不同的模型中使用Adobe I/O Runtime来为SPA实施SSR:
Adobe建议每个环境(暂存、生产、测试等)单独使用Adobe I/O Runtime工作区。 这允许使用典型的系统开发生命周期(SDLC)模式,将单个应用程序的不同版本部署到不同的环境。 查看文档 适用于项目应用程序生成器应用程序的CI/CD 以了解更多信息。
除非每个实例类型的运行时实施存在差异,否则不需要每个实例(创作、发布)单独的工作区。
AEM必须知道可在何处检索远程渲染的内容。 无论 选择为SSR实施的模型, 您需要指定以AEM如何访问此远程渲染服务。
这是通过 RemoteContentRenderer - Configuration Factory OSGi服务. 在Web控制台配置控制台中搜索字符串“RemoteContentRenderer”(位于 http://<host>:<port>/system/console/configMgr
.
以下字段可用于配置:
key=value
无论您是否选择实施 AEM驱动的通信流 或 Adobe I/O Runtime驱动的流, 您必须定义远程内容渲染器配置。
如果您选择 使用自定义Node.js服务器。
此配置利用 远程内容渲染器、 具有其他可用的扩展和自定义选项。
使用SSR时, 组件交互工作流 AEM中的SPA包含在Adobe I/O Runtime上生成应用程序初始内容的阶段。
浏览器从AEM请求SSR内容。
AEM将模型发布到Adobe I/O Runtime。
Adobe I/O Runtime会返回生成的内容。
AEM会提供Adobe I/O Runtime通过后端页面组件的HTL模板返回的HTML。
上一节介绍了与AEM中的SPA有关的服务器端渲染的标准实施和建议实施,AEM在其中执行内容的引导和服务。
或者,SSR可以实现,以便Adobe I/O Runtime负责引导,有效地逆转通信流。
这两个模型都有效,且受AEM支持。 但是,在实施特定模式之前,应考虑每个模式的利弊。
引导 | 优点 | 缺点 |
---|---|---|
通过AEM |
|
|
通过Adobe I/O Runtime |
|
|
通常,只需要在服务器端呈现应用程序的一部分。 常见的示例是,在页面的初始加载时,将在折页上方显示的内容会在服务器端呈现。 这通过将已呈现的内容传送到客户端来节省时间。 当用户与SPA交互时,客户端会呈现其他内容。
在考虑为SPA实施服务器端渲染时,您需要查看应用程序的哪些部分是必需的。
SPA组件可由客户端(在浏览器中)或服务器端呈现。 呈现服务器端时,浏览器属性(如窗口大小和位置)不存在。 因此,SPA组件应当是同构的,不应假设它们将在何处呈现。
要利用SSR,您需要在AEM以及负责服务器端渲染的Adobe I/O Runtime上部署代码。 大多数代码将相同,但特定于服务器的任务将有所不同。
AEM中的SPA的SSR需要Adobe I/O Runtime,这用于渲染应用程序内容服务器端。 在应用程序的HTL中,调用Adobe I/O Runtime上的资源来渲染内容。
正如AEM支持Angular和React SPA框架即装即用一样,Angular和React应用程序也支持服务器端渲染。 有关更多详细信息,请参阅这两个框架的NPM文档。
有关简单化的示例,请参阅 We.Retail Journal应用程序. 它呈现整个应用程序服务器端。 尽管这不是一个真实的例子,但它确实说明了实施SSR所需要的内容。
的 We.Retail Journal应用程序 仅用于演示目的,因此使用Node.js作为简单示例,而不是推荐的Adobe I/O Runtime。 不应将此示例用于任何项目工作。
任何 AEM 项目都应使用 AEM 项目原型,它支持使用 React 或 Angular 的 SPA 项目并利用 SPA SDK。
Adobe I/O Runtime是在AEM中实施SPA SSR的推荐解决方案。
对于预先创建的AEM实例,还可以使用自定义Node.js实例来实施SSR,其方式与上述方法相同。 尽管Adobe支持此功能,但不建议这样做。
托管Adobe的AEM实例不支持Node.js。
如果SSR必须通过Node.js来实施,则Adobe建议为每个AEM环境(创作、发布、暂存等)使用单独的Node.js实例。
的 远程内容渲染器配置 AEM中的SPA与SSR结合使用时,需要点按到更广义的渲染服务,该服务可根据您的需求进行扩展和自定义。
RemoteContentRenderingService
是用于检索在远程服务器上呈现的内容的OSGi服务,例如从Adobe I/O。发送到远程服务器的内容基于传递的请求参数。
RemoteContentRenderingService
当需要进行其他内容处理时,可通过依赖关系反转插入自定义Sling模型或servlet中。
此服务由 RemoteContentRendererRequestHandlerServlet.
的 RemoteContentRendererRequestHandlerServlet
可用于以编程方式设置请求配置。 DefaultRemoteContentRendererRequestHandlerImpl
,提供的默认请求处理程序实施,允许您创建多个OSGi配置,以将内容结构中的位置映射到远程端点。
要添加自定义请求处理程序,请实施 RemoteContentRendererRequestHandler
界面。 请务必设置 Constants.SERVICE_RANKING
组件属性更改为大于100的整数,这是 DefaultRemoteContentRendererRequestHandlerImpl
.
@Component(immediate = true,
service = RemoteContentRendererRequestHandler.class,
property={
Constants.SERVICE_RANKING +":Integer=1000"
})
public class CustomRemoteContentRendererRequestHandlerImpl implements RemoteContentRendererRequestHandler {}
必须按照部分中的所述配置默认处理程序 远程内容渲染器配置.
要让Servlet获取并返回一些可插入页面的内容,请执行以下操作:
通常,页面组件的HTL模板是此类功能的主收件人。
<sly data-sly-resource="${resource @ resourceType='cq/remote/content/renderer/request/handler'}" />
Servlet利用Sling模型导出程序序列化组件数据。 默认情况下, com.adobe.cq.export.json.ContainerExporter
和 com.adobe.cq.export.json.ComponentExporter
支持作为Sling模型适配器。 如有必要,您可以添加类,请求应修改为使用 RemoteContentRendererServlet
和实施 RemoteContentRendererRequestHandler#getSlingModelAdapterClasses
. 其他类必须扩展 ComponentExporter
.