一、背景
最近我們項目越來越多了,然后我就在想如何才能把基礎服務的打包方式統一起來,並且可以實現按照我們的要求來生成,通過研究,我們通過使用maven的assembly插件完美的實現了該需求,爽爆了有木有。本文分享該插件的配置以及微服務的統一打包方式。
二、配置步驟及其他事項
1.首先我們需要在pom.xml中配置maven的assembly插件
1 <build>
2 <plugins>
3 <plugin>
4 <groupId>org.apache.maven.plugins</groupId>
5 <artifactId>maven-jar-plugin</artifactId>
6 <version>2.3.1</version>
7 <configuration>
8 <archive>
9 <manifest>
10 <!--運行jar包時運行的主類,要求類全名-->
11 <mainClass>com.hafiz.Runner</mainClass>
12 <!-- 是否指定項目classpath下的依賴 -->
13 <addClasspath>true</addClasspath>
14 <!-- 指定依賴的時候聲明前綴 -->
15 <classpathPrefix>./</classpathPrefix>
16 </manifest>
17 </archive>
18 </configuration>
19 </plugin>
20 <plugin>
21 <groupId>org.apache.maven.plugins</groupId>
22 <artifactId>maven-assembly-plugin</artifactId>
23 <executions>
24 <execution><!-- 配置執行器 -->
25 <id>make-assembly</id>
26 <phase>package</phase><!-- 綁定到package生命周期階段上 -->
27 <goals>
28 <goal>single</goal><!-- 只運行一次 -->
29 </goals>
30 <configuration>
31 <finalName>${project.name}</finalName>
32 <descriptor>src/main/assembly/assembly.xml</descriptor><!--配置描述文件路徑--> 33 </configuration> 34 </execution> 35 </executions> 36 </plugin> 37 </plugins> 38 </build>
2.接着我們在src/main/assembly文件中配置assembly.xml文件
1 <assembly> 2 <id></id>
<baseDirectory>test.war</baseDirectory>
3 <formats> 4 <format>tar.gz</format><!--打包的文件格式,也可以有:war zip--> 5 </formats> 6 <!--tar.gz壓縮包下是否生成和項目名相同的根目錄--> 7 <includeBaseDirectory>true</includeBaseDirectory> 8 <dependencySets> 9 <dependencySet> 10 <!--是否把本項目添加到依賴文件夾下--> 11 <useProjectArtifact>true</useProjectArtifact> 12 <outputDirectory>lib</outputDirectory> 13 <!--將scope為runtime的依賴包打包--> 14 <scope>runtime</scope> 15 </dependencySet> 16 </dependencySets> 17 <fileSets> 18 <fileSet> 19 <directory>src/main/bin</directory> 20 <outputDirectory>/</outputDirectory> 21 </fileSet> 22 </fileSets> 23 </assembly>
其中,生成的lib文件夾下放該項目的所有依賴以及該服務jar包,src/main/bin文件夾下我們一般放start.sh和stop.sh兩個腳本文件用來開啟和關閉該服務,打包后直接放到根目錄下。生成的tar.gz文件的名字為:[maven-assembly-plugin插件中配置的finalName]-[assembly.xml配置的id(若assembly中沒有指定id,則只有前半部分)].
assembly的具體語法,請參見官網:http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
這里面涉及到如何生成可執行的jar包,具體參見:用Maven快速生成帶有依賴的可執行jar包
3.項目目錄結構
其中紅色方框內就是通過assembly插件是生成的tar.gz文件,解壓后里面的結構如下:
其中lib目錄下是本項目生成的可執行jar包以及它的所有依賴jar包。若assembly插件中配置<useProjectArtifact>為false,則不會生成assembly-demo文件夾,直接就是lib文件夾以及兩個腳本文件。
代碼Github地址:https://github.com/hafizzhang/assembly-demo.git
4.打包方式思考
我們通過這種方式,每個微服務就是一個以服務名稱命名的tar.gz文件,解壓后里面lib目錄下是該服務生成的可執行jar包以及它所有的依賴jar包,我們直接運行根目錄下start.sh和stop.sh兩個腳本文件來進行服務的開啟和關閉。風格統一,簡單明了!
三、總結
隨着微服務的越來越火,我們將服務進行細粒度拆分后,也需要很好的把服務的打包以及部署方式進行統一,這樣我們就可以走自動化發布工具來進行統一服務的管理和部署,使得越來越方便。