Utilisation de l’archétype de projet AEM

Dernière mise à jour : 2024-02-13
  • Créé pour :
  • Developer
    Admin

Ce document explique comment vous pouvez utiliser l’archétype de projet AEM pour créer un projet Adobe Experience Manager minimal qui s’appuie sur des bonnes pratiques pour que vous puissiez démarrer vos propres projets AEM sur des bases saines.

Il se concentre sur les schémas d’utilisation généraux et sur ce que l’archétype fait pour vous. Pour obtenir des instructions techniques et des options de génération détaillées, consultez la documentation du référentiel GitHub de l’archétype.

CONSEIL

Le dernier archétype de projet AEM, ainsi que la documentation technique complète, sont disponibles sur GitHub.

Prise en main

L’archétype de projet permet de commencer facilement à développer dans AEM. Vous pouvez commencer à travailler avec l’archétype de plusieurs manières.

  • Tutoriel WKND : pour une excellente introduction au développement dans AEM, notamment des informations sur l’utilisation de l’archétype, reportez-vous à Prise en main d’AEM Sites - Tutoriel WKND afin d’obtenir un exemple pratique vous guidant tout au long de l’utilisation de l’archétype pour mettre en œuvre un projet simple.
  • Tutoriel sur WKND Events : si le développement d’applications d’une seule page (SPA) dans AEM vous intéresse particulièrement, consultez notre tutoriel WKND Events dédié.
  • C’est à vous de jouer ! : vous pouvez facilement télécharger l’archétype de projet actuel disponible sur GitHub et créer votre premier projet en suivant les étapes simples ci-dessous.

Utilisation de l’archétype

La première étape d’utilisation de l’archétype consiste à créer un projet qui génère les modules dans une structure de fichiers locale. Dans le cadre de la génération du projet, plusieurs propriétés de votre projet peuvent être définies, telles que le nom du projet, la version, l’activation de certaines options, etc.

CONSEIL

Chaque fois que vous créez l’archétype, il génère également une série de fichiers LisezMoi, vous fournissant les détails techniques et l’utilisation de chaque module, comme ci-dessous.

La création du projet avec Maven crée les artefacts (packages et lots OSGi) qui peuvent être déployés vers AEM. Des commandes et des profils Maven supplémentaires peuvent être utilisés pour déployer les artefacts du projet vers une instance AEM.

Avantages de l’utilisation de l’archétype

L’archétype est constitué de modules qui sont tous créés automatiquement lors de l’utilisation de l’archétype.

  • core est un lot Java contenant toutes les fonctionnalités de base, telles que les services, les listeners et les planificateurs OSGi, ainsi que le code Java associé aux composants, tel que les servlets et les filtres de requête.
  • it.tests sont des tests d’intégration basés sur Java.
  • ui.apps contient les parties du projet /apps et /etc, c’est-à-dire les bibliothèques clientes, les composants et les modèles JS et CSS.
  • ui.content contient un exemple de contenu utilisant des composants du module ui.apps.
  • ui.config contient des configurations OSGi spécifiques au projet.
  • ui.frontend.general contient les artefacts requis pour utiliser le module de génération front-end basé sur Webpack général (facultatif).
  • ui.frontend.react (facultatif) contient les artefacts requis lors de l’utilisation de l’archétype pour créer des projets SPA basés sur React (facultatif, dépend des paramètres de version).
  • ui.frontend.angular****(facultatif) contient les artefacts requis lors de l’utilisation de l’archétype pour créer des projets SPA basés sur Angular (facultatif, dépend des paramètres de version).
  • ui.tests contient des tests d’interface utilisateur basés sur Selenium.
  • al est un package de contenu unique qui intègre tous les modules compilés (lots et packages de contenu), y compris les dépendances des fournisseurs.
  • dispatcher.ams contient les configurations de Dispatcher de base pour les projets AMS/On-Prem (facultatif, dépend des paramètres de version).
  • dispatcher.cloud contient les configurations de Dispatcher de base pour les projets AEMaaCS (facultatif, dépend des paramètres de version).

