SPA et rendu côté serveur (SSR)

Les applications monopages (SPA) peuvent offrir à la personne utilisatrice une expérience riche et dynamique qui réagit et se comporte de manière familière, souvent tout simplement comme une application native. Pour ce faire, le client ou la cliente doit charger le contenu à l’avance, puis effectuer la lourde tâche de gérer l’interaction utilisateur.. Ce processus minimise la quantité de communication nécessaire entre le client ou la cliente et le serveur, ce qui rend l’application plus réactive.

Toutefois, ce processus peut entraîner des temps de chargement initiaux plus longs, en particulier si la SPA est volumineuse et riche en contenu. Pour optimiser les temps de chargement, une partie du contenu peut être rendue côté serveur. L’utilisation du rendu côté serveur (SSR) peut accélérer le chargement initial de la page, puis transmettre plus de rendu au client ou à la cliente.

Quand utiliser le rendu côté serveur

Le rendu côté serveur n’est pas requis pour tous les projets. Bien qu’AEM prenne pleinement en charge le rendu côté serveur JS pour les SPA, Adobe ne recommande pas de le mettre en œuvre systématiquement pour chaque projet.

Lorsque vous décidez de mettre en œuvre le rendu côté serveur, vous devez d’abord estimer la complexité, les efforts et les coûts supplémentaires que ce rendu représente de manière réaliste pour le projet, y compris la maintenance à long terme. Une architecture SSR ne doit être choisie que lorsque la valeur ajoutée dépasse clairement les coûts estimés.

Le rendu côté serveur fournit habituellement une certaine valeur lorsque la réponse à l’une ou l’autre des questions suivantes est un « oui » clair :

• SEO : est-il toujours nécessaire d’utiliser le rendu côté serveur pour que votre site soit correctement indexé par les moteurs de recherche qui génèrent du trafic ? Gardez à l’esprit que les principaux robots de moteur de recherche évaluent désormais JS.
• Vitesse de la page : le rendu côté serveur améliore-t-il la vitesse de façon mesurable dans les environnements réels et ajoute-t-il à l’expérience globale de l’utilisateur ?

Adobe ne recommande la mise en œuvre du rendu côté serveur que si au moins l’une de ces deux questions reçoit une réponse « oui » claire pour votre projet. Les sections suivantes décrivent comment utiliser Adobe I/O Runtime, qui fait partie de App Builder.

Adobe I/O Runtime

Si vous êtes certain(e) que votre projet nécessite la mise en œuvre du rendu côté serveur, la solution recommandée par Adobe est d’utiliser Adobe I/O Runtime.

Pour plus d’informations sur Adobe I/O Runtime, consultez les informations suivantes :

• https://developer.adobe.com/runtime - pour une présentation de la fonction Exécution d’App Builder
• https://developer.adobe.com/app-builder - pour plus d’informations sur le produit App Builder complet
• https://developer.adobe.com/runtime/docs/ - pour une documentation détaillée

Les sections suivantes décrivent comment Adobe I/O Runtime peut être utilisé afin d’implémenter la technologie du rendu côté serveur pour votre SPA dans deux modèles différents :

• Flux de communication piloté par AEM
• Flux de communication piloté par Adobe I/O Runtime

Configuration du moteur de rendu distant

AEM doit savoir à quel emplacement le contenu rendu distant peut être récupéré. Quel que soit le modèle que vous choisissiez de mettre en œuvre pour le rendu côté serveur, vous devrez indiquer à AEM comment accéder à ce service de rendu distant.

Ce service est effectué au moyen de la fonction RemoteContentRenderer - service de configuration d’usine OSGi. Recherchez la chaîne « RemoteContentRenderer » dans la console de configuration de la console web à http://<host>:<port>/system/console/configMgr.

Les champs suivants sont disponibles pour la configuration :

• Modèle de chemin d’accès au contenu : expression régulière permettant de faire correspondre une partie du contenu, le cas échéant
• URL du point d’entrée distant : URL du point d’entrée responsable de la génération du contenu
  • Utilisez le protocole HTTPS sécurisé si ce point d’entrée ne figure pas sur le réseau local.
• En-têtes de requête supplémentaires : en-têtes supplémentaires à ajouter à la requête envoyée au point d’entrée distant
  • Modèle : key=value
• Délai d’expiration de la requête : délai d’expiration de la requête d’hôte distant en millisecondes

Flux de communication piloté par AEM

Avec le rendu côté serveur, le workflow d’interaction des composants des SPA d’AEM inclut une phase au cours de laquelle le contenu initial de l’application est généré dans Adobe I/O Runtime.

1. Le navigateur demande le contenu du rendu côté serveur à AEM.
2. AEM publie le modèle dans Adobe I/O Runtime.
3. Adobe I/O Runtime renvoie le contenu généré.
4. AEM traite le code HTML renvoyé par Adobe I/O Runtime via le modèle HTL du composant de page de serveur principal.

Flux de communication piloté par Adobe I/O Runtime

La section précédente décrit l’implémentation standard et recommandée du rendu côté serveur dans le cadre des SPA dans AEM, AEM se chargeant du démarrage et de la diffusion du contenu.

