Créer un JAR avec dépendances Maven : guide complet débutant

Formateur Python en ligne pour débutants

Apprenez Python facilement sans surcharge théorique. Résolvez des tâches pratiques avec vérification automatique et écrivez du code directement dans le navigateur.

Start Course

« Votre application ne fonctionne que dans l'IDE ? Il est temps de changer ça ! »

\n\n

Si vous avez déjà programmé en Java, vous connaissez sûrement cette situation : vous montrez fièrement votre nouveau projet à un ami, vous le lancez dans IntelliJ IDEA ou Eclipse — tout fonctionne parfaitement. Mais dès que vous transmettez ce projet à un collègue ou essayez de l'exécuter en ligne de commande, vous êtes accueilli par une ClassNotFoundException ou une NoClassDefFoundError. Ça vous parle ?

\n\n

Dans la plupart des cours et tutoriels, on apprend à créer un fichier JAR avec Maven, mais on oublie souvent un détail crucial : où passent les dépendances ? Un fichier JAR standard ne contient que votre code, tandis que toutes les bibliothèques (comme Apache Commons, Jackson, JUnit) restent à l'extérieur. C'est pourquoi des millions de développeurs Java posent cette question sur Stack Overflow : « How can I create an executable/runnable JAR with dependencies using Maven? »

\n\n

Dans cet article, nous allons explorer plusieurs méthodes éprouvées pour créer un JAR exécutable avec dépendances à l'aide de Maven. Vous apprendrez à configurer maven-assembly-plugin, maven-shade-plugin, et même comment cela fonctionne avec Spring Boot. C'est parti !

\n\n

Pourquoi un JAR standard ne fonctionne-t-il pas ?

\n\n

Faisons une petite expérience. Imaginez que vous avez une application qui analyse du JSON avec la bibliothèque Jackson. Vous créez un JAR standard avec la commande mvn package, puis vous essayez de l'exécuter :

\n\n

java -jar my-app.jar

\n\n

Et vous obtenez quelque chose comme :

\n\n

Exception in thread "main" java.lang.NoClassDefFoundError: com/fasterxml/jackson/databind/ObjectMapper

\n\n

Pourquoi cela arrive-t-il ? Parce que Maven, par défaut, ne regroupe que votre code compilé (les classes du dossier src/main/java). Toutes les dépendances que vous avez déclarées dans pom.xml restent dans le dépôt local de Maven (~/.m2/repository). Lorsque vous lancez le JAR, la JVM ne sait pas où trouver ces bibliothèques et génère une erreur.

\n\n

La solution est de créer un fat JAR (JAR épais) ou uber JAR, qui contient non seulement vos classes, mais aussi toutes les dépendances nécessaires. C'est exactement à cela que servent les plugins Maven spécialisés.

\n\n

Méthode 1 : maven-assembly-plugin (simple et fiable)

\n\n

La méthode la plus populaire et la plus simple consiste à utiliser maven-assembly-plugin. Il crée un JAR dans lequel toutes les dépendances sont décompressées et fusionnées avec vos classes. Configurons-le.

\n\n

Ajoutez le code suivant à votre pom.xml dans la section <build><plugins> :

\n\n

<plugin>\n    <groupId>org.apache.maven.plugins</groupId>\n    <artifactId>maven-assembly-plugin</artifactId>\n    <version>3.6.0</version>\n    <configuration>\n        <descriptorRefs>\n            <descriptorRef>jar-with-dependencies</descriptorRef>\n        </descriptorRefs>\n        <archive>\n            <manifest>\n                <mainClass>com.example.Main</mainClass>\n            </manifest>\n        </archive>\n    </configuration>\n    <executions>\n        <execution>\n            <id>make-assembly</id>\n            <phase>package</phase>\n            <goals>\n                <goal>single</goal>\n            </goals>\n        </execution>\n    </executions>\n</plugin>

\n\n

Important : remplacez com.example.Main par le nom complet de votre classe contenant la méthode main.

\n\n

Construisez maintenant le projet avec la commande :

\n\n

mvn clean package

\n\n

