SPA和服务器端渲染 spa-and-server-side-rendering

概述 overview

单页应用程序(SPA)可以为用户提供丰富的动态体验，该体验会以熟悉的方式反应和行为，通常就像本机应用程序一样。 这是依靠客户端预先加载内容，然后执行处理用户交互的繁重任务来实现的，从而最大限度地减少客户端和服务器之间所需的通信量，使应用程序更具反应性。

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

何时使用SSR when-to-use-ssr

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

在决定实施SSR时，您必须首先估计增加SSR对于项目（包括长期维护）实际上意味着什么额外的复杂性、工作量和成本。 只有在增加值明显超过估计成本时，才应选择SSR架构。

SSR通常在以下任一问题明确为“是”时提供一些值：

只有在以下两个问题中至少有一个问题得到明确的“是”回答时，Adobe才会建议实施SSR。 以下部分介绍了如何使用Adobe I/O Runtime执行此操作。

Adobe I/O Runtime adobe-i-o-runtime

如果您确信您的项目需要实施SSR，则Adobe推荐的解决方案是使用Adobe I/O Runtime。

有关Adobe I/O Runtime的更多信息，请参阅以下内容：

以下部分详细介绍如何使用Adobe I/O Runtime在两种不同的模型中为SPA实施SSR：

远程渲染器配置 remote-renderer-configuration

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

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

以下字段可用于配置：

AEM驱动的通信流 aem-driven-communication-flow

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

Adobe I/O Runtime驱动的通信流 adobe-i-o-runtime-driven-communication-flow

上一部分介绍了有关AEM中的SPA的服务器端渲染的标准实施和推荐实施，AEM在该环境中执行内容引导和提供。

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

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

规划SSR planning-for-ssr

只有应用程序的一部分必须在服务器端渲染。 常见的示例是在页面初始加载时显示在折叠上方的内容在服务器端呈现。 这通过向客户端交付已渲染的内容来节省时间。 当用户与SPA交互时，其他内容由客户端渲染。

在考虑为SPA实施服务器端渲染时，请查看应用程序的哪些部分有必要。

使用SSR开发SPA developing-an-spa-using-ssr

SPA组件可由客户端（在浏览器中）或服务器端渲染。 在渲染服务器端时，不存在浏览器属性，例如窗口大小和位置。 因此，SPA组件应该是同构的，无需假定它们将在何处呈现。

要使用SSR，请在AEM和Adobe I/O Runtime上部署您的代码，后者负责服务器端渲染。 大多数代码将相同，但是，特定于服务器的任务将有所不同。

AEM中适用于SPA的SSR ssr-for-spas-in-aem

AEM中适用于SPA的SSR需要Adobe I/O Runtime，应用程序内容服务器端渲染会调用此函数。 在应用程序的HTL中，调用Adobe I/O Runtime上的资源来渲染内容。

正如AEM支持开箱即用的Angular和React SPA框架一样，Angular和React应用程序也支持服务器端渲染。 有关更多详细信息，请参阅两个框架的NPM文档。

有关简单示例，请参阅We.Retail日志应用。 它呈现整个应用程序服务器端。 尽管这不是一个实际示例，但它的确说明了实施SSR所需的条件。

使用节点.js using-node-js

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

对于预留AEM实例，还可以按照上述相同方式使用自定义Node.js实例实施SSR。 虽然Adobe支持此功能，但不建议这样做。

远程内容渲染器 remote-content-renderer

在AEM中将SSR与SPA一起使用所需的远程内容渲染器配置将引入更为通用的渲染服务，可以根据您的需求对其进行扩展和自定义。

RemoteContentRenderingService remotecontentrenderingservice

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

当需要额外的内容操作时，RemoteContentRenderingService可以通过依赖关系反转注入到自定义Sling模型或servlet中。

此服务由RemoteContentRendererRequestHandlerServlet在内部使用。

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配置 configure-default-handler

默认处理程序的配置必须按照远程内容渲染器配置一节中的说明进行配置。

远程内容渲染器使用情况 usage

要进行servlet获取并返回一些可插入到页面中的内容，请执行以下操作：

通常，页面组件的HTL模板是此类功能的主要接收者。

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

要求 requirements

servlet使用Sling模型导出器序列化组件数据。 默认情况下，com.adobe.cq.export.json.ContainerExporter和com.adobe.cq.export.json.ComponentExporter都支持作为Sling模型适配器。 如有必要，您可以添加请求应调整为使用RemoteContentRendererServlet并实现RemoteContentRendererRequestHandler#getSlingModelAdapterClasses的类。 附加类必须扩展ComponentExporter。