Une autre solution consiste à mettre en œuvre le rendu côté serveur de sorte qu’Adobe I/O Runtime soit responsable du démarrage, ce qui inverse le flux de communication.

Les deux modèles sont valides et pris en charge par AEM. Toutefois, il faut tenir compte des avantages et des inconvénients de chaque modèle avant de mettre en œuvre un modèle particulier.

Planification du rendu côté serveur

En règle générale, seule une partie d’une application doit être rendue côté serveur. L’exemple courant réside dans le contenu allant s’afficher au-dessus du pli lors du chargement initial de la page rendue côté serveur. Ce processus permet de gagner du temps en diffusant au cliente ou à la cliente le contenu déjà rendu. Lorsque l’utilisateur ou l’utilisatrice interagit avec la SPA, le contenu supplémentaire est rendu par le client.

Lorsque vous envisagez d’implémenter le rendu côté serveur pour votre SPA, passez en revue les parties de l’application qui sont nécessaires.

Développement d’une SPA avec le rendu côté serveur

Les composants SPA peuvent être rendus par le client (dans le navigateur) ou côté serveur. Lorsqu’ils sont rendus côté serveur, les propriétés du navigateur telles que la taille de fenêtre et l’emplacement ne sont pas présentes. Par conséquent, les composants SPA doivent être isomorphes, sans présumer de l’emplacement où ils sont rendus.

Pour utiliser le rendu côté serveur, vous devez déployer votre code dans AEM et sur Adobe I/O Runtime, qui est responsable du rendu côté serveur. Le code est majoritairement identique, mais les tâches spécifiques au serveur diffèrent.

Rendu côté serveur pour les SPA dans AEM

Le rendu côté serveur pour les SPA dans AEM nécessite Adobe I/O Runtime, qui est appelé pour le rendu côté serveur du contenu d’application. Dans le fichier HTL de l’application, une ressource d’Adobe I/O Runtime est appelée pour procéder au rendu du contenu.

Tout comme AEM prend en charge les frameworks SPA Angular et React clé en main, le rendu côté serveur est également pris en charge pour les applications Angular et React. Pour plus d’informations, consultez la documentation NPM relative aux deux frameworks.

Moteur de rendu de contenu distant

La configuration du moteur de rendu de contenu distant requise pour utiliser le rendu côté serveur avec votre SPA dans AEM exploite un service de rendu plus généralisé qui peut être étendu et personnalisé en fonction de vos besoins.

RemoteContentRenderingService

RemoteContentRenderingService Un service OSGi permettant de récupérer le contenu rendu sur un serveur distant, par exemple à partir d’Adobe I/O. Le contenu envoyé au serveur distant est basé sur le paramètre de requête transmis.

RemoteContentRenderingService Peut être injecté par inversion de dépendance dans un modèle Sling personnalisé ou un servlet lorsque des manipulations de contenu supplémentaires sont requises.

Ce service est utilisé en interne par le servlet RemoteContentRendererRequestHandlerServlet.

RemoteContentRendererRequestHandlerServlet

Le servlet RemoteContentRendererRequestHandlerServlet peut être utilisé pour définir la configuration de la requête par programmation. DefaultRemoteContentRendererRequestHandlerImpl, l’implémentation du gestionnaire de requêtes par défaut fournie, vous permet de créer plusieurs configurations OSGi afin de mapper un emplacement dans la structure de contenu à un point d’entrée distant.

Pour ajouter un gestionnaire de requêtes personnalisé, implémentez l’interface de RemoteContentRendererRequestHandler. Veillez à définir la propriété du composant Constants.SERVICE_RANKING sur un nombre entier supérieur à 100, qui correspond au classement du servlet DefaultRemoteContentRendererRequestHandlerImpl.

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

Établir la configuration OSGi du gestionnaire par défaut

La configuration du gestionnaire par défaut doit être établie comme décrit dans la section Configuration du moteur de rendu de contenu distant.

Utilisation du moteur de rendu de contenu distant

Pour qu’un servlet récupère et renvoie du contenu injecté dans la page :

1. Assurez-vous que votre serveur distant est accessible.
2. Ajoutez l’un des fragments de code suivants au modèle HTL d’un composant AEM.
3. Vous pouvez éventuellement créer ou modifier les configurations OSGi.
4. Parcourir le contenu de votre site.

En général, le modèle HTL d’un composant de page est le principal destinataire d’une telle fonctionnalité.

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

Conditions requises

Les servlets utilisent l’exportateur de modèle Sling pour sérialiser les données du composant. Par défaut, les composants com.adobe.cq.export.json.ContainerExporter et com.adobe.cq.export.json.ComponentExporter sont pris en charge en tant qu’adaptateurs de modèle Sling. Si nécessaire, vous pouvez ajouter des classes auxquelles la requête doit être adaptée à l’aide du composant RemoteContentRendererServlet et en mettant le composant RemoteContentRendererRequestHandler#getSlingModelAdapterClasses en œuvre. Les classes supplémentaires doivent étendre le composant ComponentExporter.