Modifica di un SPA esterno in Adobe Experience Manager

Quando si decide quale livello di integrazione si desidera avere tra l’SPA esterno e il Adobe Experience Manager (AEM), spesso è necessario essere in grado di modificare e visualizzare l’SPA all’interno dell’AEM.

Panoramica

Questo documento descrive i passaggi consigliati per caricare un SPA autonomo in un’istanza AEM, aggiungere sezioni di contenuto modificabili e abilitare l’authoring.

Prerequisiti

I prerequisiti sono semplici.

• Verificare che un'istanza dell'AEM sia in esecuzione localmente.
• Creare un progetto AEM SPA di base utilizzando l’archetipo del progetto AEM.
  • Su questa base si basa il progetto AEM, che sarà aggiornato per includere l'SPA esterno.
  • Gli esempi in questo documento utilizzano il punto di partenza di il progetto WKND SPA.
• Avere l'SPA React funzionante esterno che si desidera integrare a portata di mano.

Carica SPA in progetto AEM

Innanzitutto, devi caricare l’SPA esterno nel tuo progetto AEM.

1. Sostituisci src nel /ui.frontend cartella di progetto con l'applicazione React src cartella.
2. Includi eventuali dipendenze aggiuntive nel file package.json nel /ui.frontend/package.json file.
   • Assicurati che le dipendenze dell’SDK dell’SPA siano versioni consigliate.
3. Includi tutte le personalizzazioni in /public cartella.
4. Includi eventuali script o stili in linea aggiunti nel /public/index.html file.

Configurare l’SPA remoto

Ora che l’SPA esterno fa parte del progetto AEM, deve essere configurato all’interno dell’AEM.

Includi pacchetti SDK SPA di Adobe

Per sfruttare le caratteristiche dell'SPA dell'AEM, ci sono dipendenze dai tre pacchetti seguenti.

• @adobe/aem-react-editable-components
• @adobe/aem-spa-component-mapping
• @adobe/aem-spa-page-model-manager

Il @adobe/aem-spa-page-model-manager fornisce l’API per inizializzare Model Manager e recuperare il modello dall’istanza AEM. Questo modello può quindi essere utilizzato per eseguire il rendering dei componenti AEM utilizzando le API di @adobe/aem-react-editable-components e @adobe/aem-spa-component-mapping.

Installazione

Esegui il seguente comando npm per installare i pacchetti richiesti.

npm install --save @adobe/aem-spa-component-mapping @adobe/aem-spa-page-model-manager @adobe/aem-react-editable-components

Inizializzazione di ModelManager

Prima del rendering dell’app, il ModelManager deve essere inizializzato per gestire la creazione dell’AEM ModelStore.

Questa operazione deve essere eseguita entro src/index.js dell’applicazione o ovunque venga eseguito il rendering della directory principale dell’applicazione.

Per questo, utilizza initializationAsync API fornite da ModelManager.

La schermata seguente mostra come abilitare l’inizializzazione del ModelManager in una semplice applicazione React. L'unico vincolo è che initializationAsync deve essere chiamato prima di ReactDOM.render().

In questo esempio, la proprietà ModelManager è inizializzato e un valore vuoto ModelStore viene creato.

Il initializationAsync può facoltativamente accettare un options object come parametro:

• path - Al momento dell'inizializzazione, il modello nel percorso definito viene recuperato e memorizzato nel ModelStore. Può essere utilizzato per recuperare rootModel all’inizializzazione, se necessario.
• modelClient - Consente di fornire un client personalizzato responsabile del recupero del modello.
• model - A model l'oggetto passato come parametro viene generalmente popolato quando utilizzo di SSR

Componenti foglia compatibili con AEM

1. Creare/identificare un componente AEM per il quale verrà creato un componente React modificabile. In questo esempio, il progetto WKND utilizza il componente testo.

   

2. Creare un componente testo React semplice nell’SPA. In questo esempio, un nuovo file Text.js è stato creato con il seguente contenuto.

   

3. Crea un oggetto di configurazione per specificare gli attributi necessari per abilitare la modifica AEM.

   

   • resourceType è obbligatorio per mappare il componente React al componente AEM e abilitare la modifica quando si apre nell’editor AEM.

4. Utilizzare la funzione wrapper withMappable.

   

   Questa funzione wrapper mappa il componente React all’AEM resourceType specificato nella configurazione e abilita le funzionalità di modifica quando viene aperto nell’editor AEM. Per i componenti autonomi, recupera anche il contenuto del modello per il nodo specifico.

   NOTA

   In questo esempio, esistono versioni separate del componente: componenti AEM wrapped e React unwrapped. La versione racchiusa deve essere utilizzata quando si utilizza esplicitamente il componente. Quando il componente fa parte di una pagina, puoi continuare a utilizzare il componente predefinito come già fatto nell’editor SPA.

