• Page d'accueil
  • Des articles
  • Général
  • Utilisez "maven-shade-plugin" pour créer un seul fichier jar exécutable contenant toutes les dépendances requises pour votre projet Java ou Spring ?

Utilisez "maven-shade-plugin" pour créer un seul fichier jar exécutable contenant toutes les dépendances requises pour votre projet Java ou Spring ?

Publié: 2016-11-16

maven-shade-plugin-how-to-create-javaspring-based-executable-jar-with-all-required-dependencies

Créez simplement un fichier Crunchify.jar avec toutes les dépendances à l'intérieur

La semaine dernière, j'ai écrit un tutoriel sur la façon d'utiliser maven-resources-plugin , maven-dependency-plugin & maven-jar-plugin pour générer votre projet Jar exécutable complet ? En conséquence, il crée/copie tous les fichiers requis dans le dossier /target/Crunchify .

Before: Utiliser les plugins maven-resource, maven-dependency, maven-jar :

maven-resources-maven-dependency-maven-jar-plugin-to-build-java-project

After: Utilisation du plugin maven-shade :

créer-juste-1-exécutable-jar-avec-toutes-les-dépendances-requises-propriétés-et-fichier-de-ressources-dans-it-pour-votre-java-ou-spring-project

Commençons par savoir comment obtenir le résultat ci-dessus :

