SPA en rendering op de server spa-and-server-side-rendering

Overzicht overview

Toepassingen op één pagina (SPA) kunnen de gebruiker een rijke, dynamische ervaring bieden die op vertrouwde manieren reageert en zich gedraagt, vaak net als een native toepassing. dit wordt bereikt door op de cliënt te vertrouwen om de inhoud te laden vooraan en dan het zware heffen van de behandeling van gebruikersinteractiete doen en zo de hoeveelheid communicatie nodig tussen de cliënt en de server te minimaliseren, makend app reactiever.

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 weergegeven. Met SSR (Server-Side Rendering) kunt u de eerste belasting van de pagina versnellen en vervolgens verdere rendering doorgeven aan de client.

Wanneer gebruikt u SSR when-to-use-ssr

SSR is niet vereist voor alle projecten. Hoewel AEM volledig JS SSR voor SPA steunt, beveelt de Adobe niet aan 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:

Slechts wanneer minstens één van deze twee vragen met duidelijk "ja"voor uw project wordt beantwoord adviseert de 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 adobe-i-o-runtime

Als u zeker bent dat uw project de implementatie van SSRvereist, is de geadviseerde oplossing van de Adobe Adobe I/O Runtime te gebruiken.

Raadpleeg de volgende secties voor meer informatie over Adobe I/O Runtime:

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:

Configuratie van externe renderer remote-renderer-configuration

AEM moet weten waar de op afstand gerenderde inhoud kan worden opgehaald. Ongeacht welk model u verkiest om voor SSR uit te voeren,, moet u specificeren om te AEM hoe te om tot deze verre teruggevende dienst toegang te hebben.

Dit wordt gedaan via de RemoteContentRenderer - de dienst van OSGi van de Fabriek van de Configuratie. 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:

AEM-gestuurde communicatiestroom aem-driven-communication-flow

Wanneer het gebruiken van SSR, omvat het werkschema van de componenteninteractievan SPA in AEM een fase waarin de aanvankelijke inhoud van app op Adobe I/O Runtime wordt geproduceerd.

Adobe I/O Runtime-gestuurde communicatiestroom adobe-i-o-runtime-driven-communication-flow

In de vorige sectie worden de standaard en aanbevolen implementatie beschreven van rendering op de server met betrekking tot SPA in AEM, waarbij AEM de overvulling en het serveren 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.

Planning voor SSR planning-for-ssr

Slechts een deel van een toepassing moet serverzijde worden teruggegeven. Het algemene voorbeeld is de inhoud die boven de voud wordt weergegeven bij de eerste keer dat de pagina wordt geladen, wordt weergegeven op de server. 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 op de server wilt implementeren voor uw SPA, moet u controleren welke delen van de app u nodig hebt.

Een SPA ontwikkelen met behulp van SSR developing-an-spa-using-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, implementeert u uw code in AEM en op Adobe I/O Runtime, die verantwoordelijk is voor de rendering op de server. De meeste code zijn hetzelfde, maar serverspecifieke taken verschillen.

SSR voor SPA in AEM ssr-for-spas-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 op de server ook ondersteund voor Angular- en Reactie-apps. Zie de NPM documentatie voor beide kaders voor verdere details.

Voor een simplistisch voorbeeld, zie Wij.Retail app van het Dagboek. Het rendert de volledige kant van de toepassingsserver. Hoewel dit geen echt voorbeeld is, toont het wel wat nodig is om SSR uit te voeren.

Node.js gebruiken using-node-js

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.

Renderer voor externe inhoud remote-content-renderer

De Verre Configuratie van Renderer van de Inhouddie wordt vereist om SSR met uw SPA in AEM tikken in een meer algemene het teruggeven dienst te gebruiken die kan worden uitgebreid en worden aangepast om aan uw behoeften te voldoen.

RemoteContentRenderingService 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 worden geïnjecteerd door afhankelijkheid in een aangepast Sling-model of servlet wanneer aanvullende inhoudsmanipulatie vereist is.

Deze dienst wordt intern gebruikt door RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet remotecontentrendererrequesthandlerservlet

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

Implementeer de interface RemoteContentRendererRequestHandler om een aangepaste aanvraaghandler toe te voegen. U moet de componenteigenschap Constants.SERVICE_RANKING instellen op een geheel getal dat groter is dan 100. Dit is de positie van de 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 configure-default-handler

De configuratie van de standaardmanager moet worden gevormd zoals die in de sectie Verre Configuratie van de Renderer van de Inhoudwordt beschreven.

Renderergebruik van externe inhoud usage

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

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 requirements

De servlets gebruiken de Verschuivende ModelExporter om de componentengegevens in series te vervaardigen. Standaard worden zowel com.adobe.cq.export.json.ContainerExporter als com.adobe.cq.export.json.ComponentExporter ondersteund als Sling Model-adapters. Indien nodig, kunt u klassen toevoegen die de aanvraag moet worden aangepast aan het gebruik van RemoteContentRendererServlet en het implementeren van RemoteContentRendererRequestHandler#getSlingModelAdapterClasses . De extra klassen moeten ComponentExporter uitbreiden.