maven-assembly-plugin 打包的配置

时间:2022-03-31 12:49:48
 

maven的工程的创建以及生命周期

https://www.jianshu.com/p/fd43b3d0fdb0

当你使用 Maven 对项目打包时,你需要了解以下 3 个打包 plugin,它们分别是

plugin function
maven-jar-plugin maven 默认打包插件,用来创建 project jar
maven-shade-plugin 用来打可执行包,executable(fat) jar
maven-assembly-plugin 支持定制化打包方式,例如 apache 项目的打包方式

下面我们就简单介绍一下 maven-assembly-plugin。

使用方法

  • 使用 descriptorRefs(官方提供的定制化打包方式),官方提供的 descriptorRef 有 bin, jar-with-dependencies, src, project。【不建议使用】
<project>
[...]
<build>
[...]
<plugins>
<plugin>
<!-- NOTE: We don't need a groupId specification because the group is
org.apache.maven.plugins ...which is assumed by default.
-->

<artifactId>maven-assembly-plugin</artifactId>
<version>3.0.0</version>
<configuration>
<descriptorRefs>
<descriptorRef>jar-with-dependencies</descriptorRef>
</descriptorRefs>
</configuration>
[...]
</project>

  • 使用 descriptors,指定打包文件 src/assembly/src.xml,在该配置文件内指定打包操作。
<project>  [...]  <build>    [...]    <plugins>      <plugin>        <artifactId>maven-assembly-plugin</artifactId>        <version>3.0.0</version>        <configuration>          <descriptors>            <descriptor>src/assembly/src.xml</descriptor>          </descriptors>        </configuration>        [...]</project>

描述符文件元素

id

<id>release</id>

id 标识符,添加到生成文件名称的后缀符。如果指定 id 的话,目标文件则是 ${artifactId}-${id}.tar.gz

formats

maven-assembly-plugin 支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war,可以同时指定多个打包格式

  <formats>    <format>tar.gz</format>    <format>dir</format>  </formats>

dependencySets

用来定制工程依赖 jar 包的打包方式,核心元素如下表所示。

元素 类型 作用
outputDirectory String 指定包依赖目录,该目录是相对于根目录
includes/include* List<String> 包含依赖
excludes/exclude* List<String> 排除依赖
<dependencySets>    <dependencySet>      <outputDirectory>/lib</outputDirectory>    </dependencySet>  </dependencySets>

fileSets

管理一组文件的存放位置,核心元素如下表所示。

元素 类型 作用
outputDirectory String 指定文件集合的输出目录,该目录是相对于根目录
includes/include* List<String> 包含文件
excludes/exclude* List<String> 排除文件
fileMode String 指定文件属性,使用八进制表达,分别为(User)(Group)(Other)所属属性,默认为 0644
  <fileSets>
