为 AEM 开发 SPA

上次更新: 2023-12-04

单页应用程序 (SPA) 可以为网站用户提供引人入胜的良好体验。开发人员希望能够使用SPA框架构建站点,而创作者则希望能够在Adobe Experience Manager (AEM)中顺畅地为使用此类框架构建的站点编辑内容。

本文介绍了在让前端开发人员开发SPA for AEM时需要考虑的重要问题,并概述了有关在AEM上部署SPA的AEM的架构。

注意

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

AEM的SPA开发原则

在 AEM 上开发单页应用程序时,假定前端开发人员在创建 SPA 时遵循标准最佳实践。作为前端开发人员,如果您遵循这些一般最佳实践和一些AEM特定原则,您的SPA将能够正常运行, AEM及其内容创作功能.

  • 可移植性 - 与任何组件一样,组件应尽可能构建为便携式。 应使用可移植且可重用的组件构建 SPA。
  • AEM 推动站点结构 – 前端开发人员创建组件并拥有其内部结构,但依赖 AEM 来定义站点的内容结构。
  • 动态呈现 – 所有呈现都应是动态的。
  • 动态路由 - SPA负责路由,AEM侦听路由并根据路由进行提取。 任何路由也应是动态的。

如果您在开发SPA时牢记这些原则,那么在启用所有受支持的AEM创作功能时,它将会尽可能地灵活且面向未来。

如果您不需要支持AEM创作功能,则可能需要考虑其他 SPA设计模型.

可移植性

与开发任何组件时一样,组件的设计应最大限度地提高可移植性。 应避免任何影响组件可移植性或重用的模式,以确保将来的兼容性、灵活性和可维护性。

生成的SPA应使用高度可移植和可重用的组件构建。

AEM驱动器站点结构

前端开发人员必须自视为负责创建用于构建应用程序的SPA组件库。 前端开发人员对组件的内部结构具有完全控制权。 但是,AEM始终拥有该站点的结构。

这意味着前端开发人员可以在组件的入口点之前或之后添加客户内容,并且还可以在组件内进行第三方调用。 例如,前端开发人员无法完全控制组件的嵌套方式。

动态渲染

SPA应仅依赖于内容的动态渲染。 这是AEM获取并呈现内容结构的所有子项的默认预期。

任何指向特定内容的显式渲染都被视为静态渲染,尽管受支持,但与AEM内容创作功能不兼容。 这也不符合 可移植性.

动态路由

与渲染一样,所有路由也应是动态的。 在AEM中, SPA应始终拥有路由 并且AEM会侦听该事件并根据该事件获取内容。

任何静态路由都对 可移植性原则 并由于与AEM的内容创作功能不兼容,而限制了作者。 例如,对于静态路由,如果内容作者想要更改路由或更改页面,则作者必须请求前端开发人员执行此操作。

AEM 项目原型

任何 AEM 项目都应使用 AEM 项目原型,它支持使用 React 或 Angular 的 SPA 项目并利用 SPA SDK。

SPA设计模型

如果 在AEM中开发SPA的原则 之后,您的SPA将可以使用所有受支持的AEM内容创作功能。

但是,在某些情况下,这并非完全必要。 下表概述了各种设计模型及其优点和缺点。

设计模型
优点 缺点
AEM用作Headless CMS,而不使用 SPA编辑器SDK框架。 前端开发人员可以完全控制应用程序。

内容作者无法使用AEM内容创作体验。

如果代码包含静态引用或路由,则该代码不可移植或重用。

不允许使用模板编辑器,因此前端开发人员必须通过JCR维护可编辑的模板。

前端开发人员使用SPA编辑器SDK框架,但只向内容作者打开某些区域。 开发人员通过仅在应用程序的受限区域中启用创作,来保持对应用程序的控制。

内容作者仅限于一组有限的AEM内容创作体验。

如果代码包含静态引用或路由,则代码存在不可移植或不可重用的风险。

不允许使用模板编辑器,因此前端开发人员必须通过JCR维护可编辑的模板。

项目完全使用SPA编辑器SDK,前端组件开发为库,应用程序的内容结构委派给AEM。

该应用程序可重用和移植。

内容作者可以使用AEM内容创作体验编辑应用程序。

SPA与模板编辑器兼容。

开发人员无法控制应用程序的结构和委派给AEM的内容部分。

开发人员仍可以保留应用程序的区域,以便用于不应使用AEM创作的内容。

注意

虽然所有模型在AEM中均受支持,但仅通过实施第三种(因此遵循建议) AEM中的SPA开发原则)内容作者可以在经过自定义后,在AEM中与和编辑SPA的内容。

将现有SPA迁移到AEM

一般情况下,如果您的SPA遵循 AEM的SPA开发原则,则您的SPA将在AEM中运行并可使用AEM SPA编辑器进行编辑。

执行以下步骤,让现有的SPA准备好与AEM配合使用。

  1. 使JS组件模块化。

    使它们能够按任何顺序、位置和大小呈现。

  2. 使用AdobeSDK提供的容器将组件放在屏幕上。

    AEM提供了一个页面和段落系统组件供您使用。

  3. 为每个JS组件创建一个AEM组件。

    AEM组件定义对话框和JSON输出。

