maven assembly 配置详解

Maven Assembly插件介绍

博客分类：

• 项目构建

 

你是否想要创建一个包含脚本、配置文件以及所有运行时所依赖的元素（jar）Assembly插件能帮你构建一个完整的发布包。

Assembly插件会生成 “assemblies”， 此特性等同于的Maven 1 distribution plug-in.。该插件不仅支持创建二进制归档文件，也支持创建源码归档文件。这些assemblies定义在一个assembly描述符文件里。你可以选择自定义assembly描述符或者直接使用插件自带的三个预定义描述符中的任何一个.

目前Assembly插件支持如下格式的归档文件:

• zip
• tar.gz
• tar.bz2
• jar
• dir
• war
• and any other format that the ArchiveManager has been configured for

Maven 2上使用assembly的简单步骤:

• 从预定义描述符里选择一个或者自己编写一个assembly描述符号。
• 工程的pom.xml里配置Assembly插件。
• 在工程根目录下运行”mvn assembly:assembly”命令 。

如何自定义assembly描述符，详见Assembly Descriptor Format.

什么是Assembly?

“assembly”是把一组文件、目录、依赖元素组装成一个归档文件. 比如, 假设一个 Maven project定义了一个JAR artifact，它包含控制台应用程序和Swing应用程序 。这样一个工程可以定义两套包含描述符，一套给给控制台应用，另一套给Swing应用程序，它们包含各自的脚本、目录和依赖。

Assembly Plugin的描述符可以定义任何一个文件或者目录归档方式。举个例子，如果的你的Maven 2工程包含”src/main/bin”这个目录，你可以指示Assembly插件复制“src/main/bin”目录下所有的文件到bin目录里（归档文件里的目录），并且可以修改它们的权限属性（UNIX mode）。见 assembly descriptor.

The Maven Assembly Plugin

Maven 2.0的Assembly插件目的是提供一个把工程依赖元素、模块、网站文档等其他文件存放到单个归档文件里。

使用任何一个预定义的描述符你可以轻松的构建一个发布包。这些描述符能处理一些常用的操作,如：把依赖的元素的归档到一个jar文件. 当然, 你可以自定义描述符来更灵活的控制依赖，模块，文件的归档方式。

maven-assembly-plugin : 是maven中针对打包任务而提供的标准插件

(1)、在pom.xml 文件里面的配置说明

1. <plugin>
2. <artifactId>maven-assembly-plugin</artifactId>
3. <executions>  <!--执行器 mvn assembly:assembly-->
4. <execution>
5. <id>make-zip</id><!--名字任意 -->
6. <phase>package</phase><!-- 绑定到package生命周期阶段上 -->
7. <goals>
8. <goal>single</goal><!-- 只运行一次 -->
9. </goals>
10. <configuration>
11. <descriptors> <!--描述文件路径-->
12. <descriptor>src/main/resources/zip.xml</descriptor>
13. </descriptors>
14. </configuration>
15. </execution>
16. </executions>
17. </plugin>

(2)、zip.xml 文件配置如下

1. <assembly
2. xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4. xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
5. <id>release</id>
6. <formats>
7. <format>zip</format>
8. </formats>
9. <fileSets>
10. <fileSet>
11. <directory>${project.basedir}\src\main\config</directory>
12. <!-- 过滤 -->
13. <excludes>
14. <exclude>*.xml</exclude>
15. </excludes>
16. <outputDirectory>\</outputDirectory>
17. </fileSet>
18. </fileSets>
19. <dependencySets>
20. <dependencySet>
21. <useProjectArtifact>true</useProjectArtifact>
22. <outputDirectory>lib</outputDirectory><!-- 将scope为runtime的依赖包打包到lib目录下。 -->
23. <scope>runtime</scope>
24. </dependencySet>
25. </dependencySets>
26. </assembly>

(3)、zip.xml 格式属性说明

打包的文件格式
可以有：tar.zip war zip
<formats>
 <format>zip</format>
</formats>

需要打包的路径
<directory>${project.basedir}</directory>

打包后输出的路径
<outputDirectory>/</outputDirectory>

打包需要包含的文件

<excludes>
       
<exclude>junit:junit</exclude>
       
<exclude>commons-lang:commons-lang</exclude>
        <exclude>commons-logging:commons-logging</exclude>
</excludes>

当前项目构件是否包含在这个依赖集合里。

<useProjectArtifact>true</useProjectArtifact>

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

另一个讲解：

(1)、在pom.xml 文件里面的配置说明

1. <plugin>
2. <artifactId>maven-assembly-plugin</artifactId>
3. <executions>  <!--执行器 mvn assembly:assembly-->
4. <execution>
5. <id>make-zip</id><!--名字任意 -->
6. <phase>package</phase><!-- 绑定到package生命周期阶段上 -->
7. <goals>
8. <goal>single</goal><!-- 只运行一次 -->
9. </goals>
10. <configuration>
11. <descriptors> <!--描述文件路径-->
12. <descriptor>src/main/resources/zip.xml</descriptor>
13. </descriptors>
14. </configuration>
15. </execution>
16. </executions>
17. </plugin>

例：

1. <span style="white-space:pre">            </span><plugin>
2. <artifactId>maven-assembly-plugin</artifactId>
3. <configuration>
4. <!-- not append assembly id in release file name -->
5. <appendAssemblyId>false</appendAssemblyId>
6. <descriptors>
7. <descriptor>src/main/assembly/assembly.xml</descriptor>
8. </descriptors>
9. </configuration>
10. <executions>
11. <execution>
12. <id>make-assembly</id>
13. <phase>package</phase>
14. <goals>
15. <goal>single</goal>
16. </goals>
17. </execution>
18. </executions>
19. </plugin>

(2)、zip.xml 文件配置如下

1. <assembly
2. xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
4. xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
5. <id>release</id>
6. <formats>
7. <format>zip</format>
8. </formats>
9. <fileSets>
10. <fileSet>
11. <directory>${project.basedir}\src\main\config</directory>
12. <!-- 过滤 -->
13. <excludes>
14. <exclude>*.xml</exclude>
15. </excludes>
16. <outputDirectory>\</outputDirectory>
17. </fileSet>
18. </fileSets>
19. <dependencySets>
20. <dependencySet>
21. <useProjectArtifact>true</useProjectArtifact>
22. <outputDirectory>lib</outputDirectory><!-- 将scope为runtime的依赖包打包到lib目录下。 -->
23. <scope>runtime</scope>
24. </dependencySet>
25. </dependencySets>
26. </assembly>

例：

1. <assembly>
2. <id>assembly</id>
3. <formats>
4. <format>tar.gz</format>
5. </formats>
6. <includeBaseDirectory>true</includeBaseDirectory>
7. <fileSets>
8. <fileSet>
9. <directory>${project.build.directory}/resources</directory>
10. <outputDirectory>resources</outputDirectory>
11. <fileMode>0755</fileMode>
12. </fileSet>
13. <fileSet>
14. <directory>${project.build.directory}/config</directory>
15. <outputDirectory>config</outputDirectory>
16. <fileMode>0644</fileMode>
17. </fileSet>
18. <fileSet>
19. <directory>${project.build.directory}/bin</directory>
20. <outputDirectory>bin</outputDirectory>
21. <fileMode>0755</fileMode>
22. </fileSet>
23. </fileSets>
24. <dependencySets>
25. <dependencySet>
26. <outputDirectory>lib</outputDirectory>
27. </dependencySet>
28. </dependencySets>
29. </assembly>