Rendering lato SPA e lato server

NOTA

La funzione Editor applicazione per pagina singola (SPA) richiede AEM 6.4 service pack 2 o versioni successive.

SPA Editor è la soluzione consigliata per i progetti che richiedono SPA rendering lato client basato su framework (ad es. React o Angular).

NOTA

AEM 6.4.5.0 o versione successiva è necessario per utilizzare le funzionalità di rendering lato server SPA come descritto in questo documento.

Panoramica

Le applicazioni a pagina singola (SPA) possono offrire all'utente un'esperienza ricca e dinamica che reagisce e si comporta in modo familiare, spesso proprio come le applicazioni native. Ciò si ottiene affidandosi al client per caricare i contenuti in primo piano e quindi sfruttando al massimo l' interazione con l'utente, riducendo al minimo la quantità di comunicazione necessaria tra il client e il server, rendendo l'app più reattiva.

Tuttavia, questo può comportare tempi di caricamento iniziali più lunghi, soprattutto se il SPA è grande e ricco di contenuti. Per ottimizzare i tempi di caricamento, è possibile eseguire il rendering di parte del contenuto sul lato server. L’utilizzo del rendering lato server (SSR) può accelerare il caricamento iniziale della pagina e quindi passare al client un ulteriore rendering.

Quando utilizzare SSR

SSR non è richiesto per tutti i progetti. Anche se AEM supporta completamente JS SSR per SPA, Adobe non consiglia di implementarlo sistematicamente per ogni progetto.

Quando si decide di implementare SSR è necessario prima stimare quale ulteriore complessità, sforzo e costo supplementare SSR rappresenta realisticamente per il progetto, inclusa la manutenzione a lungo termine. L'architettura SSR dovrebbe essere scelta solo quando il valore aggiunto supera chiaramente i costi stimati.

SSR di solito fornisce un certo valore quando esiste un chiaro "sì" a una delle seguenti domande:

  • SEO: SSR è ancora effettivamente richiesto per il sito per essere correttamente indicizzato dai motori di ricerca che portano traffico? Tenere presente che i principali crawler del motore di ricerca ora valutano JS.
  • Velocità pagina: SSR offre un miglioramento misurabile della velocità in ambienti reali e aggiunge all'esperienza utente complessiva?

Solo quando ad almeno una di queste due domande viene risposto con un chiaro "sì" per il progetto, Adobe consiglia di implementare SSR. Le sezioni seguenti descrivono come eseguire questa operazione utilizzando Adobe I/O Runtime.

Adobe I/O Runtime

Se si è sicuri che il progetto richiede l'implementazione di SSR, Adobe soluzione consigliata è utilizzare Adobe I/O Runtime.

Per maggiori informazioni su Adobe I/O Runtime, consulta

Nelle sezioni seguenti viene illustrato come Adobe I/O Runtime può essere utilizzato per implementare SSR per il SPA in due modelli diversi:

NOTA

Adobe consiglia un’istanza Adobe I/O Runtime separata per ogni ambiente AEM (autore, pubblicazione, area di visualizzazione, ecc.).

Configurazione del modulo di rendering dei contenuti remota

AEM sapere dove è possibile recuperare il contenuto sottoposto a rendering remoto. A prescindere da quale modello si sceglie di implementare per SSR, sarà necessario specificare AEM modalità di accesso a questo servizio di rendering remoto.

Questo viene fatto tramite il servizio RemoteContentRenderer - Configuration Factory OSGi. Cercate la stringa "RemoteContentRenderer" nella console di configurazione della console Web all'indirizzo http://<host>:<port>/system/console/configMgr.

I campi seguenti sono disponibili per la configurazione:

  • Percorso contenuto - Espressione regolare per far corrispondere una parte del contenuto, se necessario
  • URL endpoint remoto - URL dell'endpoint responsabile della generazione del contenuto
    • Utilizzare il protocollo HTTPS protetto se non nella rete locale.
  • Intestazioni di richiesta aggiuntive - Intestazioni aggiuntive da aggiungere alla richiesta inviata all'endpoint remoto
    • Pattern: key=value
  • Timeout richiesta - Timeout richiesta host remoto in millisecondi
