SPA en rendering op de server

OPMERKING

De functie Editor (SPA) voor één pagina vereist AEM 6.4 servicepack 2 of hoger.

De SPA Redacteur is de geadviseerde oplossing voor projecten die SPA kader gebaseerde cliënt-zijteruggeven (b.v. Reageren of Angular) vereisen.

OPMERKING

AEM 6.4.5.0 of hoger is vereist om de SPA renderfuncties aan de serverzijde te kunnen gebruiken zoals in dit document wordt beschreven.

Overzicht

Toepassingen op één pagina (SPA) kunnen de gebruiker een rijke, dynamische ervaring bieden die op vertrouwde manieren reageert en zich gedraagt, vaak net als native toepassingen. Dit wordt bereikt door op de client te vertrouwen dat de inhoud op de voorgrond wordt geladen en vervolgens de interactie van de gebruiker intensief wordt afgehandeld en zo de hoeveelheid communicatie die nodig is tussen de client en de server tot een minimum te beperken, waardoor de app reactiever wordt.

Dit kan echter leiden tot langere laadtijden, vooral als de SPA groot en rijk is aan inhoud. Om de laadtijden te optimaliseren, kan een deel van de inhoud op de server worden gerenderd. Met SSR (serverside rendering) kunt u de eerste belasting van de pagina versnellen en vervolgens verdere rendering doorgeven aan de client.

Wanneer gebruikt u SSR

SSR is niet vereist voor alle projecten. Hoewel AEM volledig JS SSR voor SPA steunt, adviseert Adobe niet het systematisch voor elk project uit te voeren.

Wanneer u besluit SSR te implementeren, moet u eerst inschatten welke extra complexiteit, inspanning en kosten het toevoegen van SSR realistisch vertegenwoordigt voor het project, inclusief het langetermijnonderhoud. Een SSR-architectuur mag alleen worden gekozen wanneer de toegevoegde waarde duidelijk hoger is dan de geraamde kosten.

SSR verstrekt gewoonlijk één of andere waarde wanneer er duidelijk "ja"aan één van beiden van de volgende vragen is:

  • SEO: Is SSR eigenlijk nog vereist voor uw plaats om behoorlijk door de onderzoeksmotoren worden geïndexeerd die verkeer brengen? Vergeet niet dat de zoekmachine die als hoofdopzoekprogramma wordt gebruikt nu JS evalueert.
  • Paginasnelheid: Biedt SSR een meetbare snelheidsverbetering in levensechte omgevingen en vergroot de algehele gebruikerservaring?

Slechts wanneer één minstens één van deze twee vragen met duidelijk "ja"voor uw project wordt beantwoord adviseert Adobe het uitvoeren van SSR. In de volgende secties wordt beschreven hoe u dit kunt doen met Adobe I/O Runtime.

Adobe I/O Runtime

Als u erop vertrouwen dat uw project de implementatie van SSR vereist, Adobe aanbevolen voor gebruik door Adobe I/O Runtime.

Ga voor meer informatie over Adobe I/O Runtime naar

In de volgende secties wordt beschreven hoe Adobe I/O Runtime kan worden gebruikt om SSR voor uw SPA in twee verschillende modellen te implementeren:

OPMERKING

Adobe beveelt een aparte Adobe I/O Runtime-werkruimte aan per omgeving (werkgebied, proefperiode, testen, enz.). Dit staat voor typische patronen van de het levenscyclus van de systeemontwikkeling (SDLC) met verschillende versies van één enkele toepassing toe die aan verschillende milieu's worden opgesteld. Zie het document CI/CD voor de Toepassingen van de Vuurwerk van het Project voor meer informatie .

Er is geen aparte werkruimte nodig per instantie (auteur, publiceren), tenzij er verschillen zijn in de runtimplementatie per instantietype.

Configuratie renderfunctie voor externe inhoud

AEM moet weten waar de op afstand gerenderde inhoud kan worden opgehaald. Ongeacht of welk model u verkiest voor SSR uit te voeren, moet u opgeven hoe AEM toegang moet worden verkregen tot deze externe renderingsservice.

Dit gebeurt via de RemoteContentRenderer - Configuratie-fabriek OSGi-service. Zoek naar het koord "RemoteContentRenderer"in de console van de Configuratie van de Console van het Web bij http://<host>:<port>/system/console/configMgr.

