DocumentationAEM 6.4Guide de développement

Présentation de l’éditeur de SPA spa-editor-overview

Last update: Thu May 04 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Créé pour :

  • Developer
CAUTION
AEM 6.4 a atteint la fin de la prise en charge étendue et cette documentation n’est plus mise à jour. Pour plus d’informations, voir notre période de support technique. Rechercher les versions prises en charge here.

Les applications monopage (SPA) peuvent améliorer considérablement votre expérience des sites web. Les développeurs souhaitent pouvoir créer des sites à l’aide de structures SPA et les auteurs souhaitent modifier facilement du contenu dans AEM pour un site créé à l’aide de ces structures.

L’éditeur de SPA constitue une solution complète pour la prise en charge des SPA dans AEM. Cette page donne une vue d’ensemble de la structure de la prise en charge SPA dans AEM, du fonctionnement de l’Éditeur d’Adobe, ainsi que de la manière dont la structure de et l’ se synchronisent.

NOTE
La fonction Éditeur d’application sur une seule page (SPA) nécessite AEM 6.4 Service Pack 2 ou plus récent.
L’éditeur de SPA est la solution recommandée pour les projets nécessitant un rendu côté client basé sur un framework de SPA (par exemple React ou Angular).

Présentation introduction

Les sites créés à l’aide de frameworks SPA courantes, telles que React et AngularJS, chargent leur contenu via le format JSON dynamique et ne fournissent pas le framework HTML dont l’éditeur de page AEM a besoin pour passer des commandes de modification.

Pour activer la modification d’applications sur une seule page dans AEM, il faut qu’il y ait une correspondance entre la sortie JSON de l’application et le modèle de contenu dans le répertoire AEM afin d’enregistrer les modifications apportées au contenu.

La prise en charge des applications sur une seule page dans AEM s’accompagne d’une fine couche JS qui interagit avec le code JS de l’application lorsqu’elle est chargée dans l’éditeur de pages avec lequel des événements peuvent être envoyés. L’emplacement des commandes d’édition peut être activé pour permettre une modification en contexte. Cette fonction repose sur le concept de point d’entrée de l’API Content Services, étant donné que le contenu de l’application sur une seule page doit être chargé par le biais de Content Services.

Pour plus d’informations sur SPA dans AEM, consultez les documents suivants :

Conception design

Le composant de page d’une application sur une seule page ne fournit pas les composants HTML de ses composants enfants via le fichier HTL ou JSP. Cette opération est déléguée à la structure SPA. La représentation du modèle ou des composants enfants est récupérée en tant que structure de données JSON à partir du JCR. Les composants SPA sont ensuite ajoutés à la page en fonction de cette structure. Ce comportement différencie la composition initiale du corps du composant de page de ses équivalents non SPA.

Gestion du modèle de page page-model-management

La résolution et la gestion du modèle de page sont déléguées à une bibliothèque PageModel fournie à cet effet. La SPA doit utiliser la bibliothèque de modèle de page pour pouvoir être initialisée et créée par l’éditeur de SPA. La bibliothèque de modèle de page est fournie indirectement au composant de page AEM via le npm aem-react-editable-components. Le modèle de page est un interpréteur entre AEM et la SPA. Il doit donc être toujours présent. Lorsque la page est créée, une bibliothèque supplémentaire cq.authoring.pagemodel.messaging doit être ajoutée afin de permettre la communication avec l’éditeur de page.

Si le composant de page SPA hérite du composant principal de la page, deux options sont possibles pour faire en sorte que la catégorie de la bibliothèque cliente cq.authoring.pagemodel.messaging soit disponible :

  • Si le modèle est modifiable, ajoutez-le à la stratégie de page.
  • Vous pouvez également ajouter les catégories via customfooterlibs.html.

Pour chaque ressource du modèle exporté, la SPA mappe un composant réel qui effectue l’opération
rendu. Le modèle, représenté sous la forme JSON, est ensuite rendu à l’aide des mappages de composants dans un conteneur.
screen_shot_2018-08-20at144152

CAUTION
L’inclusion de la catégorie cq.authoring.pagemodel.messaging doit être limitée au contexte de l’éditeur de SPA.

Type de données de communication communication-data-type

