maven的assemble的使用

在开发Maven项目中，我们可能有各种各样的打包需求，当然最简单的就是，把整个Application打包成一个jar，这是Spring-boot项目中，常见的打包项目，有些项目可能比较复杂，还需要打包一些外部的配置的文件，或者自定义的shell脚本或者bat命令等，这时候使用assemble命令就比较方便了。

项目结构目录如下：





除了标准的创建maven项目会自带
src/main/java
src/main/resource
src/test/java
外，我们还自定义了bin，conf，assemble目录，其中bin目录用来存放项目启动，停止的一些脚本，conf存放了一些
外部配置文件，外部文件比较灵活，比如参数改了，不需要重新编译，只需要重启这个项目即可，assemble存放了我们打包的描述文件package.xml，内容如下：

Xml代码  

1. <?xml version="1.0"?>  
2. <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"  
3.           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  
4.           xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">  
5.   
6.     <!--项目标识，设置的话，生成后的zip文件会加上此后缀-->  
7.     <id></id>  
8.     <!--打包格式-->  
9.     <formats>  
10.         <format>zip</format>  
11.     </formats>  
12.     <!--是否包含根目录文件夹-->  
13.     <includeBaseDirectory>true</includeBaseDirectory>  
14.   
15.     <fileSets>  
16.   
17.         <!--<fileSet>-->  
18.             <!--<directory>${project.basedir}\src\main\resources</directory>-->  
19.             <!--<outputDirectory>\</outputDirectory>-->  
20.             <!--<includes>-->  
21.                 <!--<include>some/path</include>-->  
22.             <!--</includes>-->  
23.             <!--<excludes>-->  
24.                 <!--<exclude>some/path1</exclude>-->  
25.             <!--</excludes>-->  
26.         <!--</fileSet>-->  
27.   
28.         <!--自定义文件描述集-->  
29.         <fileSet>  
30.             <!--自定义脚本目录打包-->  
31.             <directory>${project.basedir}\src\main\bin</directory>  
32.             <outputDirectory>\bin</outputDirectory>  
33.             <includes>  
34.                 <include>*.*</include>  
35.             </includes>  
36.             <!--设置权限-->  
37.             <fileMode>0755</fileMode>  
38.         </fileSet>  
39.   
40.         <fileSet>  
41.             <!--外部配置文件打包-->  
42.             <directory>${project.basedir}\src\main\config</directory>  
43.             <outputDirectory>\config</outputDirectory>  
44.             <includes>  
45.                 <include>*.*</include>  
46.             </includes>  
47.             <fileMode>0644</fileMode>  
48.         </fileSet>  
49.     </fileSets>  
50.   
51.     <dependencySets>  
52.   
53.         <dependencySet>  
54.             <useProjectArtifact>true</useProjectArtifact>  
55.             <outputDirectory>lib</outputDirectory>  
56.             <!-- 将scope为runtime的依赖包打包到lib目录下。 -->  
57.             <scope>runtime</scope>  
58.         </dependencySet>  
59.     </dependencySets>  
60.   
61.  </assembly>  

<?xml version="1.0"?>
<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">

    <!--项目标识，设置的话，生成后的zip文件会加上此后缀-->
    <id></id>
    <!--打包格式-->
    <formats>
        <format>zip</format>
    </formats>
    <!--是否包含根目录文件夹-->
    <includeBaseDirectory>true</includeBaseDirectory>

    <fileSets>

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

        <!--自定义文件描述集-->
        <fileSet>
            <!--自定义脚本目录打包-->
            <directory>${project.basedir}\src\main\bin</directory>
            <outputDirectory>\bin</outputDirectory>
            <includes>
                <include>*.*</include>
            </includes>
            <!--设置权限-->
            <fileMode>0755</fileMode>
        </fileSet>

        <fileSet>
            <!--外部配置文件打包-->
            <directory>${project.basedir}\src\main\config</directory>
            <outputDirectory>\config</outputDirectory>
            <includes>
                <include>*.*</include>
            </includes>
            <fileMode>0644</fileMode>
        </fileSet>
    </fileSets>

    <dependencySets>

        <dependencySet>
            <useProjectArtifact>true</useProjectArtifact>
            <outputDirectory>lib</outputDirectory>
            <!-- 将scope为runtime的依赖包打包到lib目录下。 -->
            <scope>runtime</scope>
        </dependencySet>
    </dependencySets>

 </assembly>

然后在主pom.xml中，加入如下一段内容：

Xml代码  

1. <build>  
2.       <plugins>  
3.   
4.           <plugin>  
5.               <groupId>org.apache.maven.plugins</groupId>  
6.               <artifactId>maven-assembly-plugin</artifactId>  
7.               <configuration>  
8.                   <!--<appendAssemblyId>true</appendAssemblyId>-->  
9.                   <descriptors> <!--描述文件路径-->  
10.                       <descriptor>src/main/assemble/package.xml</descriptor>  
11.                   </descriptors>  
12.               </configuration>  
13.               <executions>  
14.                   <execution>  
15.                       <id>make-zip</id>  
16.                       <!-- 绑定到package生命周期阶段上 -->  
17.                       <phase>package</phase>  
18.                       <goals>  
19.                           <!-- 绑定到package生命周期阶段上 -->  
20.                           <goal>single</goal>  
21.                       </goals>  
22.   
23.                   </execution>  
24.               </executions>  
25.           </plugin>  
26.   
27.       </plugins>  
28.   
29.   </build>  

  <build>
        <plugins>

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

                    </execution>
                </executions>
            </plugin>

        </plugins>

    </build>

至此，我们在执行mvn clean package 时，就会发现target目录下，多了一个zip的压缩包：





将zip包解压后，如下：







我们就可以直接将压缩包，传到linux上执行脚本启动了，需要注意的是，在windows下编辑的脚本文件，在linux上可能执行不成功，大家可以下载一个dos2unix的工具，对脚本格式重新修改即可。

参考资料：
http://www.cnblogs.com/JerryWang1991/p/3936378.html
http://skydream.iteye.com/blog/437937
http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html