Rendering lato server e SPA

Le applicazioni a pagina singola (SPA) possono offrire all’utente un’esperienza ricca e dinamica che reagisce e si comporta in modo familiare, spesso come un’applicazione nativa. Questa funzionalità si ottiene affidandosi al client per caricare il contenuto in primo piano e quindi eseguire il pesante sollevamento dell’interazione dell’utente. Questo processo riduce al minimo la quantità di comunicazione necessaria tra il client e il server, rendendo l’app più reattiva.

Tuttavia, questo processo può portare a tempi di caricamento iniziali più lunghi, soprattutto se l'SPA è grande e ricco di contenuti. Per ottimizzare i tempi di caricamento, è possibile eseguire il rendering di alcuni contenuti lato server. L’utilizzo del rendering lato server (SSR) può accelerare il caricamento iniziale della pagina e quindi trasmettere un ulteriore rendering al client.

Quando utilizzare SSR

SSR non è richiesto per tutti i progetti. Sebbene l’AEM supporti completamente la SSR JS per l’SPA, l’Adobe sconsiglia di attuarla sistematicamente per ogni progetto.

Quando decidi di implementare SSR, devi innanzitutto stimare quali ulteriori complessità, sforzi e costi aggiuntivi SSR rappresentano in modo realistico per il progetto, inclusa la manutenzione a lungo termine. Un’architettura SSR dovrebbe essere scelta solo quando il valore aggiunto supera chiaramente i costi stimati.

In genere, SSR fornisce un valore quando è presente un "sì" chiaro a una delle seguenti domande:

• SEO: SSR è ancora necessario per la corretta indicizzazione del sito da parte dei motori di ricerca che generano traffico? Tieni presente che i crawler del motore di ricerca principale ora valutano JS.
• Velocità pagina: SSR fornisce un miglioramento della velocità misurabile in ambienti reali e contribuisce all'esperienza complessiva dell'utente?

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, parte di App Builder.

Adobe I/O Runtime

Se sono certi che il tuo progetto richieda l'implementazione di SSR, la soluzione consigliata da Adobe è l’utilizzo di Adobe I/O Runtime.

Per ulteriori informazioni su Adobe I/O Runtime, vedi:

• https://developer.adobe.com/runtime : panoramica della funzione Runtime di App Builder
• https://developer.adobe.com/app-builder - per informazioni dettagliate sul prodotto App Builder completo
• https://developer.adobe.com/runtime/docs/ - documentazione dettagliata

Le sezioni seguenti descrivono come Adobe I/O Runtime può essere utilizzato per implementare SSR per l’SPA in due modelli diversi:

• Flusso di comunicazione basato sull’AEM
• Flusso di comunicazione basato su Adobe I/O Runtime

Configurazione Remote Renderer

L’AEM deve sapere dove è possibile recuperare il contenuto renderizzato in remoto. Indipendentemente da il modello che si sceglie di implementare per SSR, specificare a AEM come accedere a questo servizio di rendering remoto.

Il servizio viene fornito tramite RemoteContentRenderer - Servizio OSGi di Configuration Factory. Cerca la stringa "RemoteContentRenderer" nella console di configurazione della console Web all'indirizzo http://<host>:<port>/system/console/configMgr.

Per la configurazione sono disponibili i seguenti campi:

• Schema percorso contenuto : espressione regolare che corrisponde a una parte del contenuto, se necessario
• URL endpoint remoto : URL dell’endpoint responsabile della generazione del contenuto
  • Utilizza il protocollo HTTPS protetto se non si trova nella rete locale.
• Intestazioni di richiesta aggiuntive - Intestazioni aggiuntive da aggiungere alla richiesta inviata all’endpoint remoto
  • Pattern: key=value
• Timeout richiesta - Timeout della richiesta dell'host remoto in millisecondi

Flusso di comunicazione basato sull’AEM

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

