Single Page Applications (SPAs) und Server-seitiges Rendering

Überblick

Einzelseiten-Apps (SPA) bieten dem Benutzer umfassende, dynamische Erlebnisse, die auf vertraute Weise reagieren und sich verhalten, oft genau wie native Anwendungen. Dies wird erreicht, indem man sich darauf verlässt, dass der Client den Inhalt im Voraus lädt und dann die Benutzerinteraktion erheblich erleichtert und so den Kommunikationsaufwand zwischen Client und Server minimiert, wodurch die App reaktionsfähiger wird.

Dies kann jedoch zu längeren anfänglichen Ladezeiten führen, insbesondere wenn die SPA groß und inhaltsreich ist. Um die Ladezeit zu optimieren, können einige Inhalte Server-seitig gerendert werden. Die Verwendung von Server-seitigem Rendering (SSR) kann das anfängliche Laden der Seite beschleunigen und dann das weitere Rendering an den Client weitergeben.

Verwendung von SSR

SSR ist nicht bei allen Projekten erforderlich. Obwohl JS SSR für SPAs von AEM voll unterstützt wird, empfiehlt Adobe nicht, sie systematisch für jedes Projekt zu implementieren.

Wenn Sie sich für die Implementierung von SSR entscheiden, müssen Sie zunächst abschätzen, welche zusätzliche Komplexität, welchen Aufwand und welche Kosten das Hinzufügen von SSR für das Projekt realistisch darstellt, einschließlich der langfristigen Wartung. Eine SSR-Architektur sollte nur dann gewählt werden, wenn der Mehrwert die geschätzten Kosten deutlich übersteigt.

SSR bietet in der Regel einen gewissen Mehrwert, wenn eine der folgenden Fragen klar mit Ja beantwortet werden kann:

• SEO: Ist SSR tatsächlich noch erforderlich, damit Ihre Website von den Suchmaschinen, die Traffic bringen, richtig indiziert wird? Denken Sie daran, dass die wichtigsten Suchmaschinen-Crawler jetzt JS auswerten.
• Seitengeschwindigkeit: Bietet SSR eine messbare Geschwindigkeitsverbesserung in Echtzeit-Umgebungen? Steigert SSR das Kundenerlebnis insgesamt?

Nur wenn mindestens eine dieser beiden Fragen mit einem klaren Ja für Ihr Projekt beantwortet wird, empfiehlt Adobe die Implementierung von SSR. In den folgenden Abschnitten wird beschrieben, wie Sie dies mit Adobe I/O Runtime erreichen.

Adobe I/O Runtime

Wenn Sie sicher sind, dass Ihr Projekt die Implementierung von SSR erfordert, empfiehlt die Adobe die Verwendung von Adobe I/O Runtime.

Weitere Informationen zu Adobe I/O Runtime finden Sie unter

• https://www.adobe.io/apis/experienceplatform/runtime.html – Überblick über den Service
• https://www.adobe.io/apis/experienceplatform/runtime/docs.html – ausführliche Dokumentation der Plattform.

In den folgenden Abschnitten wird erläutert, wie Sie mit Adobe I/O Runtime SSR für Ihre SPA in zwei verschiedenen Modellen implementieren können:

• AEM-gesteuerter Kommunikationsfluss
• Adobe I/O Runtime-gesteuerter Kommunikationsfluss

Remote Content Renderer-Konfiguration

AEM muss wissen, wo der Remote-gerenderte Inhalt abgerufen werden kann. Unabhängig von Welches Modell Sie für SSR implementieren möchten, müssen Sie angeben, wie Sie auf diesen Remote Rendering-Dienst AEM.

Dies geschieht über den ​​RemoteContentRenderer – Configuration Factory OSGi-Service. Suchen Sie in der Konsole „Web-Konsolen-Konfiguration“ unter http://<host>:<port>/system/console/configMgr nach der Zeichenfolge „RemoteContentRenderer“.

Folgende Felder stehen für die Konfiguration zur Verfügung:

