使用maven-assembly-plugin如何打包多模塊項目

更新時間：2022年03月21日 14:03:40 作者：meaijojo

這篇文章主要介紹了使用maven-assembly-plugin如何打包多模塊項目，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教

maven-assembly-plugin打包多模塊項目

概述

maven-assembly-plugin 是目前maven項目中最常用的打包工具，它便利、配置簡單，因此可以滿足我們大部分的需求。

實際開發(fā)過程中大部分Maven項目都是多模塊的，因為工作需要，對其進(jìn)行了研究與嘗試，目前可以將多模塊按照自己需求打包到一起。

1. 需求

項目本身代碼非常復(fù)雜，最深可以到三層模塊，即GrandFather -> Parent -> child，要求打包后的結(jié)構(gòu)如下：

????

目錄的含義不

再追溯，下面直接將打包方法。

2. 打包流程

2.1 新建打包模塊

Maven多模塊打包在一起時，需要新建一個專門用于打包的模塊，該模塊不需要有任何Java代碼，只需要配置一些最終形成的環(huán)境即可。但是該模塊有一個非常重要的要求：該模塊必須是整個項目最后一個進(jìn)行打包的。

可以通過配置pom.xml中加載模塊的順序來控制，最后配置進(jìn)入的即最后進(jìn)行打包的：

本人項目比較復(fù)雜，最終配置的打包是在tools子模塊下的tools-package模塊中進(jìn)行配置。

2.2 配置打包模塊

根據(jù)最終生成的路徑需求，將所有的相關(guān)路徑及一些命令、配置文件等按照要求在打包模塊中實現(xiàn)，放在resources目錄即可。

注：該項目中不需要任何Java代碼

2.3 配置打包模塊的pom.xml

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-assembly-plugin</artifactId>
                <version>2.4.1</version>
                <executions>
                    <execution>
                        <id>make-assembly</id>
                        <phase>package</phase>
                        <goals>
                            <goal>single</goal>
                        </goals>
                        <configuration>
                            <finalName>xxxxx</finalName>
                            <descriptors>
                                <descriptor>src/main/resources/assemble/assemble.xml</descriptor>
                            </descriptors>
                        </configuration>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

2.4 配置其他模塊打包方式

因為項目中使用的SpringBoot，SpringBoot也提供了一種打包方式：spring-boot-maven-plugin，這種方式打包時會將該項目中所有依賴的包（包括靜態(tài)文件）統(tǒng)一打包至一個jar中，這個不是我們項目的需求，我們的需求是將所有的jar包（包括第三方及當(dāng)前項目的jar包）都放在lib目錄，且是單獨存在。

因此需要將其他模塊的打包配置修改，修改分為兩步：

1）不再使用spring-boot-maven-plugin進(jìn)行打包，即將其從pom.xml中刪除；

2）在pom.xml文件中使用maven-jar-plugin進(jìn)行打包，該打包如何配置請參考文章（待定）。

2.5 配置assemble.xml文件

assemble.xml文件中描述了具體如何打包，該打包過程和實際需求關(guān)系密切

<?xml version='1.0' encoding='UTF-8'?>
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0
                    http://maven.apache.org/xsd/assembly-1.1.0.xsd">
    <id>${project.version}</id>
    <formats>
        <format>tar.gz</format>
    </formats>
    <includeBaseDirectory>true</includeBaseDirectory>
    <moduleSets>
        <moduleSet>
            <useAllReactorProjects>true</useAllReactorProjects>
            <includes>
                <include>xxx.xx.x:base1</include>
                <include>xxx.xx.x:base2</include>
                <include>xxx.xx.x:base3</include>
                <include>xxx.xx.x:base4</include>
            </includes>
            <binaries>
                <outputDirectory>lib</outputDirectory>
                <unpack>false</unpack>
            </binaries>
        </moduleSet>
    </moduleSets>
    <fileSets>
        <fileSet>
            <directory>src/main/resources/bin</directory>
            <outputDirectory>bin</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>src/main/resources/conf</directory>
            <outputDirectory>conf</outputDirectory>
        </fileSet>
        <fileSet>
            <directory>src/main/resources/docs</directory>
            <outputDirectory>docs</outputDirectory>
        </fileSet><fileSet>
        <directory>src/main/resources/keys</directory>
        <outputDirectory>keys</outputDirectory>
    </fileSet>
        <fileSet>
            <includes>
                <include>README.md</include>
            </includes>
            <outputDirectory></outputDirectory>
        </fileSet>
    </fileSets>
    <dependencySets>
        <dependencySet>
            <unpack>false</unpack>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <scope>provided</scope>
        </dependencySet>
        <dependencySet>
            <unpack>false</unpack>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <scope>system</scope>
        </dependencySet>
        <dependencySet>
            <unpack>false</unpack>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>