Ici, comme vous le voyez, nous avons regroupé tout de Java Project dans just one file et nous avons donné le nom Crunchify.jar (avec tous les fichiers à l'intérieur).

Il y a quelques jours, je n'avais aucune idée de la façon d'y parvenir car je voulais créer une runnable binary distribution of a standalone Java application en utilisant Maven. Autrement dit:

  1. Comment créer un jar exécutable à base de ressort avec maven?
  2. Création d'une distribution binaire exécutable avec Maven pour Java + Spring + autres dépendances
  3. Comment créer des projets Java + Spring avec Maven ?

Normalement, dans Maven, nous nous appuyons sur la gestion des dépendances. Un artefact ne contient que les classes/ressources de lui-même. Maven sera chargé de découvrir tous les artefacts (JAR, etc.) dont le projet dépend, lors de la compilation et de l'exécution, etc.

Avec l'aide de maven -shade- plugin , j'ai pu atteindre cet objectif . Il offre la possibilité de conditionner l'artefact dans un uber-jar (One major file jar) , y compris ses dépendances et de masquer - c'est-à-dire de renommer - les packages de certaines des dépendances.

Dans mon projet, j'ai tellement d'autres dépendances, c'est-à-dire Spring Framework, JSON, des outils ~5.2MB big , etc.

Un uber-jar est quelque chose qui prend toutes les dépendances, extrait le contenu des dépendances et le place dans un seul JAR, avec les classes/ressources du projet lui-même. En ayant un tel uber-jar, il est easy for execution , car vous n'aurez besoin que d'un seul gros JAR au lieu de tonnes de petits JAR pour exécuter votre application. Cela facilite également la distribution dans certains cas.

Pour ce faire, vous devez mettre à jour votre fichier pom.xml.

Étape 1

Jetez un œil au fichier pom.xml complet. Vous seriez principalement intéressé par <build> .

pom.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
< project xmlns = "http://maven.apache.org/POM/4.0.0" xmlns : xsi = "http://www.w3.org/2001/XMLSchema-instance"
xsi : schemaLocation = "http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd" >
< modelVersion > 4.0.0 < / modelVersion >
< groupId > CrunchifyMavenBuildPlugins < / groupId >
< artifactId > CrunchifyMavenBuildPlugins < / artifactId >
< version > 0.0.1 - SNAPSHOT < / version >
< name > CrunchifyMavenBuildPlugins < / name >
 
< properties >
< project . build . sourceEncoding > UTF - 8 < / project . build . sourceEncoding >
< / properties >
 
< dependencies >
< dependency >
< groupId > log4j < / groupId >
< artifactId > log4j < / artifactId >
< version > 1.2.17 < / version >
< / dependency >
< dependency >
< groupId > com . googlecode . json - simple < / groupId >
< artifactId > json - simple < / artifactId >
< version > 1.1 < / version >
< / dependency >
< dependency >
< groupId > axis < / groupId >
< artifactId > axis < / artifactId >
< version > 1.4 < / version >
< / dependency >
< dependency >
< groupId > commons - beanutils < / groupId >
< artifactId > commons - beanutils < / artifactId >
< version > 1.8.3 < / version >
< / dependency >
< dependency >
< groupId > commons - collections < / groupId >
< artifactId > commons - collections < / artifactId >
< version > 3.2.1 < / version >
< / dependency >
< dependency >
< groupId > commons - configuration < / groupId >
< artifactId > commons - configuration < / artifactId >
< version > 1.10 < / version >
< / dependency >
< dependency >
< groupId > commons - io < / groupId >
< artifactId > commons - io < / artifactId >
< version > 2.4 < / version >
< / dependency >
< dependency >
< groupId > javax . mail < / groupId >
< artifactId > mail < / artifactId >
< version > 1.4.7 < / version >
< / dependency >
< dependency >
< groupId > javax . servlet < / groupId >
< artifactId > servlet - api < / artifactId >
< version > 2.5 < / version >
< / dependency >
< dependency >
< groupId > org . json < / groupId >
< artifactId > json < / artifactId >
< version > 20140107 < / version >
< / dependency >
< dependency >
< groupId > axis < / groupId >
< artifactId > axis - saaj < / artifactId >
< version > 1.4 < / version >
< / dependency >
< dependency >
< groupId > wsdl4j < / groupId >
< artifactId > wsdl4j < / artifactId >
< version > 1.6.3 < / version >
< / dependency >
< dependency >
< groupId > com . google . zxing < / groupId >
< artifactId > core < / artifactId >
< version > 2.0 < / version >
< / dependency >
< / dependencies >
 
< build >
< pluginManagement >
< plugins >
< plugin >
< groupId > org . apache . maven . plugins < / groupId >
< artifactId > maven - compiler - plugin < / artifactId >
< version > 2.3.1 < / version >
< configuration >
< source > 1.7 < / source >
< target > 1.7 < / target >
< / configuration >
< / plugin >
< / plugins >
< / pluginManagement >
< plugins >
< plugin >
< groupId > org . apache . maven . plugins < / groupId >
< artifactId > maven - shade - plugin < / artifactId >
< version > 1.7 < / version >
< executions >
< execution >
< phase > package < / phase >
< goals >
< goal > shade < / goal >
< / goals >
< configuration >
< ! -- Optional Start -- >
< finalName > Crunchify < / finalName >
< shadedArtifactAttached > true < / shadedArtifactAttached >
< shadedClassifierName > jar - with - dependencies < / shadedClassifierName >
< ! -- Optional End -- >
< transformers >
< transformer implementation = "org.apache.maven.plugins.shade.resource.ManifestResourceTransformer" >
< mainClass > com . crunchify . tutorial . CrunchifyMain < / mainClass >
< / transformer >
< transformer implementation = "org.apache.maven.plugins.shade.resource.AppendingTransformer" >
     < resource > META - INF / spring . handlers < / resource >
< / transformer >
< transformer implementation = "org.apache.maven.plugins.shade.resource.AppendingTransformer" >
     < resource > META - INF / spring . schemas < / resource >
< / transformer >
< transformer implementation = "org.apache.maven.plugins.shade.resource.AppendingTransformer" >
     < resource > META - INF / spring . tooling < / resource >
< / transformer >
< / transformers >
< / configuration >
< / execution >
< / executions >
< / plugin >
 
< / plugins >
< / build >
< / project >

Comme vous pouvez le voir ici, j'utilise Resource Transformers dans le fichier pom.xml. L'agrégation de classes/resources de plusieurs artefacts dans un Crunchify JAR est simple tant qu'il n'y a pas de chevauchement. Sinon, une sorte de logique pour fusionner les ressources de plusieurs fichiers JAR est nécessaire. C'est là que les transformateurs de ressources entrent en jeu.

Étape 2

Une fois que vous avez ajouté maven-shade-plugin à votre fichier pom.xml , utilisez simplement la commande ci-dessous pour créer votre projet.

1
mvn clean install

Et vous devriez voir un Crunchify.jar (uber-jar) créé avec all dependencies mentioned in pom.xml file intérieur.

Étape 3

Accédez au dossier cible de votre projet et vous verrez le fichier Crunchify.jar créé. Utilisez simplement la commande

$bash> java -jar Crunchify.jar pour exécuter votre projet.

Avez-vous quelque chose à ajouter? Ajoutez-le à la section des commentaires ci-dessous. Profitez-en, passez une bonne journée et bon codage.