Guida introduttiva a SPA in AEM con React

Le applicazioni a pagina singola (SPA) possono offrire esperienze coinvolgenti agli utenti di siti web. Gli sviluppatori desiderano poter creare siti utilizzando framework SPA e gli autori desiderano modificare i contenuti all’interno di AEM per un sito creato utilizzando framework SPA.

La funzione di authoring SPA offre una soluzione completa per supportare SPA all’interno di AEM. Questo articolo presenta un'applicazione SPA semplificata sul framework React, spiega come viene messo insieme, che consente di iniziare rapidamente a usare i propri SPA.

NOTA

Questo articolo si basa sul quadro di React. Per il documento corrispondente per il framework di Angular vedi Guida introduttiva a SPA in AEM - Angular.

Introduzione

Questo articolo riassume il funzionamento di base di un SPA semplice e il minimo che devi sapere per far funzionare il tuo.

Per ulteriori dettagli sul funzionamento SPA in AEM, consulta i seguenti documenti:

NOTA

Per poter creare contenuti all’interno di un SPA, i contenuti devono essere memorizzati in AEM ed essere esposti dal modello di contenuto.

Un SPA sviluppato al di fuori di AEM non sarà autorizzabile se non rispetta il contratto relativo al modello di contenuto.

Questo documento illustra la struttura di un SPA semplificato creato utilizzando il framework React e illustra come funziona in modo da poter applicare questa comprensione al proprio SPA.

Dipendenze, configurazione e creazione

Oltre alla dipendenza React prevista, l’SPA di esempio può sfruttare librerie aggiuntive per rendere più efficiente la creazione dell’SPA.

Dipendenze

La package.json Il file definisce i requisiti del pacchetto SPA globale. Le dipendenze minime AEM per un SPA di lavoro sono elencate qui.

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

Poiché questo esempio si basa sul quadro React, esistono due dipendenze specifiche React che sono obbligatorie nel package.json file:

 react
 react-dom

La aem-clientlib-generator viene sfruttato per rendere automatica la creazione di librerie client come parte del processo di compilazione.

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

Maggiori dettagli sono disponibili su GitHub.

La aem-clientlib-generator è configurato in clientlib.config.js file come segue.

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

Creazione di

In realtà, la creazione di app sfrutta Webpack per la trasformazione in aggiunta al generatore aem-clientlib-per la creazione automatica della libreria client. Pertanto, il comando di compilazione sarà simile a:

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

Una volta generato, il pacchetto può essere caricato in un'istanza AEM.

Archetipo progetto AEM

Qualsiasi progetto AEM deve sfruttare Archetipo di progetto AEM, che supporta progetti SPA utilizzando React o Angular e sfrutta l’SDK di SPA.

Struttura dell'applicazione

L’inclusione delle dipendenze e la creazione dell’app come descritto in precedenza ti lasceranno con un pacchetto di SPA funzionante che puoi caricare nella tua istanza AEM.

La sezione successiva di questo documento illustra la struttura di un SPA in AEM, i file importanti che guidano l'applicazione e il modo in cui funzionano insieme.

Un componente immagine semplificato viene utilizzato come esempio, ma tutti i componenti dell’applicazione sono basati sullo stesso concetto.

index.js

Il punto di ingresso nel SPA è ovviamente il index.js il file mostrato qui è stato semplificato per concentrarsi sul contenuto importante.

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

});

La funzione principale di index.js utilizza ReactDOM.render per determinare dove nel DOM inserire l'applicazione.

Si tratta di un utilizzo standard di questa funzione, non univoco per questa app di esempio.

Istanza statica

Quando il componente viene istanziato staticamente utilizzando il modello di componente (ad esempio JSX), il valore deve essere passato dal modello alle proprietà del componente.

App.js

Rendering dell’app index.js chiama App.js, che viene qui mostrato in una versione semplificata per concentrarsi sul contenuto importante.

import {Page, withModel } from '@adobe/aem-react-editable-components';

...

class App extends Page {
...
}

export default withModel(App);

App.js esegue principalmente il wrapping dei componenti principali che compongono l’app. Il punto di ingresso di qualsiasi app è la pagina.

Page.js

Rendering della pagina App.js chiama Page.js elencati in una versione semplificata.

import {Page, MapTo, withComponentMappingContext } from "@adobe/aem-react-editable-components";

...

class AppPage extends Page {
...
}

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

In questo esempio AppPage Estensioni di classe Page, che contiene i metodi di contenuto interno che possono essere utilizzati.

La Page acquisisce la rappresentazione JSON del modello di pagina ed elabora il contenuto per racchiudere/decorare ogni elemento della pagina. Maggiori dettagli Page disponibile nel documento Blueprint SPA.

Image.js

Con il rendering della pagina, i componenti come Image.js come mostrato qui, è possibile renderizzarlo.

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

L’idea centrale di SPA in AEM è quella di mappare SPA componenti ai componenti AEM e aggiornare il componente quando il contenuto viene modificato (e viceversa). Vedere il documento Panoramica dell’editor di SPA per una sintesi di questo modello di comunicazione.

MapTo('my-react-app/components/content/image')(Image, ImageEditConfig);

La MapTo mappa il componente SPA al componente AEM. Supporta l'uso di una singola stringa o di una matrice di stringhe.

ImageEditConfig è un oggetto di configurazione che contribuisce ad abilitare le funzionalità di authoring di un componente fornendo i metadati necessari affinché l’editor generi segnaposti

In assenza di contenuto, le etichette vengono fornite come segnaposto per rappresentare il contenuto vuoto.

Proprietà trasmesse dinamicamente

I dati provenienti dal modello vengono trasmessi dinamicamente come proprietà del componente.

Esportazione di contenuti modificabili

Puoi esportare un componente e mantenerlo modificabile.

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

La MapTo restituisce un Component che è il risultato di una composizione che estende il PageClass con i nomi e gli attributi della classe che abilitano l'authoring. Questo componente può essere esportato in un secondo momento per essere istanziato nel markup dell’applicazione.

Quando viene esportato utilizzando la variabile MapTo o withModel le funzioni Page è racchiuso in un ModelProvider che fornisce ai componenti standard l’accesso alla versione più recente del modello di pagina o a una posizione precisa nel modello di pagina.

Per ulteriori informazioni, consulta la sezione Documento Blueprint SPA.

NOTA

Per impostazione predefinita viene visualizzato l’intero modello del componente quando si utilizza il withModel funzione .

Condivisione Di Informazioni Tra I Componenti SPA

È regolarmente necessario che i componenti all’interno di un’applicazione a pagina singola condividano informazioni. Ci sono diversi modi raccomandati per farlo, elencati come segue in ordine crescente di complessità.

  • Opzione 1: Centralizza la logica e la trasmissione ai componenti necessari, ad esempio utilizzando il contesto di reazione.
  • Opzione 2: Condividere gli stati dei componenti utilizzando una libreria di stati come Redux.
  • Opzione 3: Sfrutta la gerarchia degli oggetti personalizzando ed estendendo il componente contenitore .

Passaggi successivi

In questa pagina