Dans le dossier target, deux fichiers apparaîtront :

my-app.jar — le JAR standard
my-app-jar-with-dependencies.jar — le JAR avec toutes les dépendances

\n\n

Pour exécuter ce dernier, utilisez simplement :

\n\n

java -jar target/my-app-jar-with-dependencies.jar

\n\n

Et voilà ! Votre application fonctionne désormais sans IDE, prête à être partagée.

\n\n

Méthode 2 : maven-shade-plugin (pour les projets avancés)

\n\n

Le maven-shade-plugin offre plus de contrôle. Il permet notamment de renommer les packages (shading) pour éviter les conflits de dépendances. C'est la solution idéale si vous utilisez plusieurs bibliothèques qui partagent les mêmes noms de classes.

\n\n

Ajoutez cette configuration dans votre pom.xml :

\n\n

<plugin>\n    <groupId>org.apache.maven.plugins</groupId>\n    <artifactId>maven-shade-plugin</artifactId>\n    <version>3.5.1</version>\n    <configuration>\n        <transformers>\n            <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">\n                <mainClass>com.example.Main</mainClass>\n            </transformer>\n        </transformers>\n    </configuration>\n    <executions>\n        <execution>\n            <phase>package</phase>\n            <goals>\n                <goal>shade</goal>\n            </goals>\n        </execution>\n    </executions>\n</plugin>

\n\n

Exécutez mvn clean package et vous obtiendrez un fichier nommé my-app-shaded.jar (ou original-my-app.jar pour la version sans dépendances).

\n\n

Astuce : Si vous rencontrez des conflits entre dépendances, utilisez l'option <relocations> pour déplacer les packages problématiques vers un nouvel espace de noms.

\n\n

Méthode 3 : Spring Boot Maven Plugin (pour les projets Spring)

\n\n

Si vous utilisez Spring Boot, la création d'un JAR exécutable est encore plus simple. Le Spring Boot Maven Plugin intègre automatiquement toutes les dépendances et configure le point d'entrée.

\n\n

Ajoutez simplement ce plugin à votre pom.xml :

\n\n

<plugin>\n    <groupId>org.springframework.boot</groupId>\n    <artifactId>spring-boot-maven-plugin</artifactId>\n    <version>3.2.0</version>\n    <executions>\n        <execution>\n            <goals>\n                <goal>repackage</goal>\n            </goals>\n        </execution>\n    </executions>\n</plugin>

\n\n

Exécutez mvn clean package et vous obtiendrez un JAR prêt à l'emploi. Spring Boot s'occupe de tout : dépendances, manifeste, et même le chargement des ressources.

\n\n

Comparatif des méthodes

\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n

Plugin	Avantages	Inconvénients
maven-assembly-plugin	Simple, fiable, idéal pour les débutants	Peut créer des conflits de fichiers (META-INF)
maven-shade-plugin	Renommage de packages, évite les conflits	Configuration plus complexe
Spring Boot Maven Plugin	Automatique, optimisé pour Spring	Nécessite Spring Boot

\n\n

Dépannage des erreurs courantes

\n\n

Erreur : « No main manifest attribute »
\nSolution : Vérifiez que vous avez bien spécifié <mainClass> dans la configuration du plugin.

\n\n

Erreur : « Class path contains multiple SLF4J bindings »
\nSolution : Utilisez maven-shade-plugin avec l'option <transformers> pour fusionner les fichiers de configuration.

\n\n

Erreur : « ZipException: invalid LOC header »
\nSolution : Supprimez le dossier target et relancez la construction avec mvn clean package.

\n\n

Conclusion

\n\n

Créer un JAR exécutable avec toutes ses dépendances dans Maven n'est pas sorcier, une fois que l'on connaît les bons plugins. Que vous choisissiez maven-assembly-plugin pour sa simplicité, maven-shade-plugin pour sa flexibilité, ou Spring Boot Maven Plugin pour son automatisation, vous pouvez désormais partager vos applications Java sans craindre les erreurs de classe manquante.

\n\n

Et vous, quelle méthode utilisez-vous ? Partagez votre expérience dans les commentaires !