Maven 教程（20）— 使用maven-assembly-plugin插件来定制化打包

时间 2019-11-12

标签 maven 教程使用 assembly plugin 插件定制打包栏目 Maven 繁體版

原文原文链接

原文地址：http://www.javashuo.com/article/p-oajgbcsf-dn.htmlapache

简单的说，maven-assembly-plugin 就是用来帮助打包用的，好比说打出一个什么类型的包，包里包括哪些内容等等。app

目前至少支持如下打包类型：maven

zip
tar
tar.gz
tar.bz2
jar
dir
war
默认状况下，打jar包时，只有在类路径上的文件资源会被打包到jar中，而且文件名是${artifactId}-${version}.jar，下面看看怎么用maven-assembly-plugin插件来定制化打包。ui

首先须要添加插件声明：spa

<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>

使用内置的Assembly Descriptor
要使用maven-assembly-plugin，须要指定至少一个要使用的assembly descriptor 文件。默认状况下，maven-assembly-plugin内置了几个能够用的assembly descriptor：.net

bin ：相似于默认打包，会将bin目录下的文件打到包中；
jar-with-dependencies ：会将全部依赖都解压打包到生成物中；
src ：只将源码目录下的文件打包；
project ：将整个project资源打包。
要查看它们的详细定义，能够到maven-assembly-plugin-2.4.jar里去看，例如对应 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

通常来讲，内置的assembly descriptor都不知足需求，这个时候就须要写本身的assembly descriptor的实现了。先从一个最简单的定义开始：code

<?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>

这个定义很简单：component

format：指定打包类型；
includeBaseDirectory：指定是否包含打包层目录（好比finalName是output，当值为true，全部文件被放在output目录下，不然直接放在包的根目录下）；
fileSets：指定要包含的文件集，能够定义多个fileSet；
directory：指定要包含的目录；
outputDirectory：指定当前要包含的目录的目的地。
要使用这个assembly descriptor，须要以下配置：orm

<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，其中的内容和默认的打包出来的jar相似。

若是只想有finalName，则增长配置：

<appendAssemblyId>false</appendAssemblyId>

添加文件

上面演示了添加全部编译后的资源，一样的能够增长其余资源，例如想添加当前工程目录下的某个文件 b.txt ，在assembly descriptor的assembly结点下增长

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

这里用到了 files 元素类型，能够想象 fileSets 下的结点都是针对文件夹的；files 下的结点都是针对文件的。

也能够改变打包后的文件名，例如上面的 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 元素，例如最简单的，把当前工程的全部依赖都添加到包里：

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

在assembly下添加以上配置，则当前工程的依赖和工程自己生成的jar都会被打包进来。

若是要排除工程自身生成的jar，则能够添加

<useProjectArtifact>false</useProjectArtifact>

unpack参数能够控制依赖包是否在打包进来时是否解开，例如解开全部包，添加如下配置：

<unpack>true</unpack>

和 fileSet 同样，可使用 excludes 和 includes 来更详细的控制哪些依赖须要打包进来；另外 useProjectAttachments，useTransitiveDependencies，useTransitiveFiltering等参数能够对间接依赖、传递依赖进行控制。

其余选项
moduleSets：当有子模块时候用；
repositories：想包含库的时候用；
containerDescriptorHandlers：能够进行一些合并，定义ArtifactHandler之类的时候能够用，（能够参考：说明）；
componentDescriptors：如上所述，能够包含一些componentDescriptor定义，这些定义能够被多个assembly共享。
Assembly Plugin更多配置
上面已经看到了一些Assembly Plugin自己的配置，例如 finalName， outputDirectory， appendAssemblyId 和 descriptors 等，除了这些还有其余的一些可配置参数，参见：single，其中某些参数会覆盖在assembly descriptor 中的参数。有一个比较有用的参数是： archive，它的详细配置在：archive。

下面介绍一些archive的用法。

指定Main-Class
archive的一个重要用处就是配置生成的MANIFEST.MF文件。默认会生成一个MANIFEST.MF文件，不过这个文件默认值没什么意义。若是想指定生成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>
    <!-- 最终打包成一个用于发布的war文件 -->
    <formats>
        <format>${assembly-format}</format>
    </formats>

    <fileSets>
        <!-- 把项目公用的配置文件，打包进zip文件的config目录 -->
        <fileSet>
            <directory>${project.basedir}/src/main/resources/base</directory>
            <outputDirectory>WEB-INF/classes</outputDirectory>
        </fileSet>

        <!-- 把项目环境的配置文件，打包进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>