Sviluppo di SPA per AEM

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

Questo articolo presenta domande importanti da considerare quando si coinvolge uno sviluppatore front-end per sviluppare un SPA per AEM e fornisce una panoramica dell’architettura di AEM rispetto alla distribuzione di SPA su 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.

Principi di sviluppo SPA per le 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 un SPA. Se in qualità di sviluppatore front-end segui queste best practice generali e pochi principi AEM specifici, il tuo SPA funzionerà con AEM e le sue funzionalità di authoring dei contenuti.

• Portabilità - Come per tutti i componenti, i componenti devono essere costruiti in modo da essere il più possibile portatili. Il SPA deve essere generato con componenti portabili e riutilizzabili, evitando percorsi statici che fanno riferimento alla struttura del contenuto.
• Struttura del sito AEM - Lo sviluppatore front-end crea componenti e possiede la propria 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 - Il SPA è responsabile dell’indirizzamento e AEM lo ascolta e recupera i dati del componente in base ad esso. Anche qualsiasi indirizzamento deve essere dinamico.

Se tieni presenti questi principi durante lo sviluppo del SPA, sarà il più flessibile e scalabile possibile, abilitando tutte le funzionalità di authoring AEM supportate.

Se non è necessario supportare AEM funzioni di authoring, potrebbe essere necessario considerare un SPA modello di progettazione.

Portabilità

Come per lo sviluppo di qualsiasi componente, i componenti devono essere progettati in modo da massimizzarne la portabilità. Eventuali schemi che si oppongono alla portabilità o alla riutilizzabilità dei componenti dovrebbero essere evitati per garantire la compatibilità, la flessibilità e la manutenibilità in futuro.

Lo sviluppatore deve evitare di utilizzare percorsi statici che si riferiscono alla struttura del contenuto, in quanto i percorsi possono essere modificati in qualsiasi momento dagli autori dei contenuti. Questo limita anche la riutilizzabilità della libreria e impedisce l’utilizzo dell’Editor modelli di AEM, in quanto la sua struttura si trova in una posizione diversa dal contenuto.

Il SPA risultante deve essere realizzato con componenti altamente portatili e riutilizzabili.

Struttura del sito AEM

Lo sviluppatore front-end deve ritenersi 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 della modalità di nidificazione dei componenti, ad esempio.

Rendering dinamico

Il SPA dovrebbe basarsi solo sul rendering dinamico del contenuto. Questa è l’aspettativa predefinita in cui 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 sarà compatibile con le funzioni di authoring dei contenuti AEM. Ciò va anche contro il principio portabilità.

Routing dinamico

Come per il rendering, anche tutto il ciclo di produzione deve essere dinamico. In AEM, il SPA deve sempre essere proprietario del ciclo di produzione e AEM lo ascolta e recupera il contenuto in base ad esso.

Qualsiasi indirizzamento statico funziona contro principio di portabilità e limita l’autore non essendo compatibile con le funzioni di authoring dei contenuti di AEM. Ad esempio, con l’indirizzamento statico, se l’autore del contenuto desidera modificare un percorso o una pagina, deve chiedere allo sviluppatore front-end di farlo.

Modelli di progettazione SPA

Se la Principi di sviluppo delle SPA in AEM le SPA funzioneranno con tutte le funzioni di authoring dei contenuti AEM supportate.

Ci possono essere tuttavia 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.

Migrazione di SPA esistenti a AEM

Generalmente se il tuo SPA segue il Principi di sviluppo SPA per le AEM, quindi il tuo SPA funzionerà in AEM e potrà essere modificato utilizzando l’editor SPA AEM.

Segui questi passaggi per rendere il tuo SPA esistente pronto per lavorare con AEM.

1. Rendi i tuoi componenti JS modulari.

   Renderli in grado di essere sottoposti a rendering in qualsiasi ordine, posizione e dimensione.

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

   AEM fornisce un componente del sistema di paragrafi e di pagina 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 gli sviluppatori front-end

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

Di seguito è riportato un profilo dei passaggi che uno sviluppatore front-end deve seguire durante lo sviluppo di un SPA per AEM.

1. Accettare i componenti e il relativo modello JSON

   Gli sviluppatori front-end e gli sviluppatori di back-end AEM devono concordare quali componenti sono necessari e un modello in modo che ci sia una corrispondenza uno a uno dai componenti SPA ai componenti back-end.

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

2. In React components, accedi al modello tramitethis.props.cqModel

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

3. Implementare render() metodo

   Lo sviluppatore front-end implementa le render() metodo che ritiene idoneo e può utilizzare i campi 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. Mappa il componente sul tipo di risorsa AEM tramiteMapTo()

   La mappatura memorizza le classi di componenti e viene utilizzata internamente dal Container per recuperare e creare dinamicamente un’istanza dei componenti in base al tipo di risorsa specificato.

   Questa funzione funge da "colla" tra front end e back end, in modo che l'editor sappia a quali componenti corrispondono i componenti reattivi.

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

5. Definisci i del componente EditConfig come parametro perMapTo()

   Questo parametro è necessario per dire all’editor come deve essere chiamato il componente a lungo che non è ancora stato sottoposto a rendering o non ha contenuto da riprodurre.

6. Estendi i Container Classe per pagine e contenitori

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

7. Implementare una soluzione di routing che utilizza HTML5 History API.

   Quando il ModelRouter è abilitato, chiamando il pushState e replaceState le funzioni attiveranno una richiesta PageModelManager per recuperare un frammento mancante del modello.

   La versione corrente del ModelRouter supporta solo l’uso di URL che puntano al percorso effettivo della risorsa dei punti di ingresso del modello Sling. Non supporta l’uso di URL personalizzati o alias.

   La ModelRouter può essere disabilitato o configurato per 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 un Adobe o un AEM.

• Tutto ciò che si trova all’interno del componente JavaScript è indipendente dalla AEM.
• Ciò che è tuttavia specifico di AEM è che il componente JS deve essere mappato su un componente AEM con l’helper MapTo.

La MapTo helper è la "colla" che consente di associare i componenti back-end e front-end:

• Indica al contenitore JS (o al sistema di paragrafi 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 di SPA sappia quale finestra di dialogo visualizzare all’autore durante la modifica del componente.

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

• Guida introduttiva a SPA in AEM - React
• Guida introduttiva a SPA in AEM - Angular

Architettura AEM e SPA

L’architettura generale di AEM, inclusi gli ambienti di sviluppo, authoring e pubblicazione, non cambia quando si utilizza SPA. Tuttavia, è utile comprendere come lo sviluppo SPA si inserisce in questa architettura.

• Ambiente di build

  In questo punto viene estratto l’origine dell’applicazione SPA e l’origine del componente.

  • Il generatore clientlib NPM crea una libreria client dal progetto SPA.
  • Tale libreria verrà prelevata da Maven e distribuita dal plug-in Maven Build insieme al componente per l’authoring di AEM.

• Autore AEM

  Il contenuto viene creato sull’autore AEM, inclusa la SPA di authoring.

  Quando un SPA viene modificato utilizzando l’Editor SPA nell’ambiente di authoring:

  1. Il SPA richiede il 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 il JSON, che consente all’app di creare il DOM della pagina, incluso il cq-data attributi.
  5. Questo cq-data attributes consente all'editor di caricare informazioni aggiuntive sulla pagina in modo che sappia quali configurazioni di modifica sono disponibili per i componenti.

• AEM Publish

  In questo punto i contenuti creati e le librerie compilate, inclusi gli artefatti SPA applicazioni, le clientlibs e i componenti, vengono pubblicati per l’uso pubblico.

• Dispatcher / CDN

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

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

Passaggi successivi

Per una panoramica della struttura e del funzionamento di un SPA semplice in AEM, consulta la guida introduttiva per entrambe le Reagire e Angular.

Per una guida dettagliata alla creazione di un tuo SPA, consulta la sezione Guida introduttiva all’editor di SPA AEM - Tutorial eventi WKND.

Per ulteriori dettagli sul modello dinamico per la mappatura dei componenti e su come funziona all’interno di SPA in AEM, consulta l’articolo Mappatura dinamica da modello a componente per SPA.

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

Risorse Business.Adobe.com

Personalized Communications Embedded Charts Version History Customer Experience Management Digital Rights Management Headless Cms