De volgende velden zijn beschikbaar voor de configuratie:

  • Inhoudspatroon - Reguliere expressie, indien nodig, om overeen te komen met een deel van de inhoud
  • URL van extern eindpunt - URL van het eindpunt dat verantwoordelijk is voor het genereren van de inhoud
    • Gebruik het beveiligde HTTPS-protocol als dit zich niet in het lokale netwerk bevindt.
  • Aanvullende aanvraagheaders - Extra kopballen die aan het verzoek moeten worden toegevoegd dat naar het verre eindpunt wordt verzonden
    • Patroon: key=value
  • Verzoek om time-out - Time-out externe hostaanvraag in milliseconden
OPMERKING

Ongeacht of u ervoor kiest om het AEM-gestuurde communicatiestroom of de Adobe I/O Runtime-gestuurde stroommoet u een configuratie voor een externe inhoudrenderer definiëren.

Deze configuratie moet ook worden gedefinieerd als u ervoor kiest een aangepaste Node.js-server gebruiken.

OPMERKING

Deze configuratie gebruikt de Renderer voor externe inhoud, waarvoor aanvullende opties voor extensie en aanpassing beschikbaar zijn.

AEM-gestuurde communicatiestroom

Als u SSR gebruikt, wordt interactieworkflow voor componenten SPA in AEM omvat een fase waarin de initiële inhoud van de app door Adobe I/O Runtime wordt gegenereerd.

  1. De browser vraagt om de SSR-inhoud van AEM.
  2. AEM plaatst het model op Adobe I/O Runtime.
  3. Adobe I/O Runtime retourneert de gegenereerde inhoud
  4. AEM dient de HTML die door Adobe I/O Runtime wordt geretourneerd via de HTML-sjabloon van de achtergrondpagina-component.

server-side rendering-cms-drivenaemnode

Adobe I/O Runtime-gestuurde communicatiestroom

De sectie AEM-gestuurde communicatiestroom beschrijft de standaard en geadviseerde implementatie van server zijteruggeven met betrekking tot SPA in AEM, waar AEM de bootstrapping en het dienen van inhoud uitvoert.

Alternatief, kan SSR worden uitgevoerd zodat Adobe I/O Runtime voor bootstrapping verantwoordelijk is, effectief omkeerend de communicatie stroom.

Beide modellen zijn geldig en worden ondersteund door AEM. Men moet echter eerst de voor- en nadelen van elk model in overweging nemen voordat men een bepaald model toepast.

Bootstrapping Voordelen Nadelen
via AEM AEM beheert waar nodig injectiebibliotheken
De middelen hoeven alleen op AEM te worden gehandhaafd
Mogelijk niet bekend bij SPA ontwikkelaar
via Adobe I/O Runtime Meer bekend bij SPA ontwikkelaars Clientlib-bronnen die door de toepassing worden vereist, zoals CSS en JavaScript, moeten door de AEM ontwikkelaar beschikbaar worden gesteld via de allowProxy eigenschap
Bronnen moeten worden gesynchroniseerd tussen AEM en Adobe I/O Runtime
Om het ontwerpen van de SPA mogelijk te maken, is mogelijk een proxyserver voor Adobe I/O Runtime nodig

Planning voor SSR

Over het algemeen hoeft slechts een deel van een toepassing aan serverzijde te worden gerenderd. Het algemene voorbeeld is de inhoud die boven de voud wordt weergegeven wanneer de pagina voor het eerst wordt geladen en op de server moet worden weergegeven. Dit bespaart tijd door aan de cliënt, reeds teruggegeven inhoud te leveren. Terwijl de gebruiker met de SPA communiceert, wordt de extra inhoud door de client gerenderd.

Wanneer u rendering aan de serverzijde voor uw SPA implementeert, moet u controleren welke delen van de app SSR vereisen.

Een SPA ontwikkelen met behulp van SSR

SPA componenten kunnen door de client (in de browser) of de server worden gerenderd. Bij rendering op de server zijn browsereigenschappen zoals venstergrootte en -locatie niet aanwezig. Daarom moeten SPA componenten isomorf zijn, waarbij er geen aanname is over waar ze worden gerenderd.

Als u SSR wilt gebruiken, moet u uw code zowel in AEM als op Adobe I/O Runtime implementeren, die verantwoordelijk is voor de rendering aan de serverzijde. De meeste code zijn hetzelfde, maar serverspecifieke taken verschillen.

SSR voor SPA in AEM

SSR voor SPA in AEM vereist Adobe I/O Runtime, dat wordt opgeroepen voor het renderen van de zijde van de toepassingsinhoudsserver. Binnen de HTML van de app wordt een resource op Adobe I/O Runtime aangeroepen om de inhoud te renderen.

