DocumentazioneAEM 6.5Guida utente

Sviluppo di SPA per AEM developing-spas-for-aem

Last update: Sun Jul 14 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Argomenti:

Creato per:

  • Sviluppatore

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 di Adobe Experience Manager (AEM) per un sito creato utilizzando tali framework.

Questo articolo presenta questioni importanti da considerare quando si impegna uno sviluppatore front-end a sviluppare un SPA per l’AEM e fornisce una panoramica dell’architettura dell’AEM per quanto riguarda la diffusione dell’SPA sull’AEM.

NOTE
L’editor SPA è la soluzione consigliata per i progetti che richiedono il rendering lato client basato sul framework SPA (ad esempio, React o Angular).

Principi di sviluppo dell'SPA per l'AEM spa-development-principles-for-aem

Lo sviluppo di applicazioni a pagina singola in AEM presuppone che lo sviluppatore front-end osservi le best practice standard durante la creazione di una SPA. Se in qualità di sviluppatore front-end segui queste best practice generali e alcuni principi specifici dell'AEM, il tuo SPA funzionerà con AEM e le sue funzionalità di authoring dei contenuti.

  • Portabilità - Come per qualsiasi componente, i componenti devono essere costruiti in modo da essere il più possibile portatili. La SPA deve essere realizzata con componenti portabili e riutilizzabili.
  • AEM definisce la struttura del sito: lo sviluppatore front-end crea componenti e possiede la loro struttura interna, ma si basa su AEM per definire la struttura dei contenuti del sito.
  • Rendering dinamico - Tutto il rendering deve essere dinamico.
  • Routing dinamico - L'SPA è responsabile del routing e l'AEM lo ascolta e recupera in base a esso. Anche altri routing devono essere dinamici.

Se tieni presenti questi principi durante lo sviluppo dell’SPA, sarà il più possibile flessibile e a prova di futuro, consentendo al contempo tutte le funzionalità di authoring dell’AEM supportate.

Se non è necessario supportare le funzionalità di creazione AEM, potrebbe essere necessario prendere in considerazione un modello di progettazione SPA diverso.

Portabilità portability

Come per qualsiasi altro componente, i componenti devono essere progettati in modo da massimizzarne la portabilità. È necessario evitare qualsiasi modello che possa compromettere la portabilità o la riutilizzabilità dei componenti per garantire compatibilità, flessibilità e manutenibilità in futuro.

Il SPA risultante dovrebbe essere costruito con componenti altamente portatili e riutilizzabili.

Struttura del sito di guida AEM aem-drives-site-structure

Lo sviluppatore front-end deve considerarsi responsabile della creazione di una libreria di componenti SPA utilizzati per creare l’app. Lo sviluppatore front-end ha il pieno controllo della struttura interna dei componenti. Tuttavia, l'AEM è sempre il proprietario della struttura del sito.

Questo significa che lo sviluppatore front-end può aggiungere contenuto del cliente prima o dopo il punto di ingresso dei componenti e può anche effettuare chiamate di terze parti all’interno del componente. Tuttavia, lo sviluppatore front-end non ha il pieno controllo, ad esempio, del modo in cui i componenti vengono nidificati.

Rendering dinamico dynamic-rendering

L’SPA deve basarsi solo sul rendering dinamico dei contenuti. Questa è l’aspettativa predefinita in cui l’AEM recupera ed esegue il rendering di tutti gli elementi secondari della struttura del contenuto.

Qualsiasi rendering esplicito che punti a contenuti specifici viene considerato come rendering statico e, sebbene supportato, non è compatibile con le funzioni di authoring dei contenuti dell’AEM. Ciò è contrario anche al principio di portabilità.

Routing dinamico dynamic-routing

Come per il rendering, anche tutte le operazioni di instradamento devono essere dinamiche. In AEM, l'SPA deve sempre essere il proprietario del routing e l'AEM ascolta il routing e recupera il contenuto in base ad esso.

Qualsiasi routing statico funziona in base al principio di portabilità e limita l'autore in quanto non è compatibile con le funzionalità di authoring dei contenuti dell'AEM. Ad esempio, con il routing statico, se l’autore di contenuto desidera modificare un percorso o una pagina, deve chiedere allo sviluppatore front-end di farlo.

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.

Modelli di progettazione SPA spa-design-models

Se si seguono i principi di sviluppo dell'SPA nell'AEM, l'SPA funzionerà con tutte le funzionalità di authoring dei contenuti AEM supportate.

In alcuni casi, tuttavia, ciò non è del tutto necessario. Nella tabella seguente viene fornita una panoramica dei vari modelli di progettazione, dei vantaggi e degli svantaggi.

Modello di progettazione
Vantaggi
Svantaggi
AEM viene utilizzato come CMS headless senza il framework SDK dell'editor SPA.
Lo sviluppatore front-end ha il pieno controllo dell’app.

