在AEM中使用React快速入门SPA getting-started-with-spas-in-aem-using-react

Last update: Thu Aug 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主题：
开发中

创建对象：

管理员
开发人员

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

SPA创作功能提供了一个全面的解决方案，用于在AEM中支持SPA。本文在React框架上提供了一个简化的SPA应用程序，说明了其组合方式，允许您快速启动并运行自己的SPA。

NOTE

本文基于React框架。有关Angular框架的相应文档，请参阅AEM中的SPA快速入门 — Angular。

简介 introduction

本文总结了简单的SPA的基本功能以及运行它所需了解的最少信息。

有关SPA如何在AEM中工作的更多详细信息，请参阅以下文档：

NOTE

为了能够在SPA中创作内容，内容必须存储在AEM中并由内容模型公开。

如果不遵守内容模型合同，则在AEM之外开发的SPA将无法创作。

本文档将介绍使用React框架创建的简化SPA的结构，并说明其工作方式，以使您可将此理解应用于您自己的SPA。

依赖项、配置和构建 dependencies-configuration-and-building

除了预期的React依赖项之外，示例SPA还可以使用其他库来更有效地创建SPA。

依赖项 dependencies

package.json文件定义了整个SPA包的要求。此处列出了正在工作的AEM的最小SPA依赖项。

  "dependencies": {
    "@adobe/aem-react-editable-components": "~1.0.4",
    "@adobe/aem-spa-component-mapping": "~1.0.5",
    "@adobe/aem-spa-page-model-manager": "~1.0.3"
  }

由于此示例基于React框架，因此package.json文件中具有两个React特定的依赖项：

 react
 react-dom

aem-clientlib-generator用于在生成过程中自动创建客户端库。

"aem-clientlib-generator": "^1.4.1",

有关详细信息，请参阅GitHub🔗上的aem-clientlib-generator。

aem-clientlib-generator在clientlib.config.js文件中配置如下。

module.exports = {
    // default working directory (can be changed per 'cwd' in every asset option)
    context: __dirname,

    // path to the clientlib root folder (output)
    clientLibRoot: "./../content/jcr_root/apps/my-react-app/clientlibs",

    libs: {
        name: "my-react-app",
        allowProxy: true,
        categories: ["my-react-app"],
        embed: ["my-react-app.responsivegrid"],
        jsProcessor: ["min:gcc"],
        serializationFormat: "xml",
        assets: {
            js: [
                "dist/**/*.js"
            ],
            css: [
                "dist/**/*.css"
            ]
        }
    }
};

正在生成 building

实际构建应用程序时，除了使用aem-clientlib-generator自动创建客户端库之外，还使用Webpack进行转换。因此，构建命令将类似于：

"build": "webpack && clientlib --verbose"

构建后，可以将包上传到AEM实例。

AEM 项目原型 aem-project-archetype

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

应用程序结构 application-structure

如前所述，包括依赖项和构建应用程序将为您提供一个有效的SPA包，您可以将该包上传到您的AEM实例。

本文档的下一部分将介绍AEM中SPA的结构方式、驱动应用程序的重要文件以及它们如何协同工作。

以简化的图像组件为例，但应用程序的所有组件都基于相同的概念。

index.js index-js

此处显示的index.js文件是SPA的入口点，该文件经过简化，以重点关注重要内容。

import ReactDOM from 'react-dom';
import App from './App';
import { ModelManager, Constants } from "@adobe/aem-spa-page-model-manager";

...

ModelManager.initialize().then((pageModel) => {
ReactDOM.render(
    <App cqChildren={pageModel[Constants.CHILDREN_PROP]} cqItems={pageModel[Constants.ITEMS_PROP]} cqItemsOrder={pageModel[Constants.ITEMS_ORDER_PROP]} cqPath={ModelManager.rootPath} locationPathname={ window.location.pathname }/>
, document.getElementById('page'));

});

index.js的主要函数是使用ReactDOM.render函数确定DOM中要插入应用程序的位置。

这是此函数的标准用法，并非特定于此示例应用程序。

静态实例化 static-instantiation

使用组件模板（例如，JSX）静态实例化组件时，必须将值从模型传递到组件的属性。

