Développement de SPA pour l'AEM

Les applications d’une seule page (SPA) peuvent améliorer considérablement l’expérience des utilisateurs de sites web. Le souhait des développeurs est de pouvoir créer des sites avec des structures SPA. Les auteurs, pour leur part, souhaitent modifier facilement du contenu dans AEM pour un site conçu à l’aide de telles structures.

Cet article présente des questions importantes à prendre en compte lorsqu'un développeur de premier plan doit développer un SPA pour AEM et donne un aperçu de l'architecture de l'AEM en ce qui concerne le déploiement de sur l'.

Remarque

L’éditeur SPA est la solution recommandée pour les projets qui nécessitent un rendu côté client SPA structure (par exemple, Réagir ou Angulaire).

Principes SPA de développement pour l'AEM

Le développement d’applications d’une seule page sur AEM suppose que le développeur principal respecte les meilleures pratiques standard lors de la création d’un SPA. Si en tant que développeur frontal vous suivez ces bonnes pratiques générales ainsi que quelques principes spécifiques à AEM, votre SPA sera fonctionnel avec l' et ses capacitésde création de contenu.

  • Portabilité - Comme pour tout composant, les composants doivent être construits pour être aussi portables que possible. Le SPA doit être construit avec des composants portatifs et réutilisables.
  • aem pilote la structure du site : le développeur principal crée des composants et possède leur structure interne, mais compte sur AEM pour définir la structure du contenu du site.
  • Rendu dynamique : tous les rendus doivent être dynamiques.
  • Routage dynamique - Le SPA est responsable du routage et AEM l'écoute et les récupère en fonction. Tout routage devrait également être dynamique.

Si vous gardez ces principes à l’esprit au fur et à mesure que vous développez votre SPA, il sera aussi flexible et futur BAT que possible tout en activant toutes les fonctionnalités de création AEM prises en charge.

Si vous n’avez pas besoin de prendre en charge AEM fonctions de création, vous devrez peut-être envisager un modèle de conceptionSPA différent.

Portabilité

Comme lors du développement de n'importe quel composant, vos composants doivent être conçus de manière à optimiser leur portabilité. Tout modèle qui va à l'encontre de la portabilité ou de la réutilisation des composants doit être évité pour assurer la compatibilité, la flexibilité et la maintenabilité à l'avenir.

Les SPA résultantes doivent être construites avec des composants hautement portables et réutilisables.

aem lecteurs Structure du site

Le développeur principal doit se considérer comme responsable de la création d'une bibliothèque de composants SPA utilisés pour créer l'application. Le développeur frontal a un contrôle total de la structure interne des composants. Cependant, AEM possède toujours la structure du site.

Cela signifie que le développeur principal peut ajouter du contenu client avant ou après le point d’entrée des composants et peut également effectuer des appels tiers à l’intérieur du composant. Cependant, le développeur frontal ne contrôle pas entièrement la manière dont les composants sont imbriqués, par exemple.

Rendu dynamique

Le SPA ne doit reposer que sur le rendu dynamique du contenu. Il s’agit de l’attente par défaut où AEM récupère et rend tous les enfants de la structure de contenu.

Tout rendu explicite pointant vers un contenu spécifique est considéré comme un rendu statique et bien que pris en charge ne sera pas compatible avec AEM fonctionnalités de création de contenu. Cela va aussi à l'encontre du principe de portabilité.

Routage dynamique

Comme pour le rendu, tous les routages doivent également être dynamiques. En AEM, le SPA doit toujours être propriétaire du routage et l’AEM l’écoute et récupère le contenu en fonction de celui-ci.

Tout routage statique va à l'encontre du principe de portabilité et limite l'auteur en n'étant pas compatible avec les fonctionnalités de création de contenu de l'AEM. Par exemple, avec un routage statique, si l’auteur du contenu souhaite modifier un itinéraire ou une page, il doit demander au développeur principal de le faire.

Archétype de projet AEM

Tout projet AEM doit tirer parti de l'archétype de projetAEM, qui prend en charge les projets SPA à l'aide de React ou Angular et qui utilise le SDK .

Modèles de conception SPA

Si les principes de développement des SPA dans AEM sont respectés, votre SPA sera fonctionnelle avec toutes les fonctionnalités de création de contenu d’ prises en charge.

Il peut toutefois y avoir des cas où cela n'est pas tout à fait nécessaire. Le tableau suivant présente un aperçu des différents modèles de conception, leurs avantages et leurs inconvénients.

Modèle de conception
Avantages Inconvénients
aem est utilisé comme CMS sans en-tête sans utiliser la structure SPA Editor SDK. Le développeur frontal a un contrôle total sur l’application.