Gli autori dei contenuti non possono utilizzare l’esperienza di authoring dei contenuti dell’AEM.

Il codice non è portatile né riutilizzabile se contiene riferimenti statici o di routing.

Non consente l’utilizzo dell’editor di modelli, pertanto lo sviluppatore front-end deve mantenere i modelli modificabili tramite JCR.

Lo sviluppatore front-end utilizza il framework SDK dell’editor SPA, ma apre solo alcune aree all’autore di contenuto.
Lo sviluppatore mantiene il controllo sull’app abilitando l’authoring solo nelle aree limitate dell’app.

Gli autori dei contenuti sono limitati a un set limitato di esperienze AEM per l’authoring dei contenuti.

Il codice rischia di non essere né portatile né riutilizzabile se contiene riferimenti statici o instradamento.

Non consente l’utilizzo dell’editor di modelli, pertanto lo sviluppatore front-end deve mantenere i modelli modificabili tramite JCR.

Il progetto utilizza appieno l’SDK dell’editor dell’SPA e i componenti front-end vengono sviluppati come una libreria e la struttura del contenuto dell’app viene delegata all’AEM.

L’app è riutilizzabile e portatile.

L'autore del contenuto può modificare l'app utilizzando l'esperienza di authoring dei contenuti dell'AEM.

L’SPA è compatibile con l’editor di modelli.

Lo sviluppatore non ha il controllo della struttura dell’app e della parte di contenuto delegata all’AEM.

Lo sviluppatore può comunque riservare alcune aree dell’app per i contenuti che non devono essere creati con l’AEM.

NOTE
Anche se tutti i modelli sono supportati nell'AEM, solo implementando il terzo (e quindi seguendo i principi di sviluppo dell'SPA consigliati nell'AEM) gli autori dei contenuti possono interagire con e modificare il contenuto dell'SPA nell'AEM come sono abituati.

Migrazione dall’SPA esistente all’AEM migrating-existing-spas-to-aem

In genere, se il tuo SPA segue i Principi di sviluppo dell'SPA per AEM, il tuo SPA funzionerà in AEM e sarà modificabile utilizzando l'editor dell'SPA dell'AEM.

Segui questi passaggi per preparare il tuo SPA esistente a lavorare con l’AEM.

  1. Rendere modulari i componenti JS.

    Rendi possibile il rendering in qualsiasi ordine, posizione e dimensione.

  2. Utilizza i contenitori forniti dall'SDK di Adobe per inserire i componenti sullo schermo.

    L’AEM fornisce un componente per il sistema di pagine e paragrafi da utilizzare.

  3. Creare un componente AEM per ogni componente JS.

    I componenti AEM definiscono la finestra di dialogo e l’output JSON.

Istruzioni per sviluppatori front-end instructions-for-front-end-developers

Il compito principale nel coinvolgere uno sviluppatore front-end per creare un SPA per l’AEM è quello di concordare i componenti e i relativi modelli JSON.

Di seguito è riportato uno schema dei passaggi che uno sviluppatore front-end deve seguire quando sviluppa un SPA per l’AEM.

  1. Accetto i componenti e il relativo modello JSON

    Gli sviluppatori front-end e gli sviluppatori back-end dell’AEM devono concordare i componenti necessari e un modello, in modo da garantire una corrispondenza uno a uno tra i componenti SPA e i componenti back-end.

    I componenti AEM sono ancora necessari soprattutto per fornire finestre di dialogo di modifica ed esportare il modello di componente.

  2. Nei componenti React, accedere al modello tramitethis.props.cqModel

    Una volta concordati i componenti e impostato il modello JSON, lo sviluppatore front-end è libero di sviluppare l'SPA e può semplicemente accedere al modello JSON tramite this.props.cqModel.

  3. Implementa il metodo render() del componente

    Lo sviluppatore front-end implementa il metodo render() come ritiene opportuno e può utilizzare i campi della proprietà cqModel. In questo modo vengono generati i frammenti DOM e HTML inseriti nella pagina. Questo è il modo standard per creare un’app in React.

  4. Mappa il componente sul tipo di risorsa AEM tramiteMapTo()

    Il mapping archivia le classi di componenti e viene utilizzato internamente dal componente Container fornito per recuperare e creare in modo dinamico istanze di componenti in base al tipo di risorsa specificato.

    Questo funge da "colla" tra front-end e back-end in modo che l’editor sappia a quali componenti corrispondono i componenti react.

    Page e ResponsiveGrid sono buoni esempi di classi che estendono la base Container.

  5. Definisci EditConfig del componente come parametro perMapTo()

    Questo parametro è necessario per indicare all’editor come deve essere denominato il componente, purché non sia ancora stato eseguito il rendering o non sia presente alcun contenuto da riprodurre.

  6. Estendi la classe Container fornita per pagine e contenitori

    I sistemi di pagine e paragrafi devono estendere questa classe in modo che la delega ai componenti interni funzioni come previsto.

  7. Implementa una soluzione di routing che utilizza l'API History di HTML5.

    Quando ModelRouter è abilitato, la chiamata delle funzioni pushState e replaceState attiva una richiesta a PageModelManager per recuperare un frammento mancante del modello.

    La versione corrente di ModelRouter supporta solo l'utilizzo di URL che puntano al percorso effettivo delle risorse dei punti di ingresso del modello Sling. Non supporta l’utilizzo di URL personalizzati o alias.

    ModelRouter può essere disabilitato o configurato per ignorare un elenco di espressioni regolari.

