Show Menu
ARGOMENTI×

Sviluppo di SPA per AEM

Le applicazioni SPA (Single Page Applications) possono offrire esperienze coinvolgenti agli utenti di siti Web. Gli sviluppatori desiderano essere in grado di creare siti utilizzando i framework SPA e gli autori desiderano modificare i contenuti all'interno AEM per un sito creato utilizzando tali framework.
Questo articolo presenta domande importanti da tenere in considerazione quando uno sviluppatore front-end si impegna a sviluppare una SPA per AEM e fornisce una panoramica dell'architettura di AEM per quanto riguarda l'implementazione di SPA su AEM.

Principi di sviluppo SPA per AEM

Lo sviluppo di applicazioni a pagina singola in AEM presuppone che lo sviluppatore front-end rispetti le best practice standard per la creazione di un'app SPA. Se uno sviluppatore front-end segue queste best practice generali e pochi principi AEM specifici, l'SPA funzionerà con le funzioni di creazione dei AEM e di creazione dei contenuti .
  • Portabilità - Come per qualsiasi componente, i componenti devono essere costruiti per essere il più possibile portatili. La SPA deve essere realizzata con componenti portabili e riutilizzabili.
  • AEM struttura del sito - Lo sviluppatore front-end crea componenti e possiede la propria struttura interna, ma si basa su AEM per definire la struttura del contenuto del sito.
  • Rendering dinamico - Il rendering deve essere dinamico.
  • Routing dinamico - L'SPA è responsabile dell'instradamento e AEM lo ascolta e recupera in base ad esso. Anche l'indirizzamento deve essere dinamico.
Se tenete presenti questi principi nello sviluppo dell'SPA, sarà quanto più flessibile e affidabile possibile, consentendo al contempo tutte le funzionalità di authoring AEM supportate.
Se non è necessario supportare AEM funzioni di authoring, potrebbe essere necessario considerare un diverso modello di progettazione SPA.

Portabilità

Come per lo sviluppo di qualsiasi componente, i componenti devono essere progettati in modo da massimizzarne la portabilità. Eventuali schemi che contrastino con la portabilità o riutilizzabilità dei componenti dovrebbero essere evitati per garantire compatibilità, flessibilità e manutenibilità in futuro.
La SPA risultante deve essere realizzata con componenti altamente portatili e riutilizzabili.

AEM struttura del sito

Lo sviluppatore front-end deve considerare se stesso come responsabile della creazione di una libreria di componenti SPA utilizzati per creare l'app. Lo sviluppatore front-end ha il controllo completo della struttura interna dei componenti. Tuttavia AEM possiede sempre la struttura del sito.
Questo significa che lo sviluppatore front-end può aggiungere il 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 controllo completo del modo in cui i componenti vengono nidificati, ad esempio.

Rendering dinamico

L'area SPA deve basarsi solo sul rendering dinamico dei contenuti. Questa è l'aspettativa predefinita in cui AEM recupera e visualizza tutti gli elementi secondari della struttura del contenuto.
Qualsiasi rendering esplicito che punti a contenuto specifico viene considerato come rendering statico e, anche se supportato, non sarà compatibile con AEM funzioni di authoring dei contenuti. Ciò va anche contro il principio di portabilità .

Routing dinamico

Come per il rendering, anche tutti i routing devono essere dinamici. In AEM, l'SPA deve sempre possedere l'indirizzamento e AEM ascoltare e recuperare 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 funzioni di authoring dei contenuti di AEM. Ad esempio, con l'indirizzamento statico, se l'autore del contenuto desidera modificare una route o una pagina, deve chiedere allo sviluppatore front-end di farlo.

AEM Project Archetype

Qualsiasi progetto AEM dovrebbe sfruttare il AEM Project Archetype , che supporta i progetti SPA utilizzando React o Angular e sfrutta l’SDK SPA.

Modelli di progettazione SPA

