> Utilisation  
 

Le fichier de configuration project.xml

Afin d'utiliser Maven sur un projet, la première étape consiste à créer un fichier de configuration portant le nom project.xml et à le placer dans le répertoire racine de l'application.

Ce fichier contient la description du projet. Ces informations servent notamment à la création d'un site pour le projet. L'exemple suivant présente une version simple d'un fichier project.xml :

<project>

  <id>Identifiant unique pour le projet </id>
  <name>Mon projet</name>
  <currentVersion>1.0</currentVersion>

  <developers>
    <developer>
      <name>Moi</name>
      <id>MoiId</id>
      <email>moi at univ tiret mlv point fr</email>
    </developer>
  </developers>

  <organization>
    <name>Microsoft...Nan je rigole !</name>
  </organization>

</project>

Cette description est basée sur le concept Project Object Model (POM) qui consiste à modéliser le projet comme un objet.

Premier exemple : génération du site du projet

Afin de tester la force de Maven, nous pouvons, après avoir crée le fichier précédent, généré le site du projet. Il suffit pour cela de se positionner dans le répertoire contenant le fichier project.xml et de lancer la commande :

maven site:generate

Un répertoire target/docs est alors crée dans lequel est généré le site du projet. La capture suivante montre l'aspect du site généré :

On retrouve les informations suivantes :

  • liste des développeurs
  • mailing lists
  • dépendences du projet
  • reports de tests unitaires
  • logs
  • Javadoc

La commande maven clean permet de supprimer les fichiers et répertoires générés par Maven.

Deuxième exemple : compilation et génération d'un jar

Maintenant que nous disposons d'une documentation sur le projet, il serait temps de débuter le développememt du projet !

Pour cela, il est recommandé de mettre les sources dans un répertoire spécifique, par exemple le répertoire src à la racine de l'application. Si les sources sont contenues dans des packages, recréer l'arborescence adéquate.

Afin de préciser à Maven le répertoire contenant les sources, il faut rajouter les balises suivantes dans le fichier project.xml :

  <build>
    <sourceDirectory>
      ${basedir}/src
    </sourceDirectory>
  </build>

Dans un premier temps, nous allons lancer une simple compilation des sources à l'aide de la commande (lancée depuis le répertoire racine de l'application) :

maven java:compile

Le répertoire target/classes est alors crée dans lequel les .class sont placés (en respectant l'arborescence des packages).

Nous pouvons également généré un jar correspondant au projet. Pour cela, il suffit de lancer, toujours depuis le répertoire contenant le fichier project.xml, la commande :

maven jar

Comme le montre la capture d'écran suivante, Le fait de lancer cette commande appelle la commande précédente avant d'effectuer les éventuels tests unitaire puis de créer le jar :

Le jar est crée dans le répertoire target et porte le nom correspondant à la balise <id> du fichier project.xml.

 

Ingenieurs2000 27 février 2004