Guida introduttiva dell’SPA nell’AEM con React getting-started-with-spas-in-aem-using-react

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

La funzione di authoring dell’SPA offre una soluzione completa per il supporto dell’SPA nell’ambito dell’AEM. Questo articolo presenta un’applicazione SPA semplificata sul framework React, spiega come viene creato e come iniziare a utilizzare il proprio SPA in modo rapido.

NOTE
Questo articolo si basa sul framework React. Per il documento corrispondente per il framework Angular, consulta Guida introduttiva dell’SPA nell’AEM - Angular.

Introduzione introduction

Questo articolo riassume il funzionamento di base di un semplice SPA e il minimo che è necessario sapere per rendere il vostro funzionamento.

Per maggiori dettagli sul funzionamento dell’SPA nell’AEM, consulta i seguenti documenti:

NOTE
Per poter creare contenuti all’interno di un SPA, questi devono essere memorizzati nell’AEM ed essere esposti dal modello di contenuto.
Un SPA sviluppato al di fuori dell'AEM non sarà credibile se non rispetta il contratto tipo di contenuto.

Questo documento illustra la struttura di un SPA semplificato creato utilizzando il framework React e il suo funzionamento, per consentirti di applicare questa conoscenza al tuo SPA.

Dipendenze, configurazione e generazione dependencies-configuration-and-building

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

Dipendenze dependencies

Il package.json Definisce i requisiti del pacchetto globale SPA. Le dipendenze minime dell’AEM per un SPA funzionante 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 framework React, esistono due dipendenze specifiche di React che sono obbligatorie nel package.json file:

 react
 react-dom

Il aem-clientlib-generator viene utilizzato per rendere automatica la creazione di librerie client come parte del processo di build.

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

Ulteriori dettagli su di esso sono disponibili su GitHub qui.

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

Generazione building

La creazione dell’app utilizza Webpack oltre ad aem-clientlib-generator per la creazione automatica di librerie client. Pertanto, il comando build sarà simile al seguente:

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

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

Archetipo progetto AEM aem-project-archetype

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

Struttura dell'applicazione application-structure

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

La sezione successiva di questo documento illustra come è strutturato un SPA nell’AEM, i file importanti che guidano l’applicazione e come funzionano insieme.

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

index.js index-js

Il punto di ingresso nell'SPA è il index.js file qui mostrato semplificato per evidenziare i contenuti importanti.

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 è utilizzare il ReactDOM.render per determinare la posizione nel DOM in cui inserire l’applicazione.

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

Creazione di istanze statiche static-instantiation

Quando il componente viene creato in modo statico utilizzando il modello di componente (ad esempio, JSX), il valore deve essere trasmesso dal modello alle proprietà del componente.

App.js app-js

Eseguendo il rendering dell’app, index.js chiamate App.js, mostrato qui in una versione semplificata per concentrarti sul contenuto importante.

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

...

class App extends Page {
...
}

export default withModel(App);

App.js serve principalmente per eseguire il wrapping dei componenti radice che compongono l’app. Il punto di ingresso di qualsiasi app è la pagina.

Page.js page-js

Eseguendo il rendering della pagina, App.js chiamate Page.js elencate qui 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 il AppPage la classe si estende Page, che contiene i metodi di contenuto interno che possono quindi essere utilizzati.

Il Page acquisisce la rappresentazione JSON del modello della pagina ed elabora il contenuto per racchiudere/decorare ogni elemento della pagina. Ulteriori dettagli sulla Page si trova nel documento Blueprint SPA.

Image.js image-js

Con il rendering della pagina, i componenti come Image.js come mostrato qui, può essere riprodotto.

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 dell'SPA nell'AEM è l'idea di mappare i componenti dell'SPA ai componenti dell'AEM e di aggiornare il componente quando il contenuto viene modificato (e viceversa). Consulta il documento Panoramica dell’editor SPA per un riepilogo di questo modello di comunicazione.

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

Il MapTo method mappa il componente SPA su quello AEM. Supporta l’utilizzo di una singola stringa o di un array di stringhe.

ImageEditConfig è un oggetto di configurazione che contribuisce ad abilitare le funzionalità di authoring di un componente fornendo i metadati necessari all’editor per generare i segnaposto

Se non è presente alcun contenuto, le etichette vengono fornite come segnaposto per rappresentare il contenuto vuoto.

Proprietà passate dinamicamente dynamically-passed-properties

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

Esportazione di contenuti modificabili exporting-editable-content

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

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

Quando viene esportato utilizzando MapTo o withModel funzioni, la Page componente, è racchiuso con un tag ModelProvider componente che consente ai componenti standard di accedere all’ultima versione del modello di pagina o a una posizione precisa nel modello di pagina.

Per ulteriori informazioni, consulta Documento blueprint SPA.

NOTE
Per impostazione predefinita, quando si utilizza l'opzione, viene visualizzato l'intero modello del componente withModel funzione.

Condivisione di informazioni tra i componenti dell’SPA sharing-information-between-spa-components

La condivisione delle informazioni è regolarmente necessaria per i componenti di un’applicazione a pagina singola. Esistono diversi modi consigliati per farlo, elencati di seguito in ordine crescente di complessità.

  • Opzione 1: Centralizza la logica e la trasmissione ai componenti necessari, ad esempio, utilizzando React Context.
  • 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 next-steps

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