Bon pour relecture
Sommaire :
Création de la structure du projet à partir de l'archetype esup-commons
Qu'est-ce qu'un archetype Maven ? Dans le contexte de esup-commons, un archetype est une structure complete d'un projet à déployer. Toute l'organisation des fichiers, des classes et des projets Eclipse sera mise en place par l'archetype. L'objectif est de proposer une structure standard à tous les développeurs. Le développeur aura "uniquement" à sa charge le remplissage de cette structure.
La structure du projet va être construite à partir d'un archétype maven dont voici les paramètres :
archetypeRepository=https://mvn.esup-portail.org/content/repositories/releases
archetypeGroupId=org.esupportail
archetypeArtifactId=esup-blank-archetype
archetypeVersion=numeroVersionArchetype
groupId=org.esupportail
artifactId=nomProjet
package=packageMonProjet
version=numeroVersionMonProjet
où :
- numeroVersionArchetype : numéro de version de l'archetype a utiliser. Pour connaitre le numéro de version de l'archetype, merci de vous référer à cette page : Changelog
- nomProjet : nom de mon projet. Par exemple : portlet-reservation
- packageMonProjet : nom du package JAVA correspondant à mon projet. Par exemple : fr.uhp.reservation
- numeroVersionMonProjet : numéro de version de mon projet. Par exemple : 1.0-SNAPSHOT
- les autres paramètres ne sont pas à modifier
Nous allons prendre pour l'exemple la création du projet portlet-réservation.
Création depuis Eclipse
Se rendre dans le menu File => New => Project...
Choisir Maven Project
Laisser l'emplacement par défaut pour le projet
Il n'y a pas d'archétype
Cliquer sur Add Archetype
Remplir les champs correspondant à l'archétype que l'on souhaite utiliser
Choisir l'archétype que l'on vient d'ajouter
Créer le projet
Au moment de la création de l'archetype, il faut absolument que groupId=org.esupportail.
Lorsque que vous mettez pour l'artifactId=portlet-reservation, Eclipse propose automatiquement un package en fonction de cet artifactUd : org.esupportail.portlet_reservation. On pourrait penser qu'il faut changer le groupId pour mettre un fr.uhp par exemple et avoir ensuite un package=fr.uhp.portlet_reservation.
En fait, non : le groupId et le package sont complètement dissociés. Il faut laisser groupId=org.esupportail et taper à la main (sans garder ce qu'Eclipse suggère par défaut) fr.uhp.reservation.
Cliquer sur finish et l'archetype est créé avec vos choix.
Pour préparer un projet, toutes les dépendances doivent être satisfaites. Chaque module Maven dépendant d'un autre, il faut donc compiler chaque module afin de générer les jar qui seront utilisés par les autres modules.C'est le but de la target Install de Maven.
Lancer la tache Maven via un clic droit sur le projet parent -> Run as -> mvn install
Voila le résultat dans la console de Eclipse ?:
Le projet est maintenant prêt à être utilisé.
Création en ligne de commande
récupération du projet : ce positionner dans le repertoire workspace de Eclipse et lancer la commande suivante :
mvn archetype:generate -B -DarchetypeRepository=https://mvn.esup-portail.org/content/repositories/releases -DarchetypeGroupId=org.esupportail -DarchetypeArtifactId=esup-blank-archetype -DarchetypeVersion=numeroVersionArchetype -DgroupId=org.esupportail -DartifactId=nomProjet -Dpackage=packageMonProjet -Dversion=numeroVersionMonProjet
Une fois l'archetype récupéré, il faut se positionner dans le repertoire parent, et lancer la commande suivante :
mvn eclipse:eclipse
Voila le résultat dans la console :
cette commande va configurer les projets pour que ce soient des projets WTP dans Eclipse. Une fois fait, il faut les importer dans Eclipse.
Pour cela :Il faut importer des projets Maven.
Dans Eclipse : File -> New -> Maven -> Existing Maven Projects
Il faut alors choisir le repertoire parent du Blank que l'on vient de récupérer. Eclipse va automatiquement sélectionner tous les modules présents.
On valide en cliquant sur "Finish".
Le projet est maintenant prêt à être utilisé.
Utilisation du projet
Une fois le projet prêt, vous pouvez supprimer les module web qui ne vous intéressent pas. Pour rappel, dans cette page : 1.2 Méthodologie de développement, vous trouverez trouverez toutes les informations pour choisir le module web à garder. Ce n'est pas une obligation de supprimer les module web que vous ne souhaitez pas utiliser, vous pouvez les garder pour un usage ultérieur. Ils ne poseront pas de problème dans votre travail de développement.
Pour tester votre module et donc votre développement, il faut utiliser les fonctionnalités WTP de Eclipse. Il faut ajouter le module web dans un des serveurs déclarés dans votre Eclipse.
Pour cela, clic droit sur le serveur que vous souhaitez utiliser, et chosissez "Add an Remove ...".
Vous devez alors choisir le module web sur lequel vous souhaitez travailler.
Et une fois vos choix validés, le contexte de votre module est accessible dans le serveur choisis.
Dans notre exemple, pour y accéder, vous devrez alors taper l'URL : http://localhost:8080/portlet-reservation-web-jsf-servlet
Et il ne vous reste plus qu'à démarrer le serveur.