1. Il browser richiede il contenuto SSR all’AEM.
2. L'AEM pubblica il modello su Adobe I/O Runtime.
3. Adobe I/O Runtime restituisce il contenuto generato.
4. AEM fornisce le HTML restituite da Adobe I/O Runtime tramite il modello HTL del componente pagina back-end.

Flusso di comunicazione basato su Adobe I/O Runtime

La sezione precedente descrive l’implementazione standard e consigliata del rendering lato server per quanto riguarda l’SPA nell’AEM, in cui l’AEM esegue il bootstrapping e la distribuzione dei contenuti.

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

Entrambi i modelli sono validi e supportati dall’AEM. Tuttavia, si dovrebbero considerare i vantaggi e gli svantaggi di ciascuno prima di implementare un particolare modello.

Pianificazione per SSR

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

Se stai valutando l’implementazione del rendering lato server per l’SPA, controlla quali parti dell’app sono necessarie.

Sviluppo di un SPA utilizzando la SSR

Il rendering dei componenti SPA poteva essere eseguito dal client (nel browser) o dal lato server. Quando viene eseguito il rendering lato server, le proprietà del browser come le dimensioni della finestra e la posizione non sono presenti. Pertanto, i componenti dell’SPA devono essere isomorfi, senza supporre dove vengono resi.

Per utilizzare SSR, devi distribuire il codice in AEM e su Adobe I/O Runtime, che è responsabile del rendering lato server. La maggior parte del codice è lo stesso, tuttavia le attività specifiche del server differiscono.

SSR per l’SPA nell’AEM

La SSR per l’SPA nell’AEM richiede Adobe I/O Runtime, che è chiamato per il rendering del lato 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.

Proprio come l’AEM supporta i framework SPA Angular e React pronti all’uso, è supportato anche il rendering lato server, ad Angular per le app React. Per ulteriori dettagli, consulta la documentazione NPM per entrambi i framework.

Rendering contenuto remoto

Il Configurazione rendering contenuto remoto che è necessario per utilizzare SSR con il tuo SPA in AEM si inserisce in un servizio di rendering più generalizzato che può essere esteso e personalizzato per soddisfare le tue esigenze.

Servizio RemoteContentRendering

RemoteContentRenderingService Un servizio OSGi per recuperare il contenuto di cui è stato eseguito il rendering 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 inserito tramite inversione delle dipendenze in un modello Sling personalizzato o in un servlet quando è necessaria un’ulteriore manipolazione del contenuto.

Questo servizio è utilizzato internamente da RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

Il RemoteContentRendererRequestHandlerServlet viene utilizzato per impostare a livello di programmazione la configurazione della richiesta. DefaultRemoteContentRendererRequestHandlerImpl, l’implementazione predefinita del gestore di richieste fornita, ti consente di creare più configurazioni OSGi in modo da poter mappare una posizione nella struttura del contenuto a un endpoint remoto.

Per aggiungere un gestore di richieste personalizzato, implementa RemoteContentRendererRequestHandler di rete. Assicurarsi di impostare Constants.SERVICE_RANKING proprietà del componente a un numero intero maggiore di 100, che corrisponde alla classificazione 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 rendering contenuto remoto.

Utilizzo di Remote Content Renderer

Richiedi a un servlet di recuperare e restituire parte del contenuto inserito nella pagina:

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

Di solito, il modello HTL di un componente pagina è il destinatario principale di tale funzione.

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

Requisiti

I servlet utilizzano Sling Model Exporter per serializzare i dati del componente. Per impostazione predefinita, entrambe le opzioni com.adobe.cq.export.json.ContainerExporter e com.adobe.cq.export.json.ComponentExporter sono supportati come adattatori del modello Sling. Se necessario, puoi aggiungere le classi a cui la richiesta deve essere adattata utilizzando RemoteContentRendererServlet e l'implementazione RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. Le classi aggiuntive devono estendere ComponentExporter.