Se vengono seguiti i principi dello sviluppo di SPA in AEM , l'SPA funzionerà con tutte le funzioni AEM di authoring dei contenuti supportate.
Ci possono essere tuttavia dei casi in cui ciò non è del tutto necessario. La tabella seguente fornisce una panoramica dei vari modelli di progettazione, dei relativi vantaggi e dei relativi svantaggi.
Modello di progettazione Vantaggi Svantaggi
AEM viene utilizzato come CMS headless senza utilizzare il framework SDK SPA Editor. Lo sviluppatore front-end ha il controllo completo sull'app.
Gli autori dei contenuti non possono sfruttare AEM'esperienza di authoring dei contenuti.
Il codice non è né portatile né riutilizzabile se contiene riferimenti statici o routing.
Non consente l'utilizzo dell'editor modelli, pertanto lo sviluppatore front-end deve mantenere i modelli modificabili tramite JCR.
Lo sviluppatore front-end utilizza il framework SPA Editor SDK, ma apre solo alcune aree all’autore del contenuto. Lo sviluppatore mantiene il controllo sull'app abilitando solo l'authoring nelle aree limitate dell'app.
Gli autori dei contenuti sono limitati a una serie limitata di esperienze di authoring AEM contenuto.
Il codice non può essere portatile né riutilizzabile se contiene riferimenti statici o routing.
Non consente l'utilizzo dell'editor modelli, pertanto lo sviluppatore front-end deve mantenere i modelli modificabili tramite JCR.
Il progetto sfrutta appieno l’SDK dell’editor SPA e i componenti frontend sono sviluppati come libreria e la struttura del contenuto dell’app è delegata a AEM.
L'app è riutilizzabile e portatile.
L'autore del contenuto può modificare l'app utilizzando AEM'esperienza di creazione del contenuto.
L'SPA è compatibile con l'editor modelli.
Lo sviluppatore non ha il controllo della struttura dell'app e della parte di contenuto delegata a AEM.
Lo sviluppatore può comunque riservare aree dell'app per il contenuto che non deve essere creato utilizzando AEM.
Anche se tutti i modelli sono supportati in AEM, solo implementando il terzo (e quindi seguendo i principi di sviluppo SPA consigliati in AEM ) gli autori dei contenuti potranno interagire con e modificare il contenuto dell'SPA in AEM come sono abituati.

Migrazione di SPA esistenti a AEM

In genere, se l'SPA segue i principi di sviluppo dell' SPA per AEM , l'SPA lavorerà in AEM e sarà modificabile utilizzando AEM SPA Editor.
Seguite questi passaggi per rendere l'SPA esistente pronto a funzionare con AEM.
  1. I componenti JS sono modulari. - Renderli in grado di essere sottoposti a rendering in qualsiasi ordine, posizione e dimensione.
  2. Utilizza i contenitori forniti dal nostro SDK per inserire i componenti sullo schermo. - AEM fornisce un componente per il sistema di paragrafi e pagine da usare.
  3. Create un componente AEM per ciascun componente JS. - I componenti AEM definiscono la finestra di dialogo e l'output JSON.

Istruzioni per gli sviluppatori front-end

Il compito principale di coinvolgere uno sviluppatore front-end nella creazione di un'app per AEM è quello di concordare i componenti e i relativi modelli JSON.
Di seguito viene illustrato i passi che uno sviluppatore front-end deve seguire nello sviluppo di un'app per AEM.
  1. Concordare sui componenti e il relativo modello JSON
    Gli sviluppatori front-end e gli sviluppatori AEM back-end devono concordare su quali componenti sono necessari e un modello, per cui esiste una corrispondenza uno-a-uno tra i componenti SPA e i componenti back-end.
    AEM componenti sono ancora necessari principalmente per fornire finestre di dialogo di modifica ed esportare il modello di componente.
  2. In React components, accedere al modello tramite this.props.cqModel
    Una volta che i componenti sono concordati e il modello JSON è in atto, lo sviluppatore front-end è libero di sviluppare l'SPA e può semplicemente accedere al modello JSON tramite this.props.cqModel .
  3. Implementare il metodo del render() componente
    Lo sviluppatore front-end implementa il render() metodo nel modo desiderato e può utilizzare i campi della cqModel proprietà. Questo produce il DOM e i frammenti HTML che verranno inseriti nella pagina. Questo è il modo standard per creare un'app in React.
  4. Mappa il componente sul tipo di risorsa AEM tramite MapTo()
    La mappatura memorizza le classi di componenti e viene utilizzata internamente dal Container componente fornito per recuperare e creare in modo dinamico le istanze dei componenti in base al tipo di risorsa specificato.
    Questo serve come "colla" tra front-end e back-end in modo che l'editor sappia quali componenti corrispondono.
    Gli esempi Page e ResponsiveGrid sono buoni di classi che estendono la base Container .
  5. Definite il componente come EditConfig parametro in MapTo()
    Questo parametro è necessario per indicare all’editor in che modo il componente deve essere nominato fino a quando non viene ancora eseguito il rendering o non ha contenuto da riprodurre.
  6. Estende la Container classe fornita per pagine e contenitori
    Le pagine e i sistemi paragrafo devono estendere questa classe in modo che la delega ai componenti interni funzioni come previsto.
  7. Implementate una soluzione di routing che utilizza l’ History API HTML5.
    Quando ModelRouter è abilitata, la chiamata delle funzioni pushState e replaceState attiverà una richiesta PageModelManager per recuperare un frammento mancante del modello.
    La versione corrente dell' ModelRouter unico supporto per l'uso di URL che puntano al percorso effettivo delle risorse dei punti di ingresso del modello Sling. Non supporta l’uso di URL personalizzati o alias.
    È ModelRouter possibile disabilitare o configurare in modo da ignorare un elenco di espressioni regolari.

AEM-Agnostico

Questi blocchi di codice illustrano come i componenti React e Angular non necessitano di elementi specifici per Adobe o AEM.
  • Tutto ciò che si trova all'interno del componente JavaScript è AEMagnostico.
  • Ciò che è specifico di AEM è che il componente JS deve essere mappato a un componente AEM con l’helper MapTo.
L' MapTo aiutante è la "colla" che permette di combinare i componenti back-end e front-end:
  • Indica al contenitore JS (o al sistema di paragrafi JS) quale componente JS è responsabile per il rendering di ciascuno dei componenti presenti nel JSON.
  • Aggiunge all’HTML un attributo di dati HTML di cui il componente JS esegue il rendering, in modo che l’editor SPA sappia quale finestra di dialogo visualizzare all’autore quando modifica il componente.
Per ulteriori informazioni sull’utilizzo MapTo e la creazione di app per AEM in generale, consulta la Guida introduttiva per il framework scelto.

Architettura AEM e SPA

L’architettura generale di AEM, inclusi gli ambienti di sviluppo, creazione e pubblicazione, non cambia quando si utilizzano gli ZPS. Tuttavia, è utile comprendere in che modo lo sviluppo SPA si inserisce in questa architettura.
  • Ambiente di generazione
    Qui si trova l'origine dell'applicazione SPA e l'origine del componente.
    • Il generatore clientlib NPM crea una libreria client dal progetto SPA.
    • Tale libreria verrà scattata da Maven e distribuita dal plug-in Maven Build insieme al componente in AEM Author.
  • AEM Author
    Il contenuto viene creato sull’autore AEM, inclusi gli SPA di authoring.
    Quando si modifica un'app SPA utilizzando l'editor SPA nell'ambiente di authoring:
    1. SPA richiede l’HTML esterno.
    2. Il CSS viene caricato.
    3. Viene caricato il codice JavaScript dell’applicazione SPA.
    4. Quando l'applicazione SPA viene eseguita, viene richiesto l'JSON, che consente all'app di creare il DOM della pagina, inclusi gli cq-data attributi.
    5. Questi cq-data attributi consentono all’editor di caricare informazioni aggiuntive sulla pagina, in modo da sapere quali configurazioni di modifica sono disponibili per i componenti.
  • AEM Publish
    Qui vengono pubblicati per l’uso pubblico i contenuti creati e le librerie compilate, inclusi gli artefatti dell’applicazione SPA, i clientlibs e i componenti.
  • Dispatcher/CDN
    Il dispatcher funge da livello di caching dei AEM per i visitatori del sito.
    • Le richieste vengono elaborate in modo simile a come si trovano in AEM Author, ma non vi sono richieste di informazioni sulla pagina, poiché ciò è necessario solo per l'editor.
    • Javascript, CSS, JSON e HTML sono memorizzati nella cache, ottimizzando la pagina per una distribuzione rapida.
All'interno AEM non è necessario eseguire meccanismi di creazione Javascript o eseguire lo stesso Javascript. AEM ospita solo gli artifact compilati dall'applicazione SPA.

Passaggi successivi