</assembly>

具體的配置參數(shù)可以查看 https://maven.apache.org/plugins/maven-assembly-plugin/assembly.html

本人在實驗過程中重點是處理了dependencySet這個配置：

<dependencySets>
        <dependencySet>
            <unpack>false</unpack>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <scope>provided</scope>
        </dependencySet>
        <dependencySet>
            <unpack>false</unpack>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <scope>system</scope>
        </dependencySet>
        <dependencySet>
            <unpack>false</unpack>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>

請配置上上述三個部分，要不然總是會缺少一些依賴包打不進(jìn)來，Mark一下，很重要！

使用maven-assembly-plugin插件來定制化打包

簡單的說，maven-assembly-plugin 就是用來幫助打包用的，比如說打出一個什么類型的包，包里包括哪些內(nèi)容等等。

目前至少支持以下打包類型：

zip
tar
tar.gz
tar.bz2
jar
dir
war

默認(rèn)情況下，打jar包時，只有在類路徑上的文件資源會被打包到j(luò)ar中，并且文件名是${artifactId}-${version}.jar，下面看看怎么用maven-assembly-plugin插件來定制化打包。

首先需要添加插件聲明：

<plugin>
? ? <groupId>org.apache.maven.plugins</groupId>
? ? <artifactId>maven-assembly-plugin</artifactId>
? ? <version>2.4</version>
? ? <executions>
? ? ? ? <execution>
? ? ? ? ? ? <!-- 綁定到package生命周期階段上 -->
? ? ? ? ? ? <phase>package</phase>
? ? ? ? ? ? <goals>
? ? ? ? ? ? ? ? <!-- 綁定到package生命周期階段上 -->
? ? ? ? ? ? ? ? <goal>single</goal>
? ? ? ? ? ? </goals>
? ? ? ? </execution>
? ? </executions>
</plugin>

使用內(nèi)置的Assembly Descriptor

要使用maven-assembly-plugin，需要指定至少一個要使用的assembly descriptor 文件。默認(rèn)情況下，maven-assembly-plugin內(nèi)置了幾個可以用的assembly descriptor：

bin ：類似于默認(rèn)打包，會將bin目錄下的文件打到包中；
jar-with-dependencies ：會將所有依賴都解壓打包到生成物中；
src ：只將源碼目錄下的文件打包；
project ：將整個project資源打包。

要查看它們的詳細(xì)定義，可以到maven-assembly-plugin-2.4.jar里去看，例如對應(yīng) bin 的assembly descriptor 如下：

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
? ? xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
? ? xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
? ? <id>bin</id>
? ? <formats>
? ? ? ? <format>tar.gz</format>
? ? ? ? <format>tar.bz2</format>
? ? ? ? <format>zip</format>
? ? </formats>
? ? <fileSets>
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.basedir}</directory>
? ? ? ? ? ? <outputDirectory>/</outputDirectory>
? ? ? ? ? ? <includes>
? ? ? ? ? ? ? ? <include>README*</include>
? ? ? ? ? ? ? ? <include>LICENSE*</include>
? ? ? ? ? ? ? ? <include>NOTICE*</include>
? ? ? ? ? ? </includes>
? ? ? ? </fileSet>
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.build.directory}</directory>
? ? ? ? ? ? <outputDirectory>/</outputDirectory>
? ? ? ? ? ? <includes>
? ? ? ? ? ? ? ? <include>*.jar</include>
? ? ? ? ? ? </includes>
? ? ? ? </fileSet>
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.build.directory}/site</directory>
? ? ? ? ? ? <outputDirectory>docs</outputDirectory>
? ? ? ? </fileSet>
? ? </fileSets>
</assembly>

自定義Assembly Descriptor