Les auteurs de contenu ne peuvent pas exploiter AEM expérience de création de contenu.

Le code n'est ni portable ni réutilisable s'il contient des références statiques ou un routage.

N’autorise pas l’utilisation de l’éditeur de modèles ; le développeur principal doit donc gérer les modèles modifiables via le JCR.

Le développeur principal utilise la structure SPA Editor SDK, mais n’ouvre que certaines zones à l’auteur du contenu. Le développeur garde le contrôle de l’application en activant uniquement la création dans des zones restreintes de l’application.

Les auteurs de contenu sont limités à un ensemble limité d’AEM expérience de création de contenu.

Le code risque de ne pas être portable ni réutilisable s'il contient des références statiques ou un routage.

N’autorise pas l’utilisation de l’éditeur de modèles ; le développeur principal doit donc gérer les modèles modifiables via le JCR.

Le projet tire pleinement parti du SDK SPA Editor et les composants frontend sont développés en tant que bibliothèque et la structure de contenu de l’application est déléguée à AEM.

L'application est réutilisable et portable.

L’auteur du contenu peut modifier l’application à l’aide de AEM expérience de création de contenu.

Le SPA est compatible avec l’éditeur de modèles.

Le développeur ne contrôle pas la structure de l’application et la partie du contenu déléguée à AEM.

Le développeur peut toujours réserver des zones de l’application pour le contenu qui ne doit pas être créé à l’aide d’AEM.

Remarque

Bien que tous les modèles soient pris en charge en AEM, ce n'est qu'en mettant en oeuvre le troisième (et en respectant ainsi les principes de développement SPA recommandés en AEM) que les auteurs de contenu pourront interagir et modifier le contenu du en à mesure qu'ils s'y habitueront.

Migration des SPA existantes vers AEM

En règle générale, si votre SPA respecte les principes de développement SPA pour l’AEM, votre fonctionnera en et sera modifiable à l’aide de l’éditeur d’.

Suivez ces étapes pour préparer votre SPA existante à travailler avec AEM.

  1. Rendez vos composants JS modulaires.

    Rendez-les capables d’être rendus dans n’importe quel ordre, position et taille.

  2. Utilisez les conteneurs fournis par notre SDK pour placer vos composants à l’écran.

    aem fournit un composant système de page et de paragraphe que vous pouvez utiliser.

  3. Créez un composant AEM pour chaque composant JS.

    Les composants AEM définissent la boîte de dialogue et la sortie JSON.

Instructions destinées aux développeurs de premier plan

La principale tâche de la mise en oeuvre d’un développeur frontal pour créer un SPA pour AEM consiste à convenir des composants et de leurs modèles JSON.

Vous trouverez ci-dessous un aperçu des étapes que doit suivre un développeur avant-gardiste lors du développement d'un SPA d'AEM.

  1. Accepter les composants et leur modèle JSON

    Les développeurs frontaux et les développeurs d'AEM dorsaux doivent s'entendre sur les composants nécessaires et sur un modèle afin d'établir une correspondance individualisée entre les composants SPA et les composants dorsaux.

    aem composants sont toujours nécessaires principalement pour fournir des boîtes de dialogue de modification et pour exporter le modèle de composant.

  2. Dans les composants Réagir, accédez au modèle viathis.props.cqModel

    Une fois les composants acceptés et le modèle JSON en place, le développeur frontal est libre de développer le SPA et peut simplement accéder au modèle JSON via this.props.cqModel.

  3. Mise en oeuvre de la render() méthode du composant

    Le développeur frontal met en oeuvre la render() méthode à sa convenance et peut utiliser les champs de la cqModel propriété. Cette opération génère le DOM et les fragments HTML qui seront insérés dans la page. Il s’agit de la méthode standard de création d’une application dans React.

  4. Faites correspondre le composant au type de ressource AEM viaMapTo()

    Le mappage stocke les classes de composants et est utilisé en interne par le Container composant fourni pour récupérer et instancier dynamiquement les composants en fonction du type de ressource donné.

    Il sert de "colle" entre l'avant et l'arrière-plan afin que l'éditeur sache quels composants correspondent les composants réactifs.

    Les Page et ResponsiveGrid sont de bons exemples de classes qui étendent la base Container.

  5. Définissez le composant comme EditConfig paramètre pourMapTo()

    Ce paramètre est nécessaire pour indiquer à l’éditeur comment le composant doit être nommé aussi longtemps qu’il n’est pas encore rendu ou n’a aucun contenu à rendre.

  6. Étendre la Container classe fournie pour les pages et les conteneurs

    Les systèmes de pages et de paragraphes doivent étendre cette classe afin que la délégation aux composants internes fonctionne comme prévu.

  7. Implémentez une solution de routage qui utilise l’ History API HTML5.

    Lorsque la fonction ModelRouter est activée, l’appel des pushState fonctions et replaceState déclenche une demande à la PageModelManager fonction pour récupérer un fragment manquant du modèle.

    La version actuelle du modèle ModelRouter ne prend en charge que l'utilisation d'URL pointant vers le chemin de ressource réel des points d'entrée du modèle Sling. Il ne prend pas en charge l’utilisation d’URL ou de alias mineurs.

    Il ModelRouter peut être désactivé ou configuré pour ignorer une liste d'expressions régulières.