NOTA

Indipendentemente dalla scelta di implementare il flusso di comunicazione basato su AEM o il flusso basato su Adobe I/O Runtime, è necessario definire una configurazione del renderer del contenuto remoto.

Questa configurazione deve essere definita anche se si sceglie di utilizzare un server Node.js personalizzato.

NOTA

Questa configurazione utilizza il Modulo di rendering del contenuto remoto, che dispone di ulteriori opzioni di estensione e personalizzazione.

Flusso di comunicazione AEM

Quando si utilizza SSR, il flusso di lavoro di interazione dei componenti di SPA in AEM include una fase in cui il contenuto iniziale dell'app viene generato da Adobe I/O Runtime.

  1. Il browser richiede il contenuto SSR da AEM.
  2. AEM postare il modello su Adobe I/O Runtime.
  3. Adobe I/O Runtime restituisce il contenuto generato
  4. AEM serve l’HTML restituito da Adobe I/O Runtime tramite il modello HTL del componente della pagina di back-end.

server-side-rendering-cms-Drivenaemnode

Flusso di comunicazione basato su Adobe I/O Runtime

La sezione AEM-Driven Communication Flow descrive l'implementazione standard e consigliata del rendering lato server per quanto riguarda SPA in AEM, dove AEM esegue il bootstrap e la trasmissione del contenuto.

In alternativa, SSR può essere implementato in modo che Adobe I/O Runtime sia responsabile del bootstrap, invertendo efficacemente il flusso di comunicazione.

Entrambi i modelli sono validi e supportati da AEM. Tuttavia, è opportuno considerare i vantaggi e gli svantaggi di ciascuno di essi prima di implementare un particolare modello.

Avvio Vantaggi Svantaggi
via AEM AEM gestisce le librerie di inserimento dove necessario
Le risorse devono essere mantenute solo su AEM
Potrebbe non essere familiare a SPA sviluppatore
tramite Adobe I/O Runtime Più familiare agli sviluppatori SPA Le risorse Clientlib richieste dall'applicazione, come CSS e JavaScript, dovranno essere rese disponibili dallo sviluppatore AEM tramite la proprietà allowProxy
Le risorse devono essere sincronizzate tra AEM e Adobe I/O Runtime
Per abilitare la creazione del SPA, potrebbe essere necessario un server proxy per Adobe I/O Runtime

Pianificazione per SSR

In genere, è necessario eseguire il rendering solo di una parte dell'applicazione sul lato server. L’esempio comune è il contenuto che verrà visualizzato sopra la piega al caricamento iniziale della pagina e che deve essere rappresentato lato server. Questo consente di risparmiare tempo distribuendo al client contenuti già sottoposti a rendering. Quando l'utente interagisce con il SPA, il contenuto aggiuntivo viene rappresentato dal client.

Considerando l'implementazione del rendering lato server per il SPA, è necessario verificare quali parti dell'app richiederanno SSR.

Sviluppo di un SPA utilizzando SSR

SPA componenti possono essere sottoposti a rendering dal lato client (nel browser) o server. Sul lato server di cui è stato eseguito il rendering, le proprietà del browser, ad esempio la dimensione della finestra e la posizione, non sono presenti. Pertanto SPA componenti dovrebbero essere isomorfi, senza dare per scontato dove saranno sottoposti a rendering.

Per sfruttare SSR, dovrete distribuire il codice sia in AEM che in Adobe I/O Runtime, responsabile per il rendering lato server. La maggior parte del codice sarà uguale, ma le attività specifiche del server saranno diverse.

SSR per SPA in AEM

La funzionalità SSR per SPA in AEM richiede Adobe I/O Runtime, che viene chiamato per il rendering del lato del server del contenuto dell'app. All’interno dell’HTL dell’app, viene chiamata una risorsa su Adobe I/O Runtime per eseguire il rendering del contenuto.

Come AEM supporta i framework Angular e React SPA out-of-the-box, anche il rendering lato server è supportato per le app Angular e React. Per ulteriori informazioni, consulta la documentazione di NPM per entrambi i framework.

