SPA AEM快速入门——反应

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

SPA创作功能优惠了在AEM内支持SPA的一个全面的解决方案。 本文介绍React框架上简化的SPA应用程序,说明它是如何组合在一起的,使您能快速与自己的SPA联动手。

注意

本文基于React框架。 有关角度框架的相应文档,请参见SPA入门——角度

注意

单页应用程序(SPA)编辑器功能需要AEM 6.4 service pack 2或更高版本。

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

简介

本文概括了简单的SPA的基本功能以及运行所需的最低要求。

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

注意

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

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

本文档将介绍使用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
 react-dom

利用aem-clientlib-generator,在构建过程中自动创建客户端库。

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

有关此功能的更多详细信息,请在GitHub上找到。

注意

要求的aem-clientlib-generator的最低版本为1.4.1。

clientlib.config.js文件中配置aem-clientlib-generator,如下所示。

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"
            ]
        }
    }
};

正在生成

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

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

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

AEM 项目原型

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

应用程序结构

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

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

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

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);

SPA AEM的核心思想是将SPA组件映射到AEM组件,并在内容被修改时更新组件(反之亦然)。 有关此通信模型的摘要,请参见文档SPA Editor概述

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编辑器入门- WKND事件教程

有关如何组织您自己开发SPA for AEM的详细信息,请参阅文章为AEM开发SPA

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

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

在此页面上