5 décembre 2013

Maven - Créer un archetype

Un archetype Maven permet la création rapide d'un nouveau projet à partir d'un projet existant qui sert alors de modèle.

L'objectif de cet article est de vous présenter comment rapidement créer un nouvel Archetype Maven.

Etapes de création d'un archetype à partir d'un projet existant

  • Copier le projet
  • Nettoyer le contenu du projet
  • Créer le fichier de propriétés de l'archetype
  • Générer l'archetype
  • Installer l'archetype sur le repository local
  • Tester l'archetype



Etape 1: Copier le projet

Vous devez tout d'abord créer un nouveau répertoire vide nommé par exemple "archetype" en dehors de votre workspace.

Copier le répertoire contenant votre projet dans ce répertoire "archetype".

Etape 2 : Nettoyer le contenu du projet

Le projet contient des fichiers inutiles pour l'archetype. C'est pourquoi il est nécessaire de supprimer les fichiers de configuration de l'IDE et le répertoire target de Maven.

Exemple de fichiers et de répertoires à supprimer :
  • .settings
  • .project
  • .classpath
  • target
  • tous les répertoires ".git" et ".svn"

Etape 3: Créer le fichier de propriétés de l'archetype

Créer un fichier nommé "archetype.properties" dans le répertoire parent du projet. Le répertoire parent avait été nommé "archetype" à l'étape 1 de ce guide.

Voici un exemple de son contenu :

archetype.languages=java
archetype.filteredExtensions=java
package=[package]
groupId=[groupId]
artifactId=[artifactId]
version=[version]

, avec :
  • [package] : le package de base de votre projet
  • [groupId] : le groupId de l'archetype
  • [artifactId] : l'artifactId de l'archetype
  • [version] : version de l'archetype

Etape 4: Générer l'archetype

Ouvrir un terminal et lancer à la racine du projet la commande suivante :

mvn archetype:create-from-project -Darchetype.properties=../archetype.properties

Maven indique qu'il a généré l'archetype dans le répertoire du projet :

target/generated-sources/archetype

Etape 5: Installer l'archetype sur le repository local


Dans le terminal, accéder au répertoire "target/generated-sources/archetype" du projet.

Tapper la commande suivante pour installer l'archetype sur le repository local :

mvn install

Maven indique qu'il a installé l'archetype dans le catalogue des archetypes local

Etape 6: Tester l'archetype

Dans le terminal, dans un nouveau répertoire, tapper la commande suivante :

mvn archetype:generate -DarchetypeCatalog=local
Maven demande les informations sur le package de base, le groupId, l'artifactId et la version du projet.

Compléter ces informations et valider la création du projet.

Vérifier et tester le projet créé.