Per un esempio semplicistico, fare riferimento all'app We.Retail Journal. Viene eseguito il rendering dell'intero lato del server dell'applicazione. Anche se non si tratta di un esempio reale, viene illustrato ciò che è necessario per implementare SSR.

ATTENZIONE

L'app We.Retail Journal è solo a scopo dimostrativo e utilizza Node.js come esempio semplice invece dell'Adobe I/O Runtime consigliato. Questo esempio non deve essere utilizzato per nessun progetto.

NOTA

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

Utilizzo di Node.js

Adobe I/O Runtime è la soluzione consigliata per implementare SSR per SPA in AEM.

Per le istanze di AEM on-premesis, è anche possibile implementare SSR utilizzando un'istanza Node.js personalizzata nello stesso modo descritto in precedenza. Anche se è supportato da Adobe, non è consigliato.

Node.js non è supportato per istanze AEM ospitate dal Adobe.

NOTA

Se SSR deve essere implementato tramite Node.js, Adobe consiglia un'istanza Node.js separata per ogni ambiente AEM (autore, pubblicazione, stage, ecc.).

Modulo di rendering contenuti remoto

La configurazione del modulo di rendering dei contenuti remoti necessaria per utilizzare SSR con il SPA in AEM tappe in un servizio di rendering più generalizzato che può essere esteso e personalizzato in base alle proprie esigenze.

RemoteContentRenderingService

RemoteContentRenderingService è un servizio OSGi per recuperare il contenuto su un server remoto, ad esempio da Adobe I/O. Il contenuto inviato al server remoto si basa sul parametro di richiesta passato.

RemoteContentRenderingService può essere iniettato dall'inversione di dipendenza in un modello Sling personalizzato o servlet quando è richiesta ulteriore manipolazione del contenuto.

Questo servizio viene utilizzato internamente da RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

La RemoteContentRendererRequestHandlerServlet può essere utilizzata per impostare in modo programmatico la configurazione della richiesta. DefaultRemoteContentRendererRequestHandlerImpl, l'implementazione del gestore di richieste predefinito fornita, consente di creare più configurazioni OSGi per mappare una posizione nella struttura del contenuto a un endpoint remoto.

Per aggiungere un gestore di richieste personalizzato, implementate l'interfaccia RemoteContentRendererRequestHandler. Assicurarsi di impostare la proprietà del componente Constants.SERVICE_RANKING su un numero intero superiore a 100, che corrisponde alla classifica del componente DefaultRemoteContentRendererRequestHandlerImpl.

@Component(immediate = true,
        service = RemoteContentRendererRequestHandler.class,
        property={
            Constants.SERVICE_RANKING +":Integer=1000"
        })
public class CustomRemoteContentRendererRequestHandlerImpl implements RemoteContentRendererRequestHandler {}

Configurare la configurazione OSGi del gestore predefinito

La configurazione del gestore predefinito deve essere configurata come descritto nella sezione Configurazione del modulo di rendering dei contenuti remoti.

Utilizzo del modulo di rendering dei contenuti remoto

Per ottenere un servlet fetch e restituire il contenuto che può essere inserito nella pagina:

  1. Verificare che il server remoto sia accessibile.
  2. Aggiungete uno dei seguenti snippet al modello HTL di un componente AEM.
  3. Facoltativamente, potete creare o modificare le configurazioni OSGi.
  4. Sfogliare il contenuto del sito

In genere, il modello HTL di un componente di pagina è il destinatario principale di tale funzione.

<sly data-sly-resource="${resource @ resourceType='cq/remote/content/renderer/request/handler'}" />

Requisiti

I servlet sfruttano Sling Model Exporter per serializzare i dati dei componenti. Per impostazione predefinita, sia com.adobe.cq.export.json.ContainerExporter che com.adobe.cq.export.json.ComponentExporter sono supportati come adattatori per modelli Sling. Se necessario, è possibile aggiungere delle classi alle quali la richiesta deve essere adattata utilizzando la RemoteContentRendererServlet e implementando la RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. Le classi aggiuntive devono estendere la classe ComponentExporter.

In questa pagina