面向前端开发人员的说明

让前端开发人员为AEM创建SPA的主要任务是就组件及其JSON模型达成一致。

下面概述了前端开发人员在开发SPA for AEM时需要执行的步骤。

  1. 就组件及其JSON模型达成一致

    前端开发人员和后端AEM开发人员需要就哪些组件是必需组件以及模型达成一致意见,以便从SPA组件到后端组件进行一对一匹配。

    仍需要使用AEM组件来提供编辑对话框和导出组件模型。

  2. 在React组件中,通过以下方式访问模型this.props.cqModel

    一旦同意组件并且JSON模型已准备就绪,前端开发人员即可自由开发SPA,并且只需通过访问JSON模型即可 this.props.cqModel.

  3. 实施组件的 render() 方法

    前端开发人员实施 render() 方法本身认为合适,并且可以使用 cqModel 属性。 这会输出插入到页面中的DOM和HTML片段。 这是在React中构建应用程序的标准方式。

  4. 通过以下方式将组件映射到AEM资源类型MapTo()

    映射存储组件类,并由提供的内部使用 Container 组件,用于根据给定的资源类型检索并动态实例化组件。

    这用作前端和后端之间的“粘合剂”,以便编辑器知道react组件对应于哪些组件。

    PageResponsiveGrid 是扩展基类的良好示例 Container.

  5. 定义组件的 EditConfig 作为参数MapTo()

    只要尚未呈现或没有要呈现的内容,此参数是告诉编辑器应如何命名组件所必需的。

  6. 扩展提供的 Container 页面和容器的类

    页面和段落系统应该扩展此类,以便委派到内部组件的功能可按预期运行。

  7. 实施使用HTML5的路由解决方案 History API。

    ModelRouter 已启用,调用 pushStatereplaceState 函数会触发请求 PageModelManager 以获取模型的缺失片段。

    当前版本的 ModelRouter 仅支持使用指向Sling模型入口点的实际资源路径的URL。 它不支持使用虚URL或别名。

    ModelRouter 可以禁用或配置为忽略正则表达式的列表。

与AEM无关

这些代码块说明了您的React和Angular组件如何不需要任何特定于Adobe或AEM的内容。

  • JavaScript组件中的所有内容均与AEM无关。
  • 但是,特定于AEM的是,必须使用MapTo帮助程序将JS组件映射到AEM组件。

screen_shot_2018-12-11at144019

MapTo 辅助程序是使后端和前端组件匹配在一起的“粘合剂”:

  • 它告知JS容器(或JS段落系统)哪个JS组件负责渲染JSON中存在的每个组件。
  • 它向JS组件呈现的HTML添加一个HTML数据属性,以便SPA编辑器知道在编辑组件时向作者显示哪个对话框。

有关使用的更多信息 MapTo 以及构建SPA for AEM的一般信息,请参阅所选框架的《快速入门指南》 。

AEM架构和SPA

使用AEM时,SPA的常规架构(包括开发、创作和发布环境)不会发生更改。 但是,了解SPA开发如何适应此架构很有帮助。

screen_shot_2018-12-11at145348

  • 构建环境

    这是签出SPA应用程序源和组件源的位置。

    • NPM clientlib生成器从SPA项目创建一个客户端库。
    • 该库由Maven获取,并由Maven Build插件与组件部署到AEM Author。
  • AEM创作

    在AEM创作实例上创建内容,包括创作SPA。

    在创作环境中使用SPA编辑器编辑SPA时:

    1. SPA请求外部HTML。
    2. CSS已加载。
    3. 加载SPA应用程序的JavaScript。
    4. 执行SPA应用程序时,将请求JSON,以允许应用程序构建页面的DOM,包括 cq-data 属性。
    5. cq-data 属性允许编辑器加载其他页面信息,以便它知道哪些编辑配置可用于组件。
  • AEM发布

    这是发布创作的内容和编译的库(包括SPA应用程序工件、clientlibs和组件)以供公众使用的位置。

  • Dispatcher / CDN

    Dispatcher用作网站访客的AEM缓存层。

    • 处理请求的方式与在AEM创作实例中处理请求的方式类似,但不会请求页面信息,因为只有编辑器才需要这样做。
    • JavaScript、CSS、JSON和HTML已缓存,优化页面以实现快速交付。
注意

在AEM内部,无需执行JavaScript构建机制或执行JavaScript本身。 AEM仅承载来自SPA应用程序的编译的对象。

后续步骤

有关AEM中简单SPA的结构及其工作方式的概述,请参阅两者的快速入门指南 Reactangular.

有关创建您自己的SPA的分步指南,请参阅 AEM SPA编辑器快速入门 — WKND事件教程.

有关动态模型到组件映射及其如何在AEM中的SPA中工作的更多详细信息,请参阅文章 SPA的动态模型到组件映射.

如果您希望在AEM中为React或Angular以外的框架实施SPA,或者只是希望深入了解SPA SDK for AEM的工作原理,请参阅 SPA Blueprint 文章。

在此页面上