Show Menu
THEMEN×

Getting Started with SPAs in AEM - React

Single Page Applications (SPAs) können ansprechende Erlebnisse für Website-Benutzer bieten. Entwickler möchten in der Lage sein, Websites mithilfe von SPA-Frameworks zu erstellen, und Autoren möchten Inhalte innerhalb von AEM für eine Website, die mit SPA-Frameworks erstellt wurde, nahtlos bearbeiten.
Die SPA-Erstellungsfunktion bietet eine umfassende Lösung zur Unterstützung von SPAs in AEM. In diesem Artikel wird eine vereinfachte SPA-Anwendung im React Framework vorgestellt, die erklärt, wie sie zusammengestellt wird, sodass Sie sich schnell mit Ihrer eigenen SPA vertraut machen können.
Dieser Artikel basiert auf dem React Framework. Das entsprechende Dokument für das Angular-Framework finden Sie unter Erste Schritte mit SPAs in AEM - Angular .
Für die Einzelseitenanwendung (SPA) Editor-Funktion ist AEM 6.4 Service Pack 2 oder höher erforderlich.
Der SPA-Editor ist die empfohlene Lösung für Projekte, bei denen clientseitiges Rendering (z.B. React oder Angular) durch das SPA-Framework erforderlich ist.

Einführung

Dieser Artikel fasst die grundlegenden Funktionen einer einfachen SPA und die Grundlagen zusammen, die Sie für deren Nutzung benötigen.
Weitere Informationen zur Funktionsweise von SPAs in AEM finden Sie in den folgenden Dokumenten:
Um Inhalt in einer SPA zu erstellen, muss der Inhalt in AEM gespeichert und durch das Inhaltsmodell verfügbar gemacht werden.
Eine SPA, die außerhalb von AEM entwickelt wurde, wird nicht autorisiert, wenn der Content-Modell-Vertrag nicht eingehalten wird.
In diesem Dokument wird die Struktur einer vereinfachten Einzelseitenanwendung erläutert, die mithilfe des React-Frameworks erstellt wurde, um zu veranschaulichen, wie sie funktioniert, damit Sie diese Vorstellung auf Ihre eigene Einzelseitenanwendung anwenden können.

Abhängigkeiten, Konfiguration und Aufbau

Zusätzlich zur erwarteten React-Abhängigkeit kann die Beispiel-SPA zusätzliche Bibliotheken nutzen, um die Erstellung der SPA effizienter zu gestalten.

Abhängigkeiten

Die package.json Datei definiert die Anforderungen des gesamten SPA-Pakets. Die AEM-Abhängigkeiten für eine funktionierende SPA sind hier aufgeführt.
  "dependencies": {
    "@adobe/cq-react-editable-components": "~1.0.3",
    "@adobe/cq-spa-component-mapping": "~1.0.3",
    "@adobe/cq-spa-page-model-manager": "~1.0.4"
  }

Da dieses Beispiel auf dem React-Framework basiert, gibt es zwei reaktionsspezifische Abhängigkeiten, die in der Datei package.json obligatorisch sind:
react
 react-dom

The aem-clientlib-generator is leveraged to make the creation of client libraries automatic as part of the build process.
"aem-clientlib-generator": "^1.4.1",
Weitere Details dazu können hier auf GitHub gefunden werden.
Die Mindestversion der aem-clientlib-generator erforderlichen Version ist 1.4.1.
The aem-clientlib-generator is configured in the clientlib.config.js file as follows.
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"
            ]
        }
    }
};

Erstellung

Bei der Erstellung der App wird neben dem aem-clientlib-generator zur automatischen Client-Bibliothekserstellung auch Webpack für die Übertragung verwendet. Daher ähnelt der Aufbaubefehl dem folgenden:
"build": "webpack && clientlib --verbose"
Sobald das Paket erstellt wurde, kann es in eine AEM-Instanz hochgeladen werden.

AEM-Projektarchetyp

Jedes AEM-Projekt sollte den AEM-Projektarchiv nutzen, der SPA-Projekte mit React oder Angular unterstützt und das SPA-SDK nutzt.

Anwendungsstruktur

Wenn Sie die Abhängigkeiten einbeziehen und Ihre App wie oben beschrieben erstellen, erhalten Sie ein funktionierendes SPA-Paket, das Sie in Ihre AEM-Instanz hochladen können.
Im nächsten Abschnitt dieses Dokuments erfahren Sie, wie eine SPA in AEM strukturiert ist, welche wichtigen Dateien die Anwendung antreiben und wie sie zusammenarbeiten.
Eine vereinfachte Bildkomponente wird als Beispiel verwendet, aber alle Komponenten der Anwendung basieren auf demselben Konzept.

index.js

Der Einstiegspunkt in die SPA ist natürlich die hier gezeigte Datei index.js , die sich auf den wichtigen Inhalt konzentriert.
import ReactDOM from 'react-dom';
import App from './App';
import { ModelManager, Constants } from "@adobe/cq-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'));

});

Die Hauptfunktion von index.js ist die Verwendung der Funktion ReactDOM.render , um zu bestimmen, wo im DOM die Anwendung injiziert werden soll.
Dies ist eine Standardverwendung dieser Funktion, nicht nur für diese Beispielanwendung.

