SPA和服务器端渲染

单页应用程序(SPA)可以优惠用户丰富的动态体验,它们以熟悉的方式反应和行为,通常就像本机应用程序一样。 这是通过依赖客户端预先加载内容,然后进行处理用户交互的重 力提升,从而最小化客户端和服务器之间需要的通信量,使应用更加被动。

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

何时使用SSR

SSR并非所有项目都必需。 虽然AEM完全支持SPA的联署材料安全法,但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建议每个AEM环境(作者、发布、舞台等)使用一个单独的Adobe I/O Runtime实例。

远程渲染器配置

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驱动的流,都必须定义远程内容呈现器配置。

注意

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

AEM驱动通信流

使用SSR时,AEM的组件交互工作流包括在Adobe I/O Runtime上生成应用程序初始内容的阶段。

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

SSE CMS驱动的AEMAdobe I/O

Adobe I/O Runtime驱动通信流

上一节介绍与AEM中SPA相关的服务器端渲染的标准和建议实施,其中AEM执行内容的引导和服务。

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

两种型号均有效,且受AEM支持。 但是,在实施特定模式之前,应该考虑每个模式的优缺点。

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

SSR的规划

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

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

使用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文档。

远程内容渲染器

需要在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 Model Exporter对组件数据进行序列化。 默认情况下,com.adobe.cq.export.json.ContainerExportercom.adobe.cq.export.json.ComponentExporter都支持作为Sling Model适配器。 如有必要,您可以添加类,请求应调整为使用RemoteContentRendererServlet并实现RemoteContentRendererRequestHandler#getSlingModelAdapterClasses。 其他类必须扩展ComponentExporter

在此页面上