Sviluppo di SPA per AEM

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 i contenuti all’interno di AEM per un sito creato utilizzando tali frameworks.

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 in relazione alla diffusione dell’SPA sull’AEM.

Principi di sviluppo dell'SPA per l'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 dell'instradamento e l'AEM ascolta e recupera in base ad 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 funzioni di creazione dell’AEM, potrebbe essere necessario considerare un Modello di progettazione SPA.

Portabilità

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

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 AEM in ogni momento possiede la 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

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 AEM. Questo va anche contro il principio di portabilità.

Routing dinamico

Come per il rendering, anche tutte le operazioni di instradamento devono essere dinamiche. Nell'AEM, l'SPA deve essere sempre proprietario dell'instradamento e l’AEM lo ascolta e ne recupera i contenuti in base a esso.

Qualsiasi instradamento statico funziona rispetto al principio di portabilità e limita l’autore in quanto non è compatibile con le funzioni 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

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

Se il Principi per lo sviluppo dell'SPA nell'AEM sono seguiti, quindi l’SPA funzionerà con tutte le funzioni di authoring dei contenuti dell’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.

Migrazione dall’SPA esistente all’AEM

Generalmente, se l’SPA segue le Principi di sviluppo dell'SPA per l'AEM, il suo SPA funzionerà nell’AEM e sarà modificabile utilizzando l’Editor AEM SPA.

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

1. Rendi i componenti JS modulari.

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

2. Utilizza i contenitori forniti dal nostro SDK per posizionare i componenti sullo schermo.

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

3. Crea un componente AEM per ogni componente JS.

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

Istruzioni per sviluppatori front-end

Il compito principale nello spingere uno sviluppatore front-end a 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. Concordare 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, accedi 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. Implementare i render() metodo

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

4. Mappare il componente al tipo di risorsa AEM tramiteMapTo()

   Il mapping memorizza le classi dei componenti e viene utilizzato internamente dal Container per recuperare e creare un’istanza dinamica dei 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.

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

5. Definisci i EditConfig 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 il fornito Container classe 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. Implementare una soluzione di routing che utilizzi HTML5 History API.

   Quando ModelRouter è abilitato, chiamando il pushState e replaceState attiverà una richiesta al PageModelManager per recuperare un frammento mancante del modello.

   La versione corrente del 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.

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

AEM-agnostico

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.

Il MapTo helper è la "colla" che consente di abbinare 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 la creazione dell’SPA per l’AEM in generale, consulta la Guida introduttiva per il framework scelto.

• Guida introduttiva dell’SPA nell’AEM - React
• Guida introduttiva dell’SPA nell’AEM - Angular

Architettura e SPA del AEM

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.

• Ambiente di build

  Qui è dove vengono estratti l'origine dell'applicazione SPA e l'origine dei componenti.

  • Il generatore clientlib NPM crea una libreria client dal progetto SPA.
  • Tale libreria verrà presa da Maven e implementata dal plug-in Maven Build insieme al componente in AEM Author.

• 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. Javascript dell’applicazione SPA caricato.
  4. Quando viene eseguita l’applicazione SPA, viene richiesto il JSON, che consente all’app di creare il DOM della pagina, incluso cq-data attributi.
  5. Questo cq-data attributi consente all’editor di caricare informazioni di pagina aggiuntive in modo da sapere quali configurazioni di modifica sono disponibili per i componenti.

• AEM Publish

  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

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

  • Le richieste vengono elaborate in modo simile a come nell’istanza di authoring di AEM, tuttavia non vi è alcuna richiesta di informazioni sulla pagina, in quanto ciò è necessario solo per l’editor.
  • JavaScript, CSS, JSON e HTML sono memorizzati nella cache, ottimizzando la pagina per una consegna rapida.

Passaggi successivi

Per una panoramica della struttura e del funzionamento di un semplice SPA nell’AEM, consulta la guida introduttiva per entrambi React e Angular.

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

Per ulteriori dettagli sul modello dinamico di mappatura dei componenti e sul suo funzionamento all’interno dell’SPA nell’AEM, vedi l’articolo Mappatura di un modello dinamico a un 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 Blueprint SPA articolo.

Risorse Business.Adobe.com