AEM - React中的SPA快速入门

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

SPA创作功能提供了一个全面的解决方案,可在AEM中支持SPA。 本文介绍了React框架上的一个简化SPA应用程序,并说明了它的组合方式,从而使您能够快速启动并运行自己的SPA。

注意

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

注意

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

简介

本文概述了简单SPA的基本功能以及运行运行所需了解的最低值。

有关SPA在AEM中工作方式的更多详细信息,请参阅以下文档:

注意

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

如果在AEM之外开发的SPA不遵守内容模型合同,则该将不可授权。

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

依赖关系、配置和构建

除了预期的React依赖关系之外,示例SPA还可以利用其他库来更高效地创建SPA。

依赖项

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

  "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-dom

aem-clientlib-generator 可让客户端库的创建在生成过程中自动进行。

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

有关该报表的更多详细信息,请参阅 在GitHub上,单击此处.

注意

的最低版本 aem-clientlib-generator 必需为1.4.1。

aem-clientlib-generatorclientlib.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"
            ]
        }
    }
};

正在生成

实际构建应用程序需要利用 Webpack ,以便除用于自动创建客户端库的aem-clientlib-generator之外进行转换。 因此,build命令将类似于:

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

生成后,可将包上传到AEM实例。

AEM 项目原型

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

应用程序结构

如前所述,包括依赖项和构建应用程序时,您将获得一个可上传到AEM实例的工作SPA包。

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

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

index.js

进入SPA的入口点当然是 index.js 此处显示的文件经过简化,可重点关注重要内容。

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中要插入应用程序的位置。

这是此函数的标准用法,并非此示例应用程序所独有。

静态实例化

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

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

通过渲染页面, 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 如下所示。

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 是一个配置对象,通过为编辑器提供生成占位符所需的元数据来有助于启用组件的创作功能

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

动态传递的属性

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

导出可编辑内容

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

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 ,其类名称和属性可启用创作功能。 此组件可导出到,以供稍后在应用程序的标记中实例化。

使用 MapTowithModel 函数, Page 组件,使用 ModelProvider 组件,可让标准组件访问最新版本的页面模型或页面模型中的精确位置。

有关详细信息,请参阅 SPA Blueprint文档.

注意

默认情况下,使用 withModel 函数。

在SPA组件之间共享信息

单页应用程序中的组件需要定期共享信息。 有几种推荐的方法可以执行此操作,如下所示,它们的复杂性会越来越高。

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

后续步骤

有关创建您自己的SPA的分步指南,请参阅 AEM SPA Editor - WKND事件入门教程.

有关如何组织自己开发SPA for AEM的更多信息,请参阅文章 开发SPA for AEM.

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

如果您希望在AEM中为除React或Angular之外的其他框架实施SPA,或者只想深入了解SPA SDK for AEM的工作方式,请参阅 SPA Blueprint 文章。

在此页面上