一般來說，內(nèi)置的assembly descriptor都不滿足需求，這個時候就需要寫自己的assembly descriptor的實現(xiàn)了。先從一個最簡單的定義開始：

<?xml version='1.0' encoding='UTF-8'?>
<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
? ? xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
? ? xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 ?
? ? ? ? ? ? ? ? ? ? http://maven.apache.org/xsd/assembly-1.1.0.xsd">
? ? <id>demo</id>
? ? <formats>
? ? ? ? <format>jar</format>
? ? </formats>
? ? <includeBaseDirectory>false</includeBaseDirectory>
? ? <fileSets>
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.build.directory}/classes</directory>
? ? ? ? ? ? <outputDirectory>/</outputDirectory>
? ? ? ? </fileSet>
? ? </fileSets>
</assembly>

這個定義很簡單：

format：指定打包類型；
includeBaseDirectory：指定是否包含打包層目錄（比如finalName是output，當(dāng)值為true，所有文件被放在output目錄下，否則直接放在包的根目錄下）；
fileSets：指定要包含的文件集，可以定義多個fileSet；
directory：指定要包含的目錄；
outputDirectory：指定當(dāng)前要包含的目錄的目的地。

要使用這個assembly descriptor，需要如下配置：

<configuration> ?
? ? <finalName>demo</finalName> ?
? ? <descriptors>
? ? ? ? <!--描述文件路徑-->
? ? ? ? <descriptor>assemblies/demo.xml</descriptor> ?
? ? </descriptors> ?
? ? <outputDirectory>output</outputDirectory>
</configuration>?

最后會生成一個demo-demo.jar 文件在目錄 output 下，其中前一個demo來自finalName，后一個demo來自assembly descriptor中的id，其中的內(nèi)容和默認(rèn)的打包出來的jar類似。

如果只想有finalName，則增加配置：

<appendAssemblyId>false</appendAssemblyId> ?

添加文件

上面演示了添加所有編譯后的資源，同樣的可以增加其他資源，例如想添加當(dāng)前工程目錄下的某個文件 b.txt ，在assembly descriptor的assembly結(jié)點下增加

<files>
? ? <file>
? ? ? ? <source>b.txt</source>
? ? ? ? <outputDirectory>/</outputDirectory>
? ? </file>
</files>

這里用到了 files 元素類型，可以想象 fileSets 下的結(jié)點都是針對文件夾的；files 下的結(jié)點都是針對文件的。

也可以改變打包后的文件名，例如上面的 b.txt ，希望打包后的名字為 b.txt.bak，只需要在file 里添加以下配置：

<destName>b.txt.bak</destName>

排除文件

在 fileSet 里可以使用 includes 和 excludes 來更精確的控制哪些文件要添加，哪些文件要排除。

例如要排除某個目錄下所有的txt文件：

<fileSet> ?
? ? <directory>${project.build.directory}/classes</directory> ?
? ? <outputDirectory>/</outputDirectory> ?
? ? <excludes> ?
? ? ? ? <exclude>**/*.txt</exclude> ?
? ? </excludes> ?
</fileSet>

或者某個目錄下只想 .class 文件：

<fileSet>
? ? <directory>${project.build.directory}/classes</directory>
? ? <outputDirectory>/</outputDirectory>
? ? <includes>
? ? ? ? <include>**/*.class</include>
? ? </includes>
</fileSet>

添加依賴

如果想把一些依賴庫打到包里，可以用 dependencySets 元素，例如最簡單的，把當(dāng)前工程的所有依賴都添加到包里：

<dependencySets>
? ? <dependencySet>
? ? ? ? <outputDirectory>/</outputDirectory>
? ? </dependencySet>
</dependencySets>

在assembly下添加以上配置，則當(dāng)前工程的依賴和工程本身生成的jar都會被打包進(jìn)來。

如果要排除工程自身生成的jar，則可以添加

<useProjectArtifact>false</useProjectArtifact>

unpack參數(shù)可以控制依賴包是否在打包進(jìn)來時是否解開，例如解開所有包，添加以下配置：

<unpack>true</unpack>

和 fileSet 一樣，可以使用 excludes 和 includes 來更詳細(xì)的控制哪些依賴需要打包進(jìn)來；另外 useProjectAttachments，useTransitiveDependencies，useTransitiveFiltering等參數(shù)可以對間接依賴、傳遞依賴進(jìn)行控制。