Lorsque la catégorie cq.authoring.pagemodel.messaging est ajoutée à la page, elle envoie un message à l’éditeur de page afin de créer un type de données de communication JSON. Lorsque le type de données de communication est défini sur JSON, les demandes de GET communiquent avec les points d’extrémité du modèle Sling d’un composant. À la suite d’une mise à jour dans l’éditeur de page, la représentation JSON du composant mis à jour est envoyée à la bibliothèque modèle de page. Celle-ci informe ensuite l’application sur une seule page des mises à jour.

screen_shot_2018-08-20at143628

Workflow workflow

Pour vous représenter le flux de l’interaction entre une SPA et AEM, vous pouvez considérer l’éditeur de SPA comme un intermédiaire entre les deux.

  • La communication entre l’éditeur de page et le SPA est effectuée à l’aide de JSON au lieu de HTML.
  • L’éditeur de page fournit la dernière version du modèle de page à l’application sur une seule page par le biais de l’API de messagerie et de l’iFrame.
  • Le gestionnaire de modèles de page informe l’éditeur qu’il est prêt à être modifié et transmet le modèle de page sous la forme d’une structure JSON.
  • L’éditeur ne modifie pas la structure DOM de la page en cours de création ; en fait, il n’y accède même pas. Au lieu de cela, il fournit le modèle de page le plus récent.

screen_shot_2018-08-20at144324

Workflow de base de l’éditeur de SPA basic-spa-editor-workflow

En gardant à l’esprit les éléments clés de l’éditeur de SPA, le workflow général de modification d’une SPA dans AEM apparaît comme suit pour l’auteur.

untitled1

  1. L’éditeur de SPA est chargé.

  2. La SPA est chargée dans un cadre distinct.

  3. La SPA demande du contenu JSON et effectue le rendu des composants côté client.

  4. L’éditeur de SPA détecte les composants rendus et génère des incrustations.

  5. L’auteur clique sur l’incrustation et affiche la barre d’outils de modification du composant.

  6. L’éditeur de SPA conserve les modifications avec une requête POST envoyée au serveur.

  7. L’éditeur de SPA demande le JSON mis à jour, qui est envoyé à la SPA avec un événement DOM.

  8. La SPA restitue à nouveau le composant concerné en mettant à jour son DOM.

NOTE
À retenir :
  • La SPA est toujours responsable de son affichage.
  • L’éditeur de SPA est isolé de la SPA elle-même.
  • En cours de production (publication), l’éditeur de SPA n’est jamais chargé.

Workflow d’édition de pages client-serveur client-server-page-editing-workflow

Cette section donne un aperçu plus détaillé de l’interaction client-serveur lors de l’édition d’une SPA.

page_editor_spa_authoringmediator-2

  1. La SPA s’initialise et demande le modèle auprès de l’exportateur de modèle Sling.

  2. À son tour, l’exportateur demande au référentiel les ressources qui composent la page.

  3. Le référentiel renvoie alors les ressources demandées.

  4. L’exportateur de modèle Sling renvoie le modèle de la page.

  5. La SPA instancie ses composants sur la base du modèle de page.

  6. 6a Le contenu informe l’éditeur qu’il est prêt pour la création.

    6b L’éditeur de page demande les configurations de création de composants.

    6c L’éditeur de page reçoit les configurations de composant.

  7. Lorsque l’auteur modifie un composant, l’éditeur de page envoie une demande de modification au servlet POST par défaut.

  8. La ressource est mise à jour dans le référentiel.

  9. La ressource mise à jour est fournie au servlet POST.

  10. Le servlet POST par défaut informe l’éditeur de page que la ressource a été mise à jour.

  11. L’éditeur de page demande le nouveau modèle de page.

  12. Les ressources qui composent la page font l’objet d’une demande auprès du référentiel.

  13. Les ressources qui composent la page sont fournies à l’exportateur de modèle Sling par le référentiel.

  14. Le modèle de page mis à jour est renvoyé à l’éditeur.

  15. L’éditeur de page met à jour la référence de modèle de page de l’application sur une seule page.

  16. La SPA met à jour ses composants en fonction de la nouvelle référence de modèle de page.

  17. Les configurations de composant des éditeurs de page sont mises à jour.

    17a La SPA signale à l’éditeur de page que le contenu est prêt.

    17b L’éditeur de page fournit les configurations de composant à l’application sur une seule page.

    17c La SPA fournit des configurations de composant mises à jour.

Workflow de création authoring-workflow

Il s’agit d’un aperçu plus détaillé axé sur l’expérience de création.