• Inhaltspfadmuster: Regulärer Ausdruck, um bei Bedarf einen Inhaltsbereich zuzuordnen
• Remote-Endpunkt-URL: URL des Endpunkts, der für die Erstellung des Inhalts verantwortlich ist
  • Verwenden Sie das gesicherte HTTPS-Protokoll, wenn Sie sich nicht im lokalen Netzwerk befinden.
• Zusätzliche Anfrage-Header: Zusätzliche Header, die der an den Remote-Endpunkt gesendeten Anfrage hinzugefügt werden.
  • Muster: key=value
• Zeitüberschreitung bei Anfrage: Zeitüberschreitung bei Remote-Host-Anfragen in Millisekunden

AEM-gesteuerter Kommunikationsfluss

Bei der Verwendung von SSR umfasst der Workflow für die Komponenteninteraktion von SPA in AEM eine Phase, in der der anfängliche Inhalt der App von Adobe I/O Runtime generiert wird.

1. Der Browser fordert den SSR-Inhalt von AEM an.
2. AEM sendet das Modell an Adobe I/O Runtime.
3. Adobe I/O Runtime gibt den generierten Inhalt zurück
4. AEM stellt den von Adobe I/O Runtime über die HTML-Vorlage der Backend-Seitenkomponente zurückgegebenen HTML-Code bereit.

Adobe I/O Runtime-gesteuerter Kommunikationsfluss

Im Abschnitt AEM-gesteuerter Kommunikationsfluss wird die standardmäßige und empfohlene Implementierung des Server-seitigen Renderings in Bezug auf SPA in AEM beschrieben, wo AEM das Bootstrapping und die Bereitstellung von Inhalten durchführt.

Alternativ kann SSR so implementiert werden, dass Adobe I/O Runtime für das Bootstrapping verantwortlich ist, wodurch der Kommunikationsfluss effektiv umgekehrt wird.

Beide Modelle sind gültig und werden von AEM unterstützt. Vor der Einführung eines bestimmten Modells sollten jedoch die Vor- und Nachteile jedes einzelnen Modells berücksichtigt werden.

Planung für SSR

Im Allgemeinen muss nur ein Teil einer Anwendung Server-seitig gerendert werden. Das häufigste Beispiel ist, dass der Inhalt, der beim ersten Laden der Seite über der Kante angezeigt wird, serverseitig gerendert werden muss. Das spart Zeit, indem bereits gerenderte Inhalte an den Client gesendet werden. Wenn der Benutzer mit der SPA interagiert, wird der zusätzliche Inhalt vom Client gerendert.

Wenn Sie erwägen, das serverseitige Rendering für Ihre SPA zu implementieren, müssen Sie überprüfen, welche Teile der App SSR erfordern.

Entwickeln einer SPA mit SSR

SPA-Komponenten können vom Client (im Browser) oder vom Server gerendert werden. Beim Server-seitigen Rendern sind keine Browser-Eigenschaften wie Fenstergröße und -position vorhanden. Daher sollten SPA-Komponenten isomorph sein und keine Annahme darüber machen, wo sie gerendert werden.

Um SSR zu nutzen, müssen Sie Ihren Code sowohl in AEM als auch in Adobe I/O Runtime bereitstellen, das für das Server-seitige Rendering verantwortlich ist. Der größte Teil des Codes ist gleich, jedoch unterscheiden sich die Server-spezifischen Aufgaben.

SSR für SPAs in AEM

SSR für SPAs in AEM erfordert Adobe I/O Runtime, das für das Rendering des App-Inhalts auf der Server-Seite aufgerufen wird. Innerhalb der HTL der App wird eine Ressource in Adobe I/O Runtime aufgerufen, um den Inhalt zu rendern.

So wie AEM die SPA-Frameworks Angular und React standardmäßig unterstützt, wird auch das Server-seitige Rendering für Angular- und React-Anwendungen unterstützt. Weitere Informationen finden Sie in der NPM-Dokumentation für beide Frameworks.

• React: https://github.com/adobe/aem-sample-we-retail-journal/blob/master/react-app/DEVELOPMENT.md#enabling-the-server-side-rendering-using-the-aem-page-component
• Angular: https://github.com/adobe/aem-sample-we-retail-journal/blob/master/react-app/DEVELOPMENT.md#enabling-the-server-side-rendering-using-the-aem-page-component

