SPA和服务器端渲染

注意

单页应用程序(SPA)编辑器功能需要AEM 6.4 Service Pack 2或更高版本。

对于需要基于SPA框架的客户端渲染(例如,React或Angular)的项目,推荐使用SPA编辑器解决方案。

注意

要使用SPA服务器端渲染功能,需要AEM 6.4.5.0或更高版本,如本文档中所述。

概述

单页应用程序(SPA)可以为用户提供丰富的动态体验,这些体验可以以熟悉的方式做出反应和行为,通常与本机应用程序类似。 这是通过依赖客户端在前面加载内容,然后进行处理用户交互的重 力提升,从而最小化客户端和服务器之间需要的通信量,使应用更加被动而实现的。

但是,这可能会导致较长的初始加载时间,尤其是当SPA较大且内容丰富时。 为了优化加载时间,某些内容可以在服务器端呈现。 使用服务器端渲染(SSR)可以加快页面的初始加载速度,然后将进一步的渲染传递到客户端。

何时使用SSR

并非所有项目都需要SSR。 尽管AEM完全支持SPA的JS SSR,但是,Adobe不建议为每个项目系统地实施它。

在决定实施SSR时,您必须首先估计项目实际上所代表的额外复杂性、工作量和增加成本,包括长期维护。 SSR架构只有在增值明显超过估计成本时才应选择。

SSR通常在以下任一问题出现明确的“是”时提供一些值:

  • SEO: 是否仍需要SSR才能通过带来流量的搜索引擎正确索引您的网站?请记住,主搜索引擎爬取程序现在会评估JS。
  • 页面速度: SSR是否在现实环境中提供了可衡量的速度提升,并为整体用户体验增添了内容?

只有在以下两个问题中至少有一个问题得到明确的“是”回答时,您的项目才Adobe建议实施SSR。 以下各节介绍如何使用Adobe I/O Runtime实现此目的。

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)模式,将单个应用程序的不同版本部署到不同的环境。 有关详细信息,请参阅用于项目Firefly应用程序的CI/CD文档。

除非每个实例类型的运行时实施存在差异,否则不需要每个实例(创作、发布)单独的工作区。

远程内容渲染器配置

AEM必须知道可在何处检索远程渲染的内容。 无论您选择为SSR🔗实施哪种型号,都需要指定如何AEM访问此远程渲染服务。

这是通过​RemoteContentRenderer - Configuration Factory OSGi服务完成的。 在http://<host>:<port>/system/console/configMgr的Web控制台配置控制台中搜索字符串“RemoteContentRenderer”。

以下字段可用于配置:

  • 内容路径模式 — 必要时,用于匹配部分内容的正则表达式
  • 远程端点URL — 负责生成内容的端点的URL
    • 如果不在本地网络中,则使用安全HTTPS协议。
  • 其他请求头 — 要添加到发送到远程端点的请求中的其他头
    • 模式:key=value
  • 请求超时 — 远程主机请求超时(以毫秒为单位)
注意

无论您选择实施AEM驱动的通信流还是Adobe I/O Runtime驱动的流,都必须定义远程内容渲染器配置。

如果您选择使用自定义Node.js服务器,则还必须定义此配置。

注意

此配置利用远程内容渲染器,该渲染器具有其他可用的扩展和自定义选项。

AEM驱动的通信流

使用SSR时,AEM中SPA的组件交互工作流包含一个阶段,应用程序的初始内容由Adobe I/O Runtime生成。

  1. 浏览器从AEM请求SSR内容。
  2. AEM将模型发布到Adobe I/O Runtime。
  3. Adobe I/O Runtime返回生成的内容
  4. AEM会提供Adobe I/O Runtime通过后端页面组件的HTL模板返回的HTML。

服务器端渲染 — cms-drivenaemnode

Adobe I/O Runtime驱动的通信流

AEM驱动通信流部分介绍了在AEM中针对SPA进行服务器端渲染的标准和建议实施,在该渲染中,AEM执行内容的引导和服务。

或者,SSR可以实现,以便Adobe I/O Runtime负责引导,有效地逆转通信流。

这两个模型都有效,且受AEM支持。 但是,在实施特定模式之前,应考虑每个模式的利弊。

引导 优势 缺点
通过AEM AEM管理需要时只需在AEM上维护资源的插入库
可能不熟悉SPA开发人员
通过Adobe I/O Runtime 更熟悉SPA开发人员 AEM开发人员需要通过allowProxy属性
在AEM和Adobe I/O Runtime之间同步资源(如CSS和JavaScript)来提供应用程序所需的Clientlib资源。要启用SPA创作,可能需要Adobe I/O Runtime的代理服务器

SSR的规划

通常,只需要在服务器端呈现应用程序的一部分。 常见的示例是,在页面初始加载时将显示在折页上方的内容需要在服务器端渲染。 这通过将已呈现的内容传送到客户端来节省时间。 当用户与SPA交互时,客户端会呈现其他内容。

在考虑为SPA实施服务器端渲染时,您需要查看应用程序的哪些部分需要SSR。

使用SSR开发SPA

SPA组件可由客户端(在浏览器中)或服务器端呈现。 呈现服务器端时,浏览器属性(如窗口大小和位置)不存在。 因此,SPA组件应当是同构的,不应假设它们将在何处呈现。

要利用SSR,您需要在AEM以及负责服务器端渲染的Adobe I/O Runtime上部署代码。 大多数代码将相同,但特定于服务器的任务将有所不同。

AEM中的SPA的SSR

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。

使用Node.js

Adobe I/O Runtime是在AEM中实施SPA SSR的推荐解决方案。

对于预先创建的AEM实例,还可以使用自定义Node.js实例来实施SSR,其方式与上述方法相同。 尽管Adobe支持此功能,但不建议这样做。

托管Adobe的AEM实例不支持Node.js。

注意

如果SSR必须通过Node.js来实施,则Adobe建议为每个AEM环境(创作、发布、暂存等)使用单独的Node.js实例。

远程内容渲染器

在AEM中将SSR与SPA结合使用所需的远程内容渲染器配置会点按更广义的渲染服务,该服务可进行扩展和自定义以满足您的需求。

RemoteContentRenderingService

RemoteContentRenderingService 是用于检索在远程服务器上呈现的内容的OSGi服务,例如从Adobe I/O。发送到远程服务器的内容基于传递的请求参数。

RemoteContentRenderingService 当需要进行其他内容处理时,可通过依赖关系反转插入自定义Sling模型或servlet中。

RemoteContentRendererRequestHandlerServlet在内部使用此服务。

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 {}

配置默认处理程序的OSGi配置

必须按照远程内容渲染器配置部分中的说明配置默认处理程序。

远程内容渲染器使用情况

要让Servlet获取并返回一些可插入页面的内容,请执行以下操作:

  1. 确保远程服务器可访问。
  2. 将以下代码片段之一添加到AEM组件的HTL模板。
  3. (可选)创建或修改OSGi配置。
  4. 浏览网站的内容

通常,页面组件的HTL模板是此类功能的主收件人。

<sly data-sly-resource="${resource @ resourceType='cq/remote/content/renderer/request/handler'}" />

要求

Servlet利用Sling模型导出程序序列化组件数据。 默认情况下,com.adobe.cq.export.json.ContainerExportercom.adobe.cq.export.json.ComponentExporter都支持作为Sling型号适配器。 如有必要,您可以添加类,请求应修改为使用RemoteContentRendererServlet并实现RemoteContentRendererRequestHandler#getSlingModelAdapterClasses。 附加类必须扩展ComponentExporter

在此页面上