Statische Instanziierung

Wenn die Komponente mit der Komponentenvorlage (z. B. JSX) statisch instanziiert wird, muss der Wert vom Modell an die Eigenschaften der Komponente übergeben werden.

App.js

Beim Rendern der App ruft index.js App.js auf, die hier in einer vereinfachten Version angezeigt wird, um die Erläuterung auf den wesentlichen Inhalt zu reduzieren.
import {Page, withModel } from '@adobe/cq-react-editable-components';

...

class App extends Page {
...
}

export default withModel(App);

App.js dient hauptsächlich dazu, die Root-Komponenten einzuschließen, aus denen die App besteht. Der Einstiegspunkt einer App ist die Seite.

Page.js

Durch Rendern der Seite werden App.js Aufrufe in einer vereinfachten Version Page.js angezeigt.
import {Page, MapTo, withComponentMappingContext } from "@adobe/cq-react-editable-components";

...

class AppPage extends Page {
...
}

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

In diesem Beispiel erweitert sich die AppPage Klasse Page , die die Methoden des inneren Inhalts enthält, die dann verwendet werden können.
Der Page nimmt die JSON-Repräsentation des Seitenmodells auf und verarbeitet den Inhalt, um jedes Element der Seite zu umhüllen/dekorieren. Weitere Details zum Page finden Sie im Dokument SPA-Blueprint .

Image.js

Mit der gerenderten Seite können die Komponenten wie Image.js wie hier dargestellt gerendert werden.
import React, {Component} from 'react';
import {MapTo} from '@adobe/cq-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);

Die zentrale Idee von SPAs in AEM ist die Idee, SPA-Komponenten auf AEM-Komponenten abzubilden und die Komponente zu aktualisieren, wenn der Inhalt geändert wird (und umgekehrt). See the document SPA Editor Overview for an summary of this communication model.
MapTo('my-react-app/components/content/image')(Image, ImageEditConfig);
Die MapTo -Methode ordnet die SPA-Komponente der AEM-Komponente zu. Es unterstützt die Verwendung einer einzelnen Zeichenfolge oder eines Arrays von Zeichenfolgen.
ImageEditConfig ist ein Konfigurationsobjekt, das dazu beiträgt, die Authoring-Funktionen einer Komponente zu aktivieren, indem die erforderlichen Metadaten bereitgestellt werden, damit der Editor Platzhalter generieren kann
Wenn kein Inhalt vorhanden ist, werden Etiketten als Platzhalter bereitgestellt, um den leeren Inhalt darzustellen.

Dynamisch weitergegebene Eigenschaften

Die vom Modell stammenden Daten werden dynamisch als Eigenschaften der Komponente übergeben.

Exportieren bearbeitbarer Inhalte

Sie können eine Komponente exportieren und bearbeitbar halten.
import React, { Component } from 'react';
import { MapTo } from '@cq/cq-react-editable-components';

...

const EditConfig = {...}

class PageClass extends Component {...};

...

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

The MapTo function returns a Component which is the result of a composition that extends the provided PageClass with the class names and attributes that enable the authoring. Diese Komponente kann exportiert werden, um später im Markup Ihrer Anwendung instanziiert zu werden.
When exported using the MapTo or withModel functions, the Page component, is wrapped with a ModelProvider component which provides standard components access to the latest version of the page model or a precise location in that page model.
Weitere Informationen finden Sie im Dokument SPA-Blueprint .
Standardmäßig erhalten Sie das gesamte Modell der Komponente, wenn Sie die Funktion withModel verwenden.

Freigeben von Informationen zwischen SPA-Komponenten

Es ist regelmäßig erforderlich, dass Komponenten in einer Einzelseitenanwendung Informationen austauschen. Es gibt mehrere empfohlene Methoden, um dies zu tun, wie folgt in steigender Reihenfolge der Komplexität aufgeführt.
  • Option 1: Zentralisieren Sie die Logik und senden Sie sie an die erforderlichen Komponenten, z. B. mithilfe von "React Context".
  • Option 2: Freigeben von Komponentenstatus mithilfe einer Statusbibliothek wie Redux
  • Option 3: Nutzen Sie die Objekthierarchie durch Anpassen und Erweitern der Container-Komponente.

Nächste Schritte

Eine schrittweise Anleitung zum Erstellen Ihrer eigenen SPA finden Sie im Lernprogramm Erste Schritte mit dem AEM SPA Editor - WKND Ereignisses .
Weitere Informationen zur Organisation der Entwicklung von SPAs für AEM finden Sie im Artikel Entwickeln von SPAs für AEM .
Weitere Informationen zum dynamischen Modell zur Komponentenzuordnung und dazu, wie es in AEM in SPAs funktioniert, finden Sie im Artikel Dynamisches Modell zur Komponentenzuordnung für SPAs .
Wenn Sie SPAs in AEM für ein anderes Framework als "React"oder "Angular"implementieren möchten oder einfach einen tiefen Einblick in die Funktionsweise des SPA-SDK für AEM erhalten möchten, lesen Sie den Artikel SPA Blueprint .