• Beranda
  • Artikel
  • Umum
  • Gunakan "maven-shade-plugin" untuk Membuat hanya 1 toples yang dapat dieksekusi dengan semua Dependensi yang diperlukan di dalamnya untuk Proyek Java atau Musim Semi Anda?

Gunakan "maven-shade-plugin" untuk Membuat hanya 1 toples yang dapat dieksekusi dengan semua Dependensi yang diperlukan di dalamnya untuk Proyek Java atau Musim Semi Anda?

Diterbitkan: 2016-11-16

maven-shade-plugin-cara-membuat-javaspring-based-executable-jar-with-all-required-dependencies

Cukup buat satu file Crunchify.jar dengan semua dependensi di dalamnya

Minggu lalu saya menulis tutorial tentang cara menggunakan maven-resources-plugin , maven-dependency-plugin & maven-jar-plugin untuk menghasilkan Proyek Jar lengkap yang dapat dieksekusi? Akibatnya ia membuat / menyalin semua file yang diperlukan ke folder /target/Crunchify .

Before: Menggunakan plugin maven-resource, maven-dependency, maven-jar:

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

After: Menggunakan plugin maven-shade:

buat-just-1-executable-jar-with-all-required-dependencies-properties-and-resources-file-in-it-for-your-Java-or-spring-project

Mari kita mulai bagaimana mencapai hasil di atas:

Di sini seperti yang Anda lihat, kami telah menggabungkan semuanya dari Proyek Java menjadi just one file dan kami telah memberi nama Crunchify.jar (dengan semua file di dalamnya).

Beberapa hari yang lalu saya tidak tahu bagaimana mencapainya karena saya ingin membuat runnable binary distribution of a standalone Java application dengan menggunakan Maven. Dengan kata lain:

  1. Bagaimana cara membuat toples yang dapat dieksekusi berbasis pegas dengan maven?
  2. Membuat Distribusi Biner yang Dapat Dijalankan Dengan Maven untuk Java + Spring + Dependensi lainnya
  3. Bagaimana Cara Membangun Proyek Java + Spring dengan Maven?

Biasanya di Maven, kami mengandalkan manajemen ketergantungan. Artefak hanya berisi kelas/sumber daya itu sendiri. Maven akan bertanggung jawab untuk mengetahui semua artefak (JAR dll) yang bergantung pada proyek, saat kompilasi dan untuk menjalankan dll.

Dengan bantuan maven -shade- plugin saya dapat mencapai tujuan ini . Ini menyediakan kemampuan untuk mengemas artefak dalam uber-jar (One major file jar) , termasuk dependensinya dan untuk menaungi – yaitu mengganti nama – paket dari beberapa dependensi.

Dalam proyek saya, saya memiliki begitu banyak dependensi lain, yaitu Spring Framework, JSON, alat Pihak ke-3, dll. Di bawah ini hanyalah proyek sampel tetapi file .jar produksi saya menjadi ~5.2MB big .

Sebuah uber-jar adalah sesuatu yang mengambil semua dependensi, dan mengekstrak konten dependensi dan memasukkannya ke dalam satu JAR, dengan kelas/sumber daya dari proyek itu sendiri. Dengan memiliki uber-jar seperti itu, easy for execution , karena Anda hanya memerlukan satu JAR besar daripada berton-ton JAR kecil untuk menjalankan aplikasi Anda. Ini juga memudahkan distribusi dalam beberapa kasus.

Untuk mencapai ini, Anda perlu memperbarui file pom.xml Anda.

Langkah 1

Lihatlah file pom.xml lengkap. Terutama Anda akan tertarik pada <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 >

Seperti yang Anda lihat di sini, saya menggunakan Resource Transformers dalam file pom.xml. Menggabungkan classes/resources dari beberapa artefak menjadi satu Crunchify JAR dapat dilakukan dengan mudah selama tidak ada tumpang tindih. Jika tidak, beberapa jenis logika untuk menggabungkan sumber daya dari beberapa JAR diperlukan. Di sinilah transformator sumber daya berperan.

Langkah 2

Setelah Anda menambahkan maven-shade-plugin ke file pom.xml Anda, gunakan saja perintah di bawah ini untuk membangun proyek Anda.

1
mvn clean install

Dan Anda akan melihat satu Crunchify.jar (uber-jar) dibuat dengan all dependencies mentioned in pom.xml file dalamnya.

Langkah-3

Buka folder target proyek Anda dan Anda akan melihat file Crunchify.jar telah dibuat. Cukup gunakan perintah

$bash> java -jar Crunchify.jar untuk menjalankan proyek Anda.

Apakah Anda memiliki sesuatu untuk ditambahkan? Tambahkan ke bagian komentar di bawah. Selamat menikmati, Semoga harimu menyenangkan dan Selamat Coding.