Net zoals AEM de Angular- en Reactie-SPA-frameworks buiten de box ondersteunt, wordt rendering aan de serverzijde ook ondersteund voor Angular- en React-apps. Zie de NPM documentatie voor beide kaders voor verdere details.

Voor een simplistisch voorbeeld, gelieve te verwijzen naar We.Retail Journal-app. Het rendert de volledige kant van de toepassingsserver. Hoewel dit geen echt voorbeeld is, toont het wat nodig is om SSR uit te voeren.

LET OP

De We.Retail Journal-app is alleen bedoeld voor demonstratiedoeleinden en gebruikt daarom Node.js als eenvoudig voorbeeld in plaats van de aanbevolen Adobe I/O Runtime. Dit voorbeeld zou niet voor om het even welk projectwerk moeten worden gebruikt.

OPMERKING

Elk AEM project moet Projectarchetype AEM, die SPA projecten met React of Angular steunt en hefboomwerkingen de SPA SDK.

Node.js gebruiken

Adobe I/O Runtime is de aanbevolen oplossing voor de implementatie van SSR voor SPA in AEM.

Voor on-premesis AEM instanties, is het ook mogelijk om SSR uit te voeren gebruikend een douaneinstantie Node.js op de zelfde manier zoals hierboven beschreven. Hoewel dit door Adobe wordt gesteund, wordt het niet geadviseerd.

Node.js wordt niet ondersteund voor door Adobe gehoste AEM instanties.

OPMERKING

Als SSR via Node.js moet worden geïmplementeerd, raadt Adobe een aparte instantie Node.js aan voor elke AEM omgeving (auteur, publicatie, werkgebied, enz.).

Renderer voor externe inhoud

De Configuratie renderfunctie voor externe inhoud die vereist is om SSR met uw SPA te gebruiken in AEM tikken op een meer algemene renderservice die kan worden uitgebreid en aangepast aan uw behoeften.

RemoteContentRenderingService

RemoteContentRenderingService is de dienst OSGi om inhoud terug te winnen die op een verre server, zoals van Adobe I/O wordt teruggegeven. De inhoud die naar de externe server wordt verzonden, is gebaseerd op de doorgegeven parameter request.

RemoteContentRenderingService kan door gebiedsinversie in of een douaneSling model of servlet worden geïnjecteerd wanneer de extra inhoudsmanipulatie wordt vereist.

Deze dienst wordt intern gebruikt door RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

De RemoteContentRendererRequestHandlerServlet kan worden gebruikt om programmatically de verzoekconfiguratie te plaatsen. DefaultRemoteContentRendererRequestHandlerImpl, staat de verstrekte implementatie van de standaardverzoekmanager, u toe om veelvoudige configuraties tot stand te brengen OSGi om een plaats in de inhoudsstructuur aan een ver eindpunt in kaart te brengen.

Om een manager van het douaneverzoek toe te voegen, voer uit RemoteContentRendererRequestHandler interface. Zorg ervoor dat u de Constants.SERVICE_RANKING componenteigenschap instellen op een geheel getal hoger dan 100. Dit is de positie van de component DefaultRemoteContentRendererRequestHandlerImpl.

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

Vorm de Configuratie OSGi van de Standaardmanager

De configuratie van de standaardmanager moet worden gevormd zoals die in de sectie wordt beschreven Configuratie renderfunctie voor externe inhoud.

Renderergebruik van externe inhoud

Om een servlet te hebben halen en wat inhoud terug te keren die in de pagina kan worden ingespoten:

  1. Controleer of uw externe server toegankelijk is.
  2. Voeg een van de volgende fragmenten toe aan de HTML-sjabloon van een AEM component.
  3. Naar keuze, creeer of wijzig de configuraties OSGi.
  4. Door de inhoud van uw site bladeren

Gewoonlijk is de HTML-sjabloon van een paginacomponent de belangrijkste ontvanger van een dergelijke functie.

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

Vereisten

De servers maken gebruik van de Sling Model Exporter om de componentgegevens te serialiseren. Standaard worden beide com.adobe.cq.export.json.ContainerExporter en com.adobe.cq.export.json.ComponentExporter worden ondersteund als Sling Model-adapters. Indien nodig kunt u klassen toevoegen waaraan de aanvraag moet worden aangepast om de opdracht RemoteContentRendererServlet en de uitvoering van de RemoteContentRendererRequestHandler#getSlingModelAdapterClasses. De extra klassen moeten de ComponentExporter.

Op deze pagina