Maven插件Assembly打包插件用法详解

背景

maven默认的打包一般是将项目打成一个jar包，上传到服务器即可部署。但是如果涉及到多机器梯度部署、灰度部署就要一个服务器一个服务器的上传包，一个一个机器的部署，这样实在效率低下且麻烦。一般的操作是将批处理命令和项目打包好的jar包一起打包再分发到每个服务器，再通过多机批处理进行部署。

Assembly

Assembly使开发人员能够将项目输出合并到单个可分发的存档中，该存档还包含依赖项、模块、站点文档和其他文件。具体更多详细介绍可参照 官网

用法

assembly的使用非常简单，支持打包的文件类型也非常多，目前主持的文件类型有：zip，tar，tar.gz (or tgz)，tar.bz2 (or tbz2)，tar.snappy，tar.xz (or txz)，jar，dir，war和其它配置到ArchiveManager里面的文件类型。

1.pom.xml文件中引入Assembly插件

    <plugin>
    	<groupId>org.apache.maven.plugins</groupId>
    	<artifactId>maven-assembly-plugin</artifactId>
    	<version>2.5.3</version>
    	<configuration>
    		<descriptors>
    			<descriptor>distribution.xml</descriptor><!--指定的描述符文件-->
    		</descriptors>
    	</configuration>
    	<executions>
    		<execution>
    			<id>make-assembly</id><!--名字任意 -->
    			<phase>package</phase><!-- 绑定到package生命周期阶段上 -->
    			<goals>
    				<goal>single</goal><!-- 该打包任务只运行一次 -->
    			</goals>
    		</execution>
    	</executions>
    </plugin>

2.配置描述符文件

    <?xml version="1.0" encoding="utf-8"?>
    <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 标识符，添加到生成文件名称的后缀符。如果指定 id 的话（这里指定的是项目的版本），目标文件则是 ${artifactId}-${id}.jar。【如terminal-dispatch-5.0.0.0.jar】 -->
        <id>${project.version}</id>
        
        <!-- 指定打包格式。maven-assembly-plugin插件支持的打包格式有zip、tar、tar.gz (or tgz)、tar.bz2 (or tbz2)、jar、dir、war，可以同时指定多个打包格式 -->
        <formats>
            <format>jar</format>
        </formats>
        
        <!-- 指定打的包是否包含打包层目录（比如finalName是terminal-dispatch，当值为true，所有文件被放在包内的terminal-dispatch目录下，否则直接放在包的根目录下）-->
        <includeBaseDirectory>true</includeBaseDirectory>
        
        <!-- 指定将工程依赖的包打到包里的指定目录下 -->
        <dependencySets>
            <dependencySet>
                <useProjectArtifact>true</useProjectArtifact> <!-- 指定打包时是否包含工程自身生成的jar包 -->
                <outputDirectory>lib</outputDirectory> <!-- 指定将这些依赖包打到包里lib目录下 -->
                <scope>runtime</scope> <!-- 用于管理依赖的部署，runtime表示只在运行时使用 -->
            </dependencySet>
        </dependencySets>
        
        <!-- 指定要包含的文件集，可以定义多个fileSet -->
        <fileSets>
            <fileSet>
                <directory>src/main/script/linux/bin</directory> <!-- 指定归档文件（要打的jar包）要包含的目录（下的文件及文件夹） -->
                <outputDirectory>bin</outputDirectory> <!-- 指定要将当前目录（<directory>标签中的目录放在归档文件（要打的jar包）bin目录下） -->
                <includes>
                    <include>terminal-dispatch</include> <!-- 精确控制要包含的文件，<exclude>用于精确控制要排除的文件  -->
                    <include>server</include>
                </includes>
                <fileMode>0755</fileMode> <!-- 设置文件 UNIX 属性，是一种读写权限 -->
            </fileSet>        
            <fileSet>
                <directory>src/main/resources</directory>
                <outputDirectory>conf</outputDirectory>
                <includes>
                    <include>config.properties</include>
                    <include>logback.xml</include>
                </includes>
                <fileMode>0644</fileMode>
            </fileSet>
            <fileSet>
                <directory>src/main/script/conf</directory>
                <outputDirectory>conf</outputDirectory>
                <includes>
                    <include>wrapper.conf</include>
                </includes>
                <fileMode>0644</fileMode>
            </fileSet>
            <fileSet>
                <directory>src/main/script/linux/lib</directory>
                <outputDirectory>lib</outputDirectory>
                <includes>
                    <include>libwrapper.so</include>
                    <include>wrapper.jar</include>
                </includes>
                <fileMode>0755</fileMode>
            </fileSet>
        </fileSets>
        
    </assembly>

示例

    <assembly>
        <id>all</id>
        <formats>
            <format>tar.gz</format>
        </formats>
        <includeBaseDirectory>false</includeBaseDirectory>
        <fileSets>
            <fileSet>
                <directory>bin</directory>
                <outputDirectory>./</outputDirectory>
            </fileSet>
        </fileSets>
        <dependencySets>
            <dependencySet>
                <outputDirectory>lib</outputDirectory>
                <scope>compile</scope>
            </dependencySet>
        </dependencySets>
    </assembly>
    

参考：

1. https://zhuanlan.zhihu.com/p/368567423
2. https://maven.apache.org/plugins/maven-assembly-plugin/usage.html