Ein einfaches Beispiel finden Sie in der We.Retail Journal-App. Es wird die gesamte Anwendungsserverseite gerendert. Dies ist zwar kein reales Beispiel, zeigt aber, was zur Umsetzung der SSR erforderlich ist.

Verwenden von Node.js

Adobe I/O Runtime ist die empfohlene Lösung für die Implementierung von SSR für SPA in AEM.

Bei On-Premesis-AEM-Instanzen ist es auch möglich, SSR mit einer benutzerdefinierten Node.js-Instanz wie oben beschrieben zu implementieren. Obwohl dies von Adobe unterstützt wird, wird dies nicht empfohlen.

Node.js wird für Adobe-gehostete AEM nicht unterstützt.

Remote Content Renderer

Die Remote Content Renderer-Konfiguration, die für die Verwendung von SSR mit Ihrer SPA in AEM erforderlich ist, greift auf einen allgemeineren Rendering-Service zurück, der erweitert und an Ihre Bedürfnisse angepasst werden kann.

RemoteContentRenderingService

RemoteContentRenderingService ist ein OSGi-Service zum Abrufen von Inhalten, die auf einem Remote-Server wiedergegeben werden, z. B. von Adobe I/O. Der an den Remote-Server gesendete Inhalt basiert auf dem übergebenen Anfrageparameter.

RemoteContentRenderingService kann durch Umkehrung der Abhängigkeit entweder in ein benutzerdefiniertes Sling-Modell oder Servlet eingefügt werden, wenn zusätzliche Inhaltsmanipulationen erforderlich sind.

Dieser Service wird intern vom RemoteContentRendererRequestHandlerServlet verwendet.

RemoteContentRendererRequestHandlerServlet

Mit dem RemoteContentRendererRequestHandlerServlet können Sie die Anfragekonfiguration programmgesteuert einstellen. DefaultRemoteContentRendererRequestHandlerImpl, die bereitgestellte standardmäßige Implementierung des Anfrage-Handlers, ermöglicht es Ihnen, mehrere OSGi-Konfigurationen zu erstellen, um einen Punkt in der Inhaltsstruktur einem Remote-Endpunkt zuzuordnen.

Implementieren Sie die RemoteContentRendererRequestHandler-Schnittstelle, um einen benutzerdefinierten Anfrage-Handler hinzuzufügen. Stellen Sie sicher, dass die Komponenteneigenschaft Constants.SERVICE_RANKING auf eine ganze Zahl größer als 100 gesetzt wird, was der Rangfolge von DefaultRemoteContentRendererRequestHandlerImpl entspricht.

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

Konfigurieren der OSGi-Konfiguration des Standard-Handlers

Die Konfiguration des Standard-Handlers muss wie im Abschnitt Remote Content Renderer-Konfiguration beschrieben konfiguriert werden.

Verwendung des Remote Content Renderers

So lassen Sie ein Servlet Inhalte abrufen und zurückgeben, die in die Seite eingefügt werden können:

1. Stellen Sie sicher, dass auf den Remote-Server zugegriffen werden kann.
2. Fügen Sie der HTL-Vorlage einer AEM-Komponente eines der folgenden Snippets hinzu.
3. Optional können Sie die OSGi-Konfigurationen erstellen oder ändern.
4. Durchsuchen Sie den Inhalt Ihrer Site.

In der Regel ist die HTL-Vorlage einer Seitenkomponente der wichtigste Empfänger einer solchen Funktion.

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

Voraussetzungen

Die Servlets verwenden den Sling Model Exporter, um die Komponentendaten zu serialisieren. Standardmäßig werden sowohl com.adobe.cq.export.json.ContainerExporter als auch com.adobe.cq.export.json.ComponentExporter als Sling-Modell-Adapter unterstützt. Bei Bedarf können Sie Klassen hinzufügen, an die die Anfrage angepasst werden soll, um das RemoteContentRendererServlet zu verwenden und das RemoteContentRendererRequestHandler#getSlingModelAdapterClasses zu implementieren. Die zusätzlichen Klassen müssen den ComponentExporter erweitern.