spa_content_authoringmodel

  1. La SPA récupère le modèle de page.

  2. 2a Le modèle de page fournit à l’éditeur les données requises pour la création.

    2b Une fois informé, l’orchestrateur de composants met à jour la structure de contenu de la page.

  3. L’orchestrateur de composants interroge le mappage entre le type de ressource AEM et un composant SPA.

  4. L’orchestrateur de composants instancie, de manière dynamique, le composant SPA sur la base du mappage entre le modèle de page et le composant.

  5. L’éditeur de page met à jour le modèle de page.

  6. 6a Le modèle de page fournit des données de création mises à jour à l’éditeur de page.

    6b Le modèle de page distribue les modifications à l’orchestrateur de composants.

  7. L’orchestrateur de composants récupère le mappage de composant.

  8. L’orchestrateur de composants met à jour le contenu de la page.

  9. Une fois que la SPA a terminé la mise à jour du contenu de la page, l’éditeur de page charge l’environnement de création.

Conditions requises et restrictions requirements-limitations

Pour permettre à l’auteur d’utiliser l’éditeur de page afin de modifier le contenu d’une SPA, l’application d’une seule page doit être mise en œuvre pour interagir avec le SDK de l’éditeur de SPA d’AEM. Consultez le document Prise en main des SPA dans AEM afin de disposer des informations minimales nécessaires pour faire fonctionner la vôtre.

Frameworks pris en charge supported-frameworks

Le SDK de l’éditeur de SPA prend en charge les versions minimales suivantes :

  • React 16.x et supérieures
  • Angular 6.x et supérieures

Les versions précédentes de ces frameworks peuvent fonctionner avec le SDK de l’éditeur de SPA d’AEM, mais ne sont pas prises en charge.

Autres frameworks additional-frameworks

Il est possible de mettre en œuvre des frameworks SPA pour utiliser le SDK de l’éditeur de SPA d’AEM. Consultez le document Plan directeur d’applications sur une seule page (SPA) pour connaître les exigences qu’un framework doit satisfaire afin de créer une couche spécifique composée des modules, composants et services nécessaires avec l’éditeur de SPA d’AEM.

Utilisation de plusieurs sélecteurs multiple-selectors

Il est possible de définir et personnaliser d’autres sélecteurs dans le cadre d’une SPA développée pour le SDK de l’éditeur de SPA d’AEM. Toutefois, cette prise en charge nécessite que le sélecteur model soit le premier et que l’extension soit .json conformément aux exigences de l’exportateur JSON.

Exigences relatives à l’éditeur de texte text-editor-requirements

Si vous souhaitez utiliser l’éditeur statique d’un composant de texte créé dans une SPA, une configuration supplémentaire est nécessaire.

  1. Définissez un attribut (arbitraire) dans l’élément wrapper de conteneur incluant le texte HTML. Dans le cas du contenu d’exemple Journal WKND, il s’agit d’un élément <div> et le sélecteur qui a été utilisé est data-rte-editelement.
  2. Définissez la propriété editElementQuery sur la configuration cq:InplaceEditingConfig du composant de texte AEM correspondant qui pointe vers ce sélecteur, par exemple data-rte-editelement. L’éditeur sait ainsi quel élément HTML encapsule le texte HTML.

Pour obtenir un exemple de la façon dont cela est fait, reportez-vous à la section Exemple de contenu Journal WKND.

Pour plus d’informations sur la propriété editElementQuery et la configuration de l’éditeur de texte enrichi, consultez la section Configuration de l’éditeur de texte enrichi.

Restrictions limitations

Le SDK de l’éditeur de SPA d’AEM a été introduit avec le pack de services 2 d’AEM 6.4. Il est entièrement pris en charge par Adobe et, en tant que nouvelle fonctionnalité, il continue d’être amélioré et développé. Les fonctionnalités AEM suivantes ne sont pas encore couvertes par l’éditeur de SPA :

  • Mode cible
  • ContextHub
  • Modification des images en ligne
  • Modification des configurations (ex. listeners)
  • Système de style
  • Annuler/rétablir
  • Outil de comparaison des pages et déformation temporelle
  • Fonctionnalités de réécriture HTML côté serveur telles que le vérificateur de liens, le service de réécriture CDN, le raccourcissement des URL, etc.
  • Mode Développeur
  • Lancements AEM
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e