<fileSet>
<includes>
<include>bin/**</include>
</includes>
<fileMode>0755</fileMode>
</fileSet>

<fileSet>
<includes>
<include>/conf/**</include>
<include>logs</include>
</includes>
</fileSet>

</fileSets>

files

可以指定目的文件名到指定目录,其他和 fileSets 相同,核心元素如下表所示。

元素 类型 作用
source String 源文件,相对路径或绝对路径
outputDirectory String 输出目录
destName String 目标文件名
fileMode String 设置文件 UNIX 属性
 <files>
<file>
<source>README.txt</source>
<outputDirectory>/</outputDirectory>
</file>
</files>
例子:

pom.xml

<build>  <finalName>scribe-log4j2-test</finalName>  <plugins>    <plugin>      <groupId>org.apache.maven.plugins</groupId>      <artifactId>maven-compiler-plugin</artifactId>    </plugin>    <plugin>      <groupId>org.apache.maven.plugins</groupId>      <artifactId>maven-assembly-plugin</artifactId>      <configuration>        <descriptors>          <descriptor>src/main/assembly/release.xml</descriptor>        </descriptors>      </configuration>      <executions>        <execution>          <id>make-assembly</id> <!-- this is used for inheritance merges -->          <phase>package</phase> <!-- bind to the packaging phase -->          <goals>            <goal>single</goal>          </goals>        </execution>      </executions>    </plugin>  </plugins></build>

release.xml

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.3 http://maven.apache.org/xsd/assembly-1.1.3.xsd">  <formats>    <format>tar.gz</format>    <format>dir</format>  </formats>  <dependencySets>    <dependencySet>      <outputDirectory>/lib</outputDirectory>    </dependencySet>  </dependencySets>  <fileSets>    <fileSet>      <includes>        <include>bin/**</include>      </includes>      <fileMode>0755</fileMode>    </fileSet>    <fileSet>      <includes>        <include>/conf/**</include>        <include>logs</include>      </includes>    </fileSet>  </fileSets>  <files>    <file>      <source>README.txt</source>      <outputDirectory>/</outputDirectory>    </file>  </files></assembly>

最终创建生成可执行二进制工程


2、http://blog.csdn.net/WANGYAN9110/article/details/38646677
 

使用场景

在使用maven来管理项目时,项目除了web项目,还有可能为控制台程序,一般用于开发一些后台服务的程序。最近在工作中也遇到了这种场景,使用quartz开发一个任务调度程序。程序中依赖很多jar包,项目的启动时只需要初始化spring容器即可。

使用方法

使用一个简单的基于spring框架的demo来做程序示例,来介绍maven assembly插件的使用方法。
项目中的代码目录如下:

maven-assembly-plugin 打包的配置

在以上代码目录中,assembly目录下为打包的描述文件,下面会详细介绍该文件,bin目录下为启动脚本以及readme等文件,main下为maven标准中建立的文件,java代码以及配置文件位于该目录下。
打包完成后压缩包目录如下:

maven-assembly-plugin 打包的配置

打包完成后,我们可以看到bin目录来存放启动脚本等文件,config为配置文件,lib下为运行时依赖的jar包。
使用maven assembly插件需要在pom文件中配置,添加这个插件

            <plugin>                <artifactId>maven-assembly-plugin</artifactId>                <version>2.4.1</version>                <executions>                    <execution>                        <id>make-zip</id>                        <!-- 绑定到package生命周期阶段上 -->                        <phase>package</phase>                        <goals>                            <!-- 绑定到package生命周期阶段上 -->                            <goal>single</goal>                        </goals>                        <configuration>                            <descriptors> <!--描述文件路径-->                                <descriptor>src/assembly/assembly.xml</descriptor>                            </descriptors>                        </configuration>                    </execution>                </executions>            </plugin>

其中execution节点,我们配置了执行maven assembly插件的一些配置,descriptor节点配置指向assembly.xml的路径。
在assembly.xml配置了,我们打包的目录以及相应的设置

<assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"          xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">    <id>distribution</id>    <formats>        <format>zip</format>    </formats>    <fileSets>        <fileSet>            <directory>${project.basedir}\src\main\resources</directory>            <outputDirectory>\</outputDirectory>        </fileSet>        <fileSet>            <directory>${project.basedir}\src\bin</directory>            <outputDirectory>\bin</outputDirectory>        </fileSet>    </fileSets>    <dependencySets>        <dependencySet>            <useProjectArtifact>true</useProjectArtifact>            <outputDirectory>lib</outputDirectory>            <!-- 将scope为runtime的依赖包打包到lib目录下。 -->            <scope>runtime</scope>        </dependencySet>    </dependencySets></assembly>

assembly.xml的配置项非常多,可以参考http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
以上只是用了很少的一部分。
format设置包输出的格式,以上格式设置的为zip格式,目前还支持zip,tar,tar.gz,tar.bz2,jar,dir,war格式
fileSet定义代码目录中与输出目录的映射,在该节点下还有 <includes/>,<excludes/>两个非常有用的节点。
比如:

        <fileSet>            <directory>${project.basedir}\src\main\resources</directory>            <outputDirectory>\</outputDirectory>            <includes>                <include>some/path</include>            </includes>            <excludes>                <exclude>some/path1</exclude>            </excludes>        </fileSet>

以上代码表示归档时包括some/path,不包括some/path1
dependencySets节点下为依赖设置
在上述配置中,表示所有运行时依赖的jar包归档到lib目录下。在上述截图中lib目录下的文件就是所有依赖的jar包
maven-assembly-plugin 打包的配置