5. Esegui il rendering del contenuto nel componente.

   Le proprietà JCR del componente testo vengono visualizzate come segue in AEM.

   

   Questi valori vengono passati come proprietà al nuovo AEMText React e può essere utilizzato per riprodurre il contenuto.

   import React from 'react';
   import { withMappable } from '@adobe/aem-react-editable-components';
   
   export const TextEditConfig = {
       // Empty component placeholder label
       emptyLabel:'Text',
       isEmpty:function(props) {
          return !props || !props.text || props.text.trim().length < 1;
       },
       // resourcetype of the AEM counterpart component
       resourceType:'wknd-spa-react/components/text'
   };
   
   const Text = ({ text }) => (<div>{text}</div>);
   
   export default Text;
   
   export const AEMText = withMappable(Text, TextEditConfig);
   

   Questo è il modo in cui il componente appare quando le configurazioni dell’AEM sono completate.

   const Text = ({ cqPath, richText, text }) => {
      const richTextContent = () => (
         <div className="aem_text" id={cqPath.substr(cqPath.lastIndexOf('/') + 1)} data-rte-editelement dangerouslySetInnerHTML={{__html: text}}/>
      );
      return richText ? richTextContent() : (<div className="aem_text">{text}</div>);
   };
   

   NOTA

   In questo esempio, sono state apportate ulteriori personalizzazioni al componente di cui è stato eseguito il rendering, in modo che corrisponda al componente testo esistente. Questo tuttavia non è correlato all’authoring in AEM.

Aggiungere componenti autorizzabili alla pagina

Una volta creati, i componenti React possono essere utilizzati in tutta l’applicazione.

Prendiamo una pagina di esempio in cui è necessario aggiungere testo dal progetto WKND SPA. In questo esempio, si desidera visualizzare il testo "Hello World!" il /content/wknd-spa-react/us/en/home.html.

1. Determina il percorso del nodo da visualizzare.

   • pagePath: la pagina che contiene il nodo, nell’esempio /content/wknd-spa-react/us/en/home
   • itemPath: percorso del nodo all’interno della pagina, nell’esempio root/responsivegrid/text
     • È costituito dai nomi degli elementi che la contengono nella pagina.

   

2. Aggiungi il componente nella posizione richiesta nella pagina.

   

   Il AEMText Il componente può essere aggiunto nella posizione desiderata all’interno della pagina con pagePath e itemPath valori impostati come proprietà. pagePath è una proprietà obbligatoria.

Verificare la modifica del contenuto di testo su AEM

Ora testa il componente sull’istanza AEM in esecuzione.

1. Esegui il seguente comando Maven da aem-guides-wknd-spa per generare e distribuire il progetto in AEM.

mvn clean install -PautoInstallSinglePackage

1. Nell’istanza AEM, passa a http://<host>:<port>/editor.html/content/wknd-spa-react/us/en/home.html.

Il AEMText Il componente è ora disponibile per l’authoring su AEM.

Pagine AEM modificabili

1. Identifica una pagina da aggiungere per l’authoring nell’SPA. Questo esempio utilizza /content/wknd-spa-react/us/en/home.html.

2. Creare un file (ad esempio, Page.js) per il componente Pagina modificabile. In questo caso, è possibile riutilizzare il componente Pagina fornito in @adobe/cq-react-editable-components.

3. Ripeti il passaggio quattro nella sezione Componenti foglia modificabili dall’AEM. Utilizzare la funzione wrapper withMappable sul componente.

4. Come già fatto in precedenza, applica MapTo ai tipi di risorse AEM per tutti i componenti secondari all’interno della pagina.

   import { Page, MapTo, withMappable } from '@adobe/aem-react-editable-components';
   import Text, { TextEditConfig } from './Text';
   
   export default withMappable(Page);
   
   MapTo('wknd-spa-react/components/text')(Text, TextEditConfig);
   

   NOTA

   In questo esempio, viene utilizzato il componente testo React non racchiuso invece del componente testo racchiuso AEMText creato in precedenza. Questo perché quando il componente fa parte di una pagina o di un contenitore e non è autonomo, il contenitore si occupa della mappatura ricorsiva del componente e dell’abilitazione delle funzionalità di authoring e il wrapper aggiuntivo non è necessario per ogni elemento secondario.

5. Per aggiungere una pagina modificabile nell’SPA, segui gli stessi passaggi descritti nella sezione Aggiungere componenti autorizzabili alla pagina. Qui possiamo saltare il itemPath proprietà.

Verifica contenuto pagina in AEM

Per verificare che la pagina possa essere modificata, segui gli stessi passaggi descritti nella sezione Verificare la modifica del contenuto di testo su AEM.