aem-Agnostique

Ces blocs de code illustrent comment vos composants Réagir et Angular n'ont besoin de rien qui soit spécifique à l'Adobe ou à l'AEM.

  • Tout ce qui se trouve à l’intérieur du composant JavaScript est indifférent aux AEM.
  • Ce qui est toutefois spécifique à AEM est que le composant JS doit être mappé à un composant AEM avec l'aide MapTo.

screen_shot_2018-12-11at144019

L' MapTo aide est la "colle" qui permet de faire correspondre les composants back-end et front-end :

  • Il indique au conteneur JS (ou système de paragraphes JS) quel composant JS est responsable du rendu de chacun des composants présents dans le fichier JSON.
  • Il ajoute un attribut de données HTML au code HTML généré par le composant JS, de sorte que l’éditeur SPA sache quelle boîte de dialogue afficher à l’auteur lors de la modification du composant.

Pour plus d'informations sur l'utilisation MapTo et la création de SPA pour AEM en général, consultez le guide de prise en main de votre structure choisie.

Architecture AEM et SPA

L’architecture générale de l’AEM incluant les environnements de développement, de création et de publication ne change pas lors de l’utilisation de SPA. Cependant, il est utile de comprendre comment SPA développement s'inscrit dans cette architecture.

screen_shot_2018-12-11at145348

  • Créer un Environnement

    C'est là que la source de l'application SPA et la source du composant sont extraites.

    • Le générateur clientlib NPM crée une bibliothèque cliente à partir du projet SPA.
    • Cette bibliothèque sera prise par Maven et déployée par le module externe Maven Build avec le composant dans AEM Author.
  • Auteur AEM

    Le contenu est créé sur l’AEM auteur, y compris la création de SPA.

    Lorsqu’un SPA est modifié à l’aide de SPA Editor sur l’environnement de création :

    1. Le SPA demande le code HTML externe.
    2. Le fichier CSS est chargé.
    3. Le script JavaScript de l’application SPA est chargé.
    4. Une fois l’application SPA exécutée, le fichier JSON est demandé, ce qui permet à l’application de créer le DOM de la page, y compris les cq-data attributs.
    5. Ces cq-data attributs permettent à l’éditeur de charger des informations de page supplémentaires afin de connaître les configurations de modification disponibles pour les composants.
  • Publication AEM

    C’est ici que le contenu créé et les bibliothèques compilées, y compris les artefacts d’application SPA, les clientlibs et les composants, sont publiés pour la consommation publique.

  • Répartiteur / CDN

    Le répartiteur sert de couche de mise en cache des AEM pour les visiteurs sur le site.

    • Les requêtes sont traitées de la même manière que sur l’auteur AEM. Toutefois, aucune requête d’informations de page n’est envoyée, car cette requête n’est requise que par l’éditeur.
    • Javascript, CSS, JSON et HTML sont mis en cache, ce qui optimise la page pour une diffusion rapide.
Remarque

Dans AEM il n'est pas nécessaire d'exécuter les mécanismes de création Javascript ni d'exécuter le JavaScript lui-même. aem héberge uniquement les artefacts compilés de l'application SPA.

Étapes suivantes

Pour une vue d'ensemble de la structure d'un SPA simple en AEM et de son fonctionnement, consultez le guide de prise en main pour Réagir et Angular.

Pour obtenir un guide détaillé sur la création de votre propre SPA, consultez le didacticiel Getting Started with the AEM Editor - WKND Événements.

Pour plus d'informations sur le mappage du modèle dynamique au composant et son fonctionnement dans SPA AEM, consultez l'article Mappage du modèle dynamique au composant pour le mappage des composants pour SPA.

Si vous souhaitez mettre en oeuvre des SPA dans AEM pour un cadre autre que React ou Angular ou simplement pour approfondir la façon dont le SDK SPA pour les fonctionne, reportez-vous à l'article Blueprint .

Sur cette page