Utilisation des plugins

Introduction

Tout le travail dans maven est réalisé par des plugins

un plugin est une archive jar identifié comme n'importe quel autre artefact maven: groupId, artifactId, version. Par exemple:

    <groupId>org.apache.maven.plugins</groupId>
   <artifactId>maven-javadoc-plugin</artifactId>
   <version>2.0-beta-2</version>

un plugin est constitué d'un ou plusieurs mojo (maven old java objects, fait aussi probablement référence au terme afro-américain issu des cultes vaudou) et d'un descripteur de plugin identifiant ces mojo et leurs cararctéristiques
un mojo est une simple classe Java implantant l'interface org.apache.maven.plugin.Mojo ou héritant de org.apache.maven.plugin.AbstractMojo
- le travail est fait dans la méthode execute()
- le plugin est configuré au travers de propriétés suivant la convention des javabeans
- le code contient des tags javadoc utilisés par qdox pour généré le descripteur du plugin et l'intégrer dans le conteneur plexus.[1]
- chaque mojo s'exécute isolé par un classloader spécifique et représent un but à atteindre.

Invoquer un plugin

Commande de base: mvn groupId:artifactId:[version:]goal

nono@osquare:~/enseign/maven/hello$ mvn org.apache.maven.plugins:maven-javadoc-plugin:javadoc
[INFO] Scanning for projects...
[INFO] ----------------------------------------------------------------------------
[INFO] Building Maven Quick Start Archetype
[INFO] task-segment: [org.apache.maven.plugins:maven-javadoc-plugin:javadoc]
[INFO] ----------------------------------------------------------------------------
[INFO] Preparing javadoc:javadoc
....
[INFO] [javadoc:javadoc]
Loading source file /home/nono/enseign/maven/hello/src/main/java/fr/norsys/App.java...
Constructing Javadoc information...
Standard Doclet version 1.5.0_06
Building tree for all the packages and classes...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/fr/norsys//App.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/fr/norsys//package-frame.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/fr/norsys//package-summary.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/fr/norsys//package-tree.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/constant-values.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/fr/norsys//class-use/App.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/fr/norsys//package-use.html...
Building index for all the packages and classes...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/overview-tree.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/index-all.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/deprecated-list.html...
Building index for all classes...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/allclasses-frame.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/allclasses-noframe.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/index.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/help-doc.html...
Generating /home/nono/enseign/maven/hello/target/site/apidocs/stylesheet.css...
[INFO] ------------------------------------------------------------------------
[INFO] BUILD SUCCESSFUL
[INFO] ------------------------------------------------------------------------
[INFO] Total time: 7 seconds
[INFO] Finished at: Tue Jun 27 11:12:02 CEST 2006
[INFO] Final Memory: 6M/11M
[INFO] ------------------------------------------------------------------------

Utilisation de préfixes

Pour simplifier l'utilisation des plugins, ceux-ci peuvent associer à un préfixe. La commande devient donc simplement: mvn prefix:goal

Par convention, le préfixe d'un plugin est déduit de son nom: maven-toto-plugin ----> préfixe: toto

Cette information est stockée dans la méta-information (maven-metadata.xml) asociée au groupe du plugin dans le référentiel dont il provient. Par exemple:

nono@osquare:~/enseign/maven/hello$ cat /var/lib/m2/fr/lifl/maven-metadata.xml
<?xml version="1.0" encoding="UTF-8"?><metadata>
  <plugins>
    <plugin>
      <name>Maven FIDL Plugin</name>
      <prefix>fidl</prefix>
      <artifactId>maven-fidl-plugin</artifactId>
    </plugin>
  </plugins>
</metadata>maven-fidl-plugin<

Ce fichier indique que le préfixe fidl est associé à l'artefact maven-fidl-plugin dans le groupe fr.lifl

Ce lien entre préfixe et plugin peut-être configuré encore plus finement:

on peut spécifier dans le POM du plugin un attribut de configuration du plugin maven-plugin-plugin qui va définir explicitement le préfixe (goalPrefix
on peut indiquer un ordre de résolution par groupe de plugins dans settings.xml:
```
[...]
  <pluginGroups>
    <pluginGroup>groupId</pluginGroup>
  </pluginGroups>
[...]
```
- ceci permet éventuellement de surcharger un préfixe standard (eg. javadoc ou clean) par un plugin personnalisé, par exemple pour réaliser des traitements particuliers qui ne sont pas pris en compte par défaut

Invocation automatique et configuration

Liaison d'un plugin à une phase

Chaque plugin (ou plutôt chaque but) peut être lié à une phase du cycle de vie de la construction d'artefacts:

dans le POM du projet utilisant ce plugin:

<project [...]
[...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-javadoc-plugin</artifactId>
        <executions>
          <execution>
            <phase>process-classes</phase>
            <goals>
              <goal>javadoc</goal>
            </goals>
          </execution>
        </executions>
      </plugin>
    </plugins>
  </build>
[...]
</project>

dans la spécification d'un mojo par une annotation @phase

Le plugin est alors automatiquement invoqué lors de l'exécution de la phase choisie.

Configuration de l'exécution d'un plugin

La configuration des plugins s'effectue dans le POM du projet qui l'utilise:

soit pour chaque exécution du plugin
soit pour toutes les exécutions

Dans tous les cas, les informations de configuration sont regroupées dans un tag XML:

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-compiler-plugin</artifactId>
        <configuration>
          <compilerVersion>1.4</compilerVersion> <!-- don't use 1.5 just yet -->
          <source>1.4</source> <!-- necessary to enable assertions -->
          <target>1.4</target> <!-- don't make it backward compatible -->
          <debug>true</debug>
          <showDeprecation>true</showDeprecation>
          <showWarnings>true</showWarnings>
          <optimize>false</optimize>
              <!-- to make debugging possible;
                   should be set to true for a release with a profile -->
        </configuration>
      </plugin>
      [...]
    </plugins>
  </build>

ou pour une configuration par exécution:

[...]
<project>
  [...]
      <plugin>
        [...]
        <executions>
          <execution>
          [...]
            <configuration>
              configuration for this execution of the plugin
            </configuration>
          [...]
          </execution>
        </executions>
        [...]
        <configuration>
          configuration for all executions of the plugin
        </configuration>
      </plugin>
  [...]
</project>

La configuration globale est héritée par toutes les exécutions
les configurations courantes peuvent être regroupées dans un profil
il est possible de configurer deux exécutions différentes d'un meme goal (en utilisant deux tags execution avec des id différentes)
un plugin peut apparaitre et être configuré dans différents sections du POM (build, reporting

voir syntaxe et propriétés des mojo.

index

Footnotes: [1] En attendant l'utilisation des annotations de java5.0...