La pagina è ora modificabile su AEM con un contenitore di layout e un componente testo figlio.

Componenti foglia virtuale

Negli esempi precedenti, abbiamo aggiunto componenti all’SPA con contenuti AEM esistenti. Tuttavia, in alcuni casi il contenuto non è ancora stato creato in AEM, ma deve essere aggiunto successivamente dall’autore del contenuto. In questo modo, lo sviluppatore front-end può aggiungere componenti nelle posizioni appropriate all’interno dell’SPA. Questi componenti visualizzano i segnaposto quando vengono aperti nell’editor in AEM. Una volta che il contenuto viene aggiunto all’interno di questi segnaposto dall’autore del contenuto, i nodi vengono creati nella struttura JCR e il contenuto viene mantenuto. Il componente creato consente di eseguire le stesse operazioni dei componenti foglia autonomi.

In questo esempio, stiamo riutilizzando AEMText componente creato in precedenza. Desideriamo che venga aggiunto nuovo testo sotto il componente testo esistente nella home page di WKND. L’aggiunta dei componenti è la stessa dei normali componenti foglia. Tuttavia, il itemPath può essere aggiornato al percorso in cui è necessario aggiungere il nuovo componente.

Poiché il nuovo componente deve essere aggiunto sotto il testo esistente in root/responsivegrid/text, il nuovo percorso sarà root/responsivegrid/{itemName}.

<AEMText
 pagePath='/content/wknd-spa-react/us/en/home'
 itemPath='root/responsivegrid/text_20' />

Il TestPage dopo l’aggiunta del componente virtuale, il componente si presenta come segue.

Ora puoi implementare le modifiche all’AEM seguendo i passaggi descritti nella sezione Verificare la modifica del contenuto di testo su AEM. Viene visualizzato un segnaposto per il file attualmente non esistente text_20 nodo.

Quando l’autore di contenuto aggiorna questo componente, viene aggiunto un nuovo text_20 il nodo viene creato alle root/responsivegrid/text_20 in /content/wknd-spa-react/us/en/home.

Requisiti e limitazioni

Esistono diversi requisiti per aggiungere componenti foglia virtuali e alcune limitazioni.

• Il pagePath è obbligatoria per la creazione di un componente virtuale.
• Il nodo pagina fornito nel percorso in pagePath deve esistere nel progetto AEM.
• Il nome del nodo da creare deve essere fornito nel itemPath.
• Il componente può essere creato a qualsiasi livello.
  • Se forniamo un’ itemPath='text_20' nell’esempio precedente, il nuovo nodo verrà creato direttamente sotto la pagina ovvero, /content/wknd-spa-react/us/en/home/jcr:content/text_20
• Il percorso del nodo in cui viene creato un nuovo nodo deve essere valido quando fornito tramite itemPath.
  • In questo esempio, root/responsivegrid deve esistere affinché il nuovo nodo text_20 possono essere create lì.
• È supportata solo la creazione di componenti foglia. Contenitore virtuale e pagina saranno supportati nelle versioni future.

Contenitori virtuali

È supportata la possibilità di aggiungere contenitori, anche se il contenitore corrispondente non è ancora stato creato in AEM. Il concetto e l’approccio sono simili a componenti foglia virtuali.

Lo sviluppatore front-end può aggiungere i componenti contenitore nelle posizioni appropriate all’interno dell’SPA e tali componenti visualizzeranno dei segnaposto quando vengono aperti nell’editor nell’AEM. L’autore può quindi aggiungere componenti e il relativo contenuto al contenitore, che creerà i nodi richiesti nella struttura JCR.

Ad esempio, se un contenitore esiste già in /root/responsivegrid e lo sviluppatore desidera aggiungere un nuovo contenitore secondario:

newContainer non esiste ancora nel AEM.

Durante la modifica della pagina che contiene questo componente in AEM, viene visualizzato un segnaposto vuoto per un contenitore in cui l’autore può aggiungere contenuti.

Una volta che l’autore aggiunge un componente secondario al contenitore, il nuovo nodo del contenitore viene creato con il nome corrispondente nella struttura JCR.

È ora possibile aggiungere al contenitore altri componenti e contenuti necessari all’autore e le modifiche verranno mantenute.

Requisiti e limitazioni

Esistono diversi requisiti per aggiungere contenitori virtuali e alcune limitazioni.

• Il criterio per determinare quali componenti possono essere aggiunti verrà ereditato dal contenitore principale.
• L’elemento padre diretto del contenitore da creare deve già esistere in AEM.
  • Se il contenitore root/responsivegrid esiste già nel contenitore AEM, è possibile creare un nuovo contenitore fornendo il percorso root/responsivegrid/newContainer.
  • Tuttavia root/responsivegrid/newContainer/secondNewContainer non è possibile.
• È possibile creare un solo nuovo livello di componente alla volta.

Personalizzazioni aggiuntive

Se hai seguito gli esempi precedenti, il tuo SPA esterno è ora modificabile all’interno dell’AEM. Tuttavia, vi sono altri aspetti del vostro SPA esterno che potete personalizzare ulteriormente.

ID nodo principale

Per impostazione predefinita, si presuppone che l’applicazione React sia rappresentata all’interno di un div di ID elemento spa-root. Se necessario, questo può essere personalizzato.

Ad esempio, supponiamo di avere un SPA in cui l’applicazione viene riprodotta all’interno di un div di ID elemento root. Questo deve essere riflesso in tre file.

1. In index.js dell’applicazione React (o dove ReactDOM.render() è chiamato)

   

2. In index.html dell’applicazione React

   

3. Nel corpo del componente Pagina dell’app AEM, segui questi due passaggi:

   1. Creare un body.html per il componente Pagina.

   

   1. Aggiungi il nuovo elemento principale nel nuovo body.html file.

   

Modifica di un SPA React con routing

Se l’applicazione esterna React SPA ha più pagine, può utilizzare il routing per determinare la pagina/componente di cui eseguire il rendering. Il caso d’uso di base prevede che l’URL attualmente attivo corrisponda al percorso fornito per una route. Per consentire la modifica di tali applicazioni abilitate per l’instradamento, il percorso da confrontare deve essere trasformato per adattarsi alle informazioni specifiche dell’AEM.

Nell’esempio seguente abbiamo una semplice applicazione React con due pagine. La pagina di cui eseguire il rendering viene determinata confrontando il percorso fornito al router con l’URL attivo. Ad esempio, se siamo in mydomain.com/test, TestPage verrà eseguito il rendering.

Per abilitare la modifica all’interno dell’AEM per questo esempio di SPA, sono necessari i seguenti passaggi.

1. Identificare il livello che fungerebbe da base per l’AEM.

   • Per il nostro esempio, consideriamo wknd-spa-react/us/en come radice dell'SPA. Ciò significa che tutto ciò che precede quel percorso sono solo pagine/contenuti AEM.

2. Crea una pagina al livello richiesto.

   • In questo esempio, la pagina da modificare è mydomain.com/test. test si trova nel percorso principale dell’app. Questo deve essere mantenuto anche durante la creazione della pagina in AEM. Pertanto, puoi creare una pagina al livello principale definito nel passaggio precedente.
   • La nuova pagina creata deve avere lo stesso nome della pagina da modificare. In questo esempio per mydomain.com/test, la nuova pagina creata deve essere /path/to/aem/root/test.

3. Aggiungere helper all’interno del routing SPA.

   • La pagina appena creata non eseguirà ancora il rendering del contenuto previsto in AEM. Questo perché il router prevede un percorso di /test considerando che il percorso attivo dell'AEM è /wknd-spa-react/us/en/test. Per adattarsi alla porzione dell’URL specifica per l’AEM, è necessario aggiungere degli helper sul lato SPA.

   

   • Il toAEMPath helper fornito da @adobe/cq-spa-page-model-manager può essere utilizzato per questo. Trasforma il percorso fornito per il routing in modo da includere parti specifiche dell'AEM quando l'applicazione è aperta su un'istanza dell'AEM. Accetta tre parametri:

     • Percorso necessario per il routing
     • URL di origine dell’istanza AEM in cui viene modificato l’SPA
     • Elemento di base del progetto sull’AEM come determinato nella prima fase

   • Questi valori possono essere impostati come variabili di ambiente per maggiore flessibilità.

4. Verifica la modifica della pagina in AEM.

   • Distribuisci il progetto in AEM e passa al nuovo test pagina. Ora viene eseguito il rendering del contenuto della pagina e i componenti AEM sono modificabili.

Limitazioni del framework

Il componente RemotePage prevede che l’implementazione fornisca un manifesto delle risorse come quello trovato qui. Il componente RemotePage, tuttavia, è stato testato per funzionare solo con il framework React (e Next.js tramite il componente remote-page-next ) e pertanto non supporta il caricamento remoto di applicazioni da altri framework, come ad Angular.

Risorse aggiuntive

I seguenti materiali di riferimento possono essere utili per comprendere l'SPA nel contesto dell'AEM.

• L’archetipo del progetto AEM
• Il progetto WKND SPA
• Guida introduttiva alle SPA in AEM usando React
• Materiali di riferimento SPA (riferimenti API)
• Blueprint SPA e PageModelManager
• Routing modello SPA
• Rendering lato server e SPA