其他選項

moduleSets：當(dāng)有子模塊時候用；
repositories：想包含庫的時候用；
containerDescriptorHandlers：可以進(jìn)行一些合并，定義ArtifactHandler之類的時候可以用，（可以參考：說明）；
componentDescriptors：如上所述，可以包含一些componentDescriptor定義，這些定義可以被多個assembly共享。

Assembly Plugin更多配置

上面已經(jīng)看到了一些Assembly Plugin本身的配置，例如 finalName， outputDirectory， appendAssemblyId 和 descriptors 等，除了這些還有其他的一些可配置參數(shù)，參見：single，其中某些參數(shù)會覆蓋在assembly descriptor 中的參數(shù)。有一個比較有用的參數(shù)是： archive，它的詳細(xì)配置在：archive。

下面介紹一些archive的用法。

指定Main-Class

archive的一個重要用處就是配置生成的MANIFEST.MF文件。默認(rèn)會生成一個MANIFEST.MF文件，不過這個文件默認(rèn)值沒什么意義。如果想指定生成jar的Main-Class，可以如下配置：

<archive> ?
? ? <manifest> ?
? ? ? ? <mainClass>demo.DemoMain</mainClass> ?
? ? </manifest> ?
</archive>

下面來看一個項目中實際配置的文件：

pom文件：

<plugin> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? <groupId>org.apache.maven.plugins</groupId> ? ? ? ? ? ? ? ? ? ? ? ??
? ? <artifactId>maven-assembly-plugin</artifactId> ? ? ? ? ? ? ? ? ? ? ?
? ? <version>${maven-assembly-plugin.version}</version> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? <configuration> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
? ? ? ? <descriptors> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
? ? ? ? ? ? <descriptor>package.xml</descriptor> ? ? ? ? ? ? ? ? ? ? ? ?
? ? ? ? </descriptors> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? </configuration> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? <executions> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? ? ? <execution> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
? ? ? ? ? ? <id>make-assembly</id> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? ? ? ? ? <phase>package</phase> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? ? ? ? ? <goals> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
? ? ? ? ? ? ? ? <goal>single</goal> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
? ? ? ? ? ? </goals> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? ? ? </execution> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
? ? </executions> ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
</plugin> ?

assembly descriptor 文件：

<assembly>
? ? <id>${assembly-id}</id>
? ? <!-- 最終打包成一個用于發(fā)布的war文件 -->
? ? <formats>
? ? ? ? <format>${assembly-format}</format>
? ? </formats>
? ? <fileSets>
? ? ? ? <!-- 把項目公用的配置文件，打包進(jìn)zip文件的config目錄 -->
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.basedir}/src/main/resources/base</directory>
? ? ? ? ? ? <outputDirectory>WEB-INF/classes</outputDirectory>
? ? ? ? </fileSet>
? ? ? ? <!-- 把項目環(huán)境的配置文件，打包進(jìn)zip文件的config目錄 -->
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.basedir}/src/main/resources/${env}</directory>
? ? ? ? ? ? <outputDirectory>WEB-INF/classes</outputDirectory>
? ? ? ? </fileSet>
? ? ? ? <!-- 打包項目自己編譯出來的jar文件 -->
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.build.directory}</directory>
? ? ? ? ? ? <outputDirectory>WEB-INF/lib</outputDirectory>
? ? ? ? ? ? <includes>
? ? ? ? ? ? ? ? <include>*.jar</include>
? ? ? ? ? ? </includes>
? ? ? ? </fileSet>
? ? ? ? <!-- 打包項目依賴的jar文件 -->
? ? ? ? <fileSet>
? ? ? ? ? ? <directory>${project.build.directory}</directory>
? ? ? ? ? ? <outputDirectory>/</outputDirectory>
? ? ? ? ? ? <includes>
? ? ? ? ? ? ? ? <include>WEB-INF/lib/*.jar</include>
? ? ? ? ? ? </includes>
? ? ? ? </fileSet>
? ? </fileSets>
</assembly>

以上為個人經(jīng)驗，希望能給大家一個參考，也希望大家多多支持腳本之家。

您可能感興趣的文章: