使用React在AEM中開始使用SPA getting-started-with-spas-in-aem-using-react

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

SPA編寫功能提供全方位的解決方案,可支援AEM中的SPA。 本文介紹React架構上的簡化SPA應用程式,說明其如何組合,讓您快速啟動並執行自己的SPA。

NOTE
本文章內容以React架構為基礎。 有關Angular架構的對應檔案,請參閱AEM中的SPA快速入門 — Angular

簡介 introduction

本文概述簡單的SPA的基本功能,以及您需要瞭解的最少運作資訊。

如需SPA在AEM中運作方式的詳細資訊,請參閱下列檔案:

NOTE
為了能夠在SPA內製作內容,內容必須儲存在AEM中,並由內容模型公開。
若在SPA外部開發的AEM不遵守內容模型合約,將無法編寫。

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

建置 building

實際建立應用程式時,除了使用aem-clientlib-generator自動建立使用者端程式庫之外,還使用Webpack進行翻譯。 因此, build指令將類似於:

"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表示法,並處理內容以包裝/裝飾頁面的每個元素。 在SPA Blueprint檔案中可以找到Page的詳細資訊。

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的構成結果。 此元件可匯出以供稍後在應用程式的標籤中具現化。

使用MapTowithModel函式匯出時,Page元件會以ModelProvider元件包住,此元件可提供存取最新版頁面模型或該頁面模型中精確位置的標準元件。

如需詳細資訊,請參閱SPA藍圖檔案

NOTE
依預設,您會在使用withModel函式時收到元件的整個模型。

在SPA元件之間共用資訊 sharing-information-between-spa-components

單頁應用程式內的元件定期需要共用資訊。 有幾種建議的方法可以達成此目的,依複雜度遞增的順序列示如下。

  • 選項1: ​集中邏輯並廣播至必要的元件,例如,使用React Context。
  • 選項2: ​使用狀態庫(例如Redux)共用元件狀態。
  • 選項3: ​藉由自訂及擴充容器元件來運用物件階層。

後續步驟 next-steps

recommendation-more-help
fbcff2a9-b6fe-4574-b04a-21e75df764ab