Organisation du package de contenu

Les modules de l’archétype AEM représentés dans Maven sont déployés vers AEM en tant que packages de contenu représentant l’application, le contenu et les lots OSGi nécessaires.

Fichier POM parent

Le fichier pom.xml racine du projet (<src-directory>/<project>/pom.xml) est connu sous le nom de fichier POM parent et oriente la structure du projet et gère les dépendances ainsi que certaines propriétés globales du projet.

Propriétés globales du projet

La section <properties> du fichier POM parent définit plusieurs propriétés globales importantes pour le déploiement de votre projet vers une instance AEM, telles que le nom d’utilisateur/mot de passe, le nom d’hôte/port, etc.

Ces propriétés sont configurées pour être déployées vers une instance AEM locale, car il s’agit du scénario de création le plus courant pour les développeurs. Notez qu’il existe des propriétés à déployer vers une instance de création et une instance de publication. Il s’agit également de l’endroit où les informations d’identification sont définies pour s’authentifier auprès de l’instance AEM. Les informations d’identification par défaut sont admin:admin.

Ces propriétés sont configurées de manière à pouvoir être remplacées lors d’un déploiement vers des environnements de niveau supérieur. De cette manière, les fichiers POM n’ont pas à changer, mais des variables comme aem.host et sling.password peuvent être remplacées via des arguments de ligne de commande :

mvn -PautoInstallPackage clean install -Daem.host=production.hostname -Dsling.password=productionpasswd

Structure du module

La section <modules> du fichier POM parent définit les modules que le projet va créer. Par défaut, le projet crée les modules standard précédemment définis. D’autres modules peuvent toujours être ajoutés à mesure qu’un projet évolue.

Dépendances

La section <dependencyManagement> du fichier POM parent définit toutes les dépendances et versions des API utilisées dans le projet. Les versions doivent être gérées dans le fichier POM parent. Les sous-modules ne doivent inclure aucune information de version.

Uber Jar

L’une des dépendances clés est le Jar d’API Java AEM. Celui-ci inclut toutes les API AEM ayant une seule entrée de dépendance pour la version d’AEM.

REMARQUE

Il est recommandé de mettre à jour la version d’Uber Jar pour qu’elle corresponde à la version cible d’AEM. Par exemple, si vous prévoyez de procéder au déploiement vers AEM 6.5, vous devez mettre à jour la version d’Uber Jar vers 6.5.X, où X est le dernier pack de services.

Composants principaux

L’archétype tire bien sûr parti des composants principaux.Par conséquent, pour tirer parti des composants principaux dans tous les déploiements, il est recommandé de les inclure dans le projet Maven.

Le fichier core.wcm.components.example est un ensemble d’exemples de pages qui illustrent des exemples de composants principaux. Les bonnes pratiques recommandent que, lors du déploiement d’un projet destiné à la production, vous supprimiez cette dépendance et cette inclusion de sous-package.

REMARQUE

Les composants principaux et l’archétype sont conservés en tant que projets GitHub distincts et leurs versions diffèrent donc.

Chaque version de l’archétype utilisera la dernière version des composants principaux disponibles au moment de la publication. Cependant, vous pouvez mettre à jour manuellement la dépendance sur les composants principaux.

Tests

Il existe trois niveaux de tests contenus dans le projet et, parce qu’il s’agit de différents types de tests, ils sont exécutés de différentes manières ou à différents endroits.

  • Test unitaire - : test unitaire classique du code contenu dans le lot
  • Tests d’intégration : tests d’intégration côté serveur s’exécutant comme des tests de type unitaire dans l’environnement AEM, c’est-à-dire sur le serveur AEM
  • Tests de l’interface utilisateur : tests côté navigateur basés sur Selenium qui vérifient le comportement côté navigateur

Sur cette page