Outils de développement AEM pour Eclipse aem-developer-tools-for-eclipse
Vue d’ensemble overview
Les outils de développement Experience Manager pour Eclipse sont un plug-in Eclipse basé sur le plug-in Eclipse pour Apache Sling disponible avec Apache License 2.
Il offre plusieurs fonctionnalités qui facilitent le développement d’AEM :
- Intégration transparente avec les instances AEM via Eclipse Server Connector
- Synchronisation pour les bundles de contenu et d’OSGi
- Prise en charge du débogage avec fonctionnalité de remplacement de code à chaud
- Démarrage simple de projets AEM par l’intermédiaire d’un assistant de création de projet spécifique
- Modification facile des propriétés JCR
Conditions requises requirements
Avant d’utiliser AEM Developer Tools, vous devez :
- Téléchargez et installez Eclipse IDE pour Enterprise Java et Web Developers.
- La version 1.4.0 des outils de développement AEM pour Eclipse est compatible avec Eclipse 2022-12 (4.26) ou une version ultérieure et nécessite l’exécution de Java 17 ou une version ultérieure.
- Configurez votre installation Eclipse pour vous assurer de disposer d’au moins 1 Go de mémoire de tas en modifiant votre fichier de configuration
eclipse.ini
comme décrit dans la FAQ Eclipse.
eclipse.ini
.Comment installer AEM Developer Tools pour Eclipse how-to-install-the-aem-developer-tools-for-eclipse
Lorsque vous avez rempli les conditions requises ci-dessus, vous pouvez installer le plug-in des outils de développement comme suit :
-
Ouvrez le site web AEM Developer Tools.
-
Copiez le lien d’installation.
- Vous pouvez également télécharger une archive au lieu d’utiliser le lien d’installation.
- Cette méthode permet une installation hors ligne, mais vous ne recevez pas de notifications de mise à jour automatique.
-
Dans Eclipse, ouvrez le menu Aide.
-
Cliquez sur Installer un nouveau logiciel.
-
Cliquez sur Add… (Ajouter).
-
Dans le champ Nom, saisissez
AEM Developer Tools
. -
Dans le champ Emplacement, copiez l’URL d’installation.
-
Cliquez sur Add (Ajouter).
-
Cochez les plug-ins AEM et Sling.
-
Cliquez sur Next (Suivant).
-
Dans la fenêtre Détails de l’installation, passez en revue les éléments à installer et cliquez de nouveau sur Suivant.
-
Acceptez les contrats de licence et cliquez sur Finish (Terminer).
-
Dans la boîte de dialogue Autorités d’approbation qui s’affiche, sélectionnez l’
https://eclipse.adobe.com
d’autorité/de site et cliquez sur Approbation sélectionnée. -
Dans la boîte de dialogue Artefacts d’approbation qui s’affiche, sélectionnez les signataires de code et cliquez sur Approbation sélectionnée.
-
Cliquez sur Redémarrer maintenant pour redémarrer Eclipse.
La perspective d’AEM the-aem-perspective
Dans Eclipse, une perspective détermine les actions et les vues disponibles dans une fenêtre et permet une interaction axée sur les tâches avec les ressources. Pour plus d’informations sur les perspectives, consultez la documentation Eclipse..
Les outils de développement Experience Manager pour Eclipse offrent une perspective AEM qui vous offre un contrôle total sur vos projets et instances AEM. Pour ouvrir la perspective AEM :
- Dans la barre de menus Eclipse, sélectionnez Fenêtre > Perspective > Ouvrir la perspective > Autre.
- Sélectionnez AEM dans la boîte de dialogue et cliquez sur Ouvrir.
Exemple de projet multi-module sample-multi-module-project
Les outils de développement Experience Manager pour Eclipse sont fournis avec un exemple de projet multi-module qui vous permet de vous familiariser rapidement avec la configuration d’un projet dans Eclipse. Il sert également de guide des bonnes pratiques pour plusieurs fonctionnalités d’AEM, en tirant parti de l’archétype de projet AEM.
Pour créer l’exemple de projet, procédez comme suit :
-
Dans le menu Fichier > Nouveau > Projet, accédez à la section AEM et sélectionnez Exemple de projet multi-module AEM.
-
Cliquez sur Next (Suivant).
note note NOTE Cette étape peut prendre un certain temps, car m2eclipse doit analyser les catalogues d’archétypes. -
com.adobe.aem : aem-project-archetype : <highest-number>
doit être sélectionné automatiquement dans la liste déroulante Archétype. Sélectionnez une version précédente, le cas échéant. Cliquez sur Suivant. -
Fournissez les champs suivants pour l’exemple de projet :
- Name (Nom)
- Group Id (ID de groupe)
- Artifact Id (ID d’artefact)
- appId : vous devrez peut-être développer les options Advanced (Avancé) pour définir cette valeur.
- appTitle : vous devrez peut-être développer les options Advanced pour définir cette valeur.
- Package : vous devrez peut-être développer les options Advanced pour définir cette valeur.
-
Cliquez sur Next (Suivant).
-
Configurez un serveur AEM auquel Eclipse se connecte en sélectionnant Configurer un nouveau serveur et en fournissant un nom de serveur et les informations de connexion nécessaires.
- Pour utiliser la fonctionnalité de débogage, vous devez démarrer AEM en mode débogage en fournissant le paramètre
-agentlib
, par exemple :
code language-text $ java -agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005 -jar aem-author-p4502.jar
note tip TIP Pour plus d’informations sur le débogage de votre projet s’exécutant sur un SDK AEM local, consultez le document Débogage à distance du SDK AEM . - Pour utiliser la fonctionnalité de débogage, vous devez démarrer AEM en mode débogage en fournissant le paramètre
-
Cliquez sur Finish (Terminer).
La structure du projet est créée. Le téléchargement des artefacts nécessaires au projet peut prendre un certain temps.
Comment importer des projets existants how-to-import-existing-projects
Utilisez la fonction Nouveau projet pour créer la structure de projet de base.
-
Suivez les instructions pour créer un exemple de projet multi-module qui crée une structure de projet de base avec une séparation saine des préoccupations :
PROJECT.ui.apps
pour le contenu/apps
et/etc
PROJECT.ui.content
pour le/content
qui est crééPROJECT.core
pour les lots JavaPROJECT.it.launcher
etPROJECT.it.tests
pour les tests d’intégration
-
Remplacez le contenu de votre projet
PROJECT.ui.apps
par les dossiersapps
etetc
de votre package :- Dans le panneau Explorateur de projets, développez
PROJECT.ui.apps
>src
>main
>content
>jcr_root
>apps
. - Cliquez avec le bouton droit sur le dossier
apps
et choisissez Afficher dans > Explorateur système. - Supprimez les dossiers
apps
etetc
. - Au même emplacement, placez les dossiers
apps
etetc
de votre package de contenu. - Dans Eclipse, cliquez avec le bouton droit sur le projet
PROJECT.ui.apps
et sélectionnez Actualiser.
- Dans le panneau Explorateur de projets, développez
-
Faites ensuite de même pour
PROJECT.ui.content
et remplacez son dossier de contenu par celui de vos packages :- Dans le panneau Explorateur de projets, développez
PROJECT.ui.content
>src
>main
>content
>jcr_root
>content
. - Cliquez avec le bouton droit sur le dossier de contenu le plus profond et sélectionnez Afficher dans > Explorateur système.
- Supprimez le dossier de contenu à cet endroit.
- Placez le dossier de contenu de votre package de contenu au même emplacement.
- Dans Eclipse, cliquez avec le bouton droit sur le projet
PROJECT.ui.content
et sélectionnez Actualiser.
- Dans le panneau Explorateur de projets, développez
-
Mettez à jour les fichiers
filter.xml
de ces deux projets pour qu’ils correspondent au contenu de votre package de contenu en ouvrant le fichierMETA-INF/vault/filter.xml
de votre package de contenu dans un éditeur de texte/code distinct.- Voici un exemple de l’aspect que peut avoir votre fichier
filter.xml
:
code language-xml <?xml version="1.0" encoding="UTF-8"?> <workspaceFilter version="1.0"> <filter root="/apps/foo"/> <filter root="/apps/foundation/components/bar"/> <filter root="/etc/designs/foo"/> <filter root="/content/foo"/> <filter root="/content/dam/foo"/> <filter root="/content/usergenerated/content/foo"/> </workspaceFilter>
- Voici un exemple de l’aspect que peut avoir votre fichier
-
En ce qui concerne le contenu de votre package qui a été divisé en deux projets, vous devez également diviser ces règles de filtrage en deux et mettre à jour les fichiers
filter.xml
des deux projets en conséquence.-
Dans Eclipse, ouvrez
PROJECT.ui.apps/src/main/content/META-INF/filter.xml
. -
Remplacez le contenu de l’élément
<workspaceFilter>
par les règles de votre package qui commencent par/apps
et/etc
.-
Par exemple :
code language-xml <?xml version="1.0" encoding="UTF-8"?> <workspaceFilter version="1.0"> <filter root="/apps/foo"/> <filter root="/apps/foundation/components/bar"/> <filter root="/etc/designs/foo"/> </workspaceFilter>
-
-
Ouvrez ensuite
PROJECT.ui.content/src/main/content/META-INF/filter.xml
. -
Remplacez les règles par celles de votre package qui commencent par
/content
.-
Par exemple :
code language-xml <?xml version="1.0" encoding="UTF-8"?> <workspaceFilter version="1.0"> <filter root="/content/foo"/> <filter root="/content/dam/foo"/> <filter root="/content/usergenerated/content/foo"/> </workspaceFilter>
-
-
-
Veillez à enregistrer toutes vos modifications. Vous pouvez désormais synchroniser ce nouveau contenu avec votre instance AEM.
-
Dans le panneau Serveurs, assurez-vous que la connexion est démarrée, et si oui, ne la démarrez pas.
-
Cliquez sur l’icône Nettoyer et publier.
Une fois cette opération terminée, votre package doit s’exécuter sur votre instance. Lors de l’enregistrement, toute modification est automatiquement synchronisée dans l’instance.
Si vous souhaitez recréer un package à partir de votre projet, cliquez avec le bouton droit de la souris sur le PROJECT.ui.apps
ou le PROJECT.ui.content
, puis sélectionnez Exécuter en tant que > Installation Maven.
Vous disposez désormais d’un dossier cible contenant votre package (nommé par exemple PROJECT.ui.apps-0.0.1-SNAPSHOT.zip
).
Résolution des problèmes troubleshooting
Résolution d’une définition de projet non valide resolving-invalid-project-definition
Pour résoudre des dépendances et une définition de projet non valides, procédez comme suit :
- Sélectionnez tous les projets créés.
- Faites un clic-droit.
- Dans le menu contextuel, sélectionnez Maven > Mettre à jour les projets.
- Cochez Force Updates of Snapshot/Releases (Forcer les mises à jour d’instantané/de versions).
- Cliquez sur OK.
Eclipse télécharge les dépendances requises. Cela peut prendre un moment.
Informations supplémentaires more-information
Le site web officiel Apache Sling IDE tooling for Eclipse fournit des informations supplémentaires utiles :
- Le guide d’utilisation Apache Sling IDE tooling for Eclipse vous guide parmi les concepts généraux, l’intégration des serveurs et les fonctionnalités de déploiement pris en charge par les outils de développement AEM.
- Résolution des problèmes liés à l’outil IDE Apache Sling
- Liste des problèmes connus
La documentation officielle Eclipse suivante peut vous aider à configurer votre environnement :