AEM中使用React的SPA快速入門

單頁應用程式 (SPA) 可為網站使用者提供引人入勝的體驗。開發人員希望能使用SPA架構建立網站，而作者則想在AEM中為使用SPA架構建立的網站順暢地編輯內容。

SPA製作功能提供全方位的解決方案，可支援AEM中的SPA。 本文介紹React架構上的簡化SPA應用程式，說明其組合方式，讓您能夠快速上手並執行自己的SPA。

注意

本文以React架構為基礎。 有關Angular框架的相應文檔，請參見 AEM中SPA快速入門 — Angular.

簡介

本文概述簡單SPA的基本功能，以及您執行作業所需了解的最低限度。

如需SPA在AEM中如何運作的詳細資訊，請參閱下列檔案：

注意

為了能在SPA內製作內容，內容必須儲存在AEM中，並由內容模型公開。

若SPA不遵守內容模型合約，則在AEM外部開發的Analytics將無法授權。

本檔案將逐步說明使用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 在 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"
            ]
        }
    }
};

正在建置

實際建置應用程式可運用 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 使用類名和屬性啟用創作。 此元件可匯出至，稍後在應用程式的標籤中實例化。

使用 MapTo 或 withModel 函式， Page 元件 ModelProvider 元件，讓標準元件可存取最新版頁面模型或該頁面模型中的精確位置。

如需詳細資訊，請參閱 SPA Blueprint檔案.

注意

預設情況下，使用 withModel 函式。

在SPA元件之間共用資訊

單頁應用程式中的元件必須經常共用資訊。 執行此作業有數種建議方法，如下所列，其複雜度會隨之增加。

  • 選項1: 例如，透過使用React Context將邏輯和廣播集中至必要元件。
  • 選項2: 使用狀態庫（如Redux）共用元件狀態。
  • 選項3: 透過自訂和擴充容器元件，善用物件階層。

後續步驟

本頁內容