AEM-agnostico aem-agnostic

Questi blocchi di codice illustrano in che modo i componenti React e Angular non richiedono nulla che sia specifico per Adobe o AEM.

  • Tutto ciò che si trova all’interno del componente JavaScript è indipendente dall’AEM.
  • Tuttavia, ciò che è specifico per l’AEM è che il componente JS deve essere mappato su un componente AEM con l’helper MapTo.

schermata_shot_2018-12-11at144019

L'helper MapTo è l'"associazione" che consente la corrispondenza tra i componenti back-end e front-end:

  • Indica al contenitore JS (o al sistema paragrafo JS) quale componente JS è responsabile del rendering di ciascuno dei componenti presenti nel JSON.
  • Aggiunge un attributo di dati HTML al HTML di cui viene eseguito il rendering del componente JS, in modo che l’editor SPA sappia quale finestra di dialogo visualizzare per l’autore quando modifica il componente.

Per ulteriori informazioni sull'utilizzo di MapTo e sulla creazione di SPA per l'AEM in generale, vedere la Guida introduttiva per il framework scelto.

Architettura e SPA del AEM aem-architecture-and-spas

L’architettura generale dell’AEM, compresi gli ambienti di sviluppo, authoring e pubblicazione, non cambia quando si utilizza l’SPA. Tuttavia, è utile capire in che modo lo sviluppo dell’SPA si inserisce in questa architettura.

schermata_shot_2018-12-11at145348

  • Ambiente di compilazione

    In questo caso, l'origine dell'applicazione SPA e l'origine dei componenti vengono sottoposte a Check-Out.

    • Il generatore clientlib NPM crea una libreria client dal progetto SPA.
    • Tale libreria viene presa da Maven e implementata dal plug-in Maven Build insieme al componente nell’istanza di authoring dell’AEM.

  • Autore AEM

    I contenuti vengono creati nell’autore dell’AEM, inclusa la creazione dell’SPA.

    Quando si modifica un SPA utilizzando l’Editor SPA nell’ambiente di authoring:

    1. L'SPA richiede il HTML esterno.
    2. CSS caricato.
    3. Il JavaScript dell’applicazione SPA è caricato.
    4. Quando viene eseguita l'applicazione SPA, viene richiesto il JSON, che consente all'app di generare il DOM della pagina, inclusi gli attributi cq-data.
    5. Questi attributi cq-data consentono all'editor di caricare informazioni aggiuntive sulla pagina in modo da sapere quali configurazioni di modifica sono disponibili per i componenti.

  • Publish AEM

    Qui vengono pubblicati per il consumo pubblico i contenuti creati e le librerie compilate, inclusi gli artefatti delle applicazioni SPA, clientlibs e componenti.

  • Dispatcher / CDN

    Dispatcher funge da livello di caching dell’AEM per i visitatori del sito.

    • Le richieste vengono elaborate in modo simile a come nell’Autore AEM, tuttavia non vi è alcuna richiesta di informazioni della pagina, perché questo è necessario solo per l’editor.
    • JavaScript, CSS, JSON e HTML sono memorizzati nella cache, ottimizzando la pagina per una consegna rapida.
NOTE
All’interno dell’AEM, non è necessario eseguire meccanismi di sviluppo JavaScript né eseguire il JavaScript stesso. L’AEM ospita solo gli artefatti compilati dell’applicazione SPA.

Passaggi successivi next-steps

Per una panoramica sulla struttura e sul funzionamento di un semplice SPA nell'AEM, consulta la guida introduttiva sia per React che per Angular.

Per una guida dettagliata alla creazione di un proprio SPA, consulta Guida introduttiva all'Editor SPA dell'AEM - Esercitazione eventi WKND.

Per ulteriori dettagli sulla mappatura da modello dinamico a componente e sul suo funzionamento all'interno dell'SPA nell'AEM, vedere l'articolo Mappatura da modello dinamico a componente per SPA.

Se desideri implementare l'SPA nell'AEM per un framework diverso da React o Angular o semplicemente approfondire il funzionamento dell'SDK SPA per l'AEM, consulta l'articolo Blueprint SPA.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2