App.js app-js

通过渲染应用程序，index.js调用App.js，此处以简化版本显示，以重点关注重要内容。

import {Page, withModel } from '@adobe/aem-react-editable-components';

...

class App extends Page {
...
}

export default withModel(App);

App.js主要用于封装构成应用程序的根组件。任何应用程序的入口点是页面。

Page.js page-js

通过呈现页面，App.js调用此处以简化版本列出的Page.js。

import {Page, MapTo, withComponentMappingContext } from "@adobe/aem-react-editable-components";

...

class AppPage extends Page {
...
}

MapTo('my-react-app/components/structure/page')(withComponentMappingContext(AppPage));

在此示例中，AppPage类扩展Page，其中包含随后可以使用的内部内容方法。

Page摄取页面模型的JSON表示形式，并处理内容以包装/装饰页面的每个元素。有关Page的更多详细信息可在文档SPA Blueprint.中找到。

Image.js image-js

在渲染页面后，可以渲染此处所示的组件，例如Image.js。

import React, {Component} from 'react';
import {MapTo} from '@adobe/aem-react-editable-components';

require('./Image.css');

const ImageEditConfig = {

    emptyLabel: 'Image',

    isEmpty: function() {
        return !this.props || !this.props.src || this.props.src.trim().length < 1;
    }
};

class Image extends Component {

    render() {
        return (<img src={this.props.src}>);
    }
}

MapTo('my-react-app/components/content/image')(Image, ImageEditConfig);

AEM中SPA的核心思想是：将SPA组件映射到AEM组件，并在内容被修改时更新组件（反之亦然）。有关此通信模型的摘要，请参阅文档SPA编辑器概述。

MapTo('my-react-app/components/content/image')(Image, ImageEditConfig);

MapTo方法将该SPA组件映射到AEM组件。它支持使用单个字符串或字符串数组。

ImageEditConfig是一个配置对象，它通过为编辑器提供生成占位符所需的元数据来帮助启用组件的创作功能

如果没有内容，则会提供标签作为占位符来表示空内容。

动态传递的属性 dynamically-passed-properties

来自模型的数据将作为组件的属性动态传递。

导出可编辑内容 exporting-editable-content

您可以导出组件并使其保持可编辑状态。

import React, { Component } from 'react';
import { MapTo } from '@adobe/aem-react-editable-components';

...

const EditConfig = {...}

class PageClass extends Component {...};

...

export default MapTo('my-react-app/react/components/structure/page')(PageClass, EditConfig);

MapTo函数返回一个Component，该函数是组合的结果，该组合使用启用创作的类名称和属性来扩展提供的PageClass。此组件可导出以供稍后在应用程序的标记中实例化。

使用MapTo或withModel函数导出时，Page组件将使用ModelProvider组件封装，该组件提供对最新版本页面模型或该页面模型中的精确位置的标准组件访问。

有关详细信息，请参阅SPA Blueprint文档。

NOTE

默认情况下，您在使用withModel函数时会收到该组件的整个模型。

在SPA组件之间共享信息 sharing-information-between-spa-components

单页应用程序中的组件经常需要共享信息。有几种推荐的方法可以做到这一点，按复杂性递增的顺序如下所示。

选项1： 将逻辑集中并广播到必要的组件，例如，通过使用React Context。
选项2： 使用状态库（如Redux）共享组件状态。
选项3： 通过自定义和扩展容器组件来利用对象层次结构。

后续步骤 next-steps

SPA 在AEM中使用Angular快速入门显示了如何通过Angular构建基本SPA以在AEM中使用SPA编辑器。
SPA 编辑器概述更深入地介绍了 AEM 和 SPA 之间的通信模型。
WKND SPA项目是在AEM中实施简单SPA项目的分步教程。
SPA的动态模型到组件映射说明了动态模型到组件映射以及它在AEM中的SPA中的工作方式。
SPA Blueprint让您深入了解SPA SDK for AEM的工作原理，以防您想在AEM中为React或Angular以外的框架实施SPA，或者只是想更深入地了解。

recommendation-more-help

fbcff2a9-b6fe-4574-b04a-21e75df764ab