Maven插件之maven-assembly-plugin

使用Maven对Web项目进行打包，默认为war包；但有些时候，总是希望打成zip包(亦或其他压缩包)，maven-war-plugin插件就无能为力了，这时就用到了maven-assembly-plugin插件了，官方网址：

http://maven.apache.org/plugins/maven-assembly-plugin/

该插件能打包成指定格式分发包，更重要的是能够自定义包含/排除指定的目录或文件（遗留项目中,过滤配置文件时,或者仅仅需要发布图片或者CSS/JS等指定类型文件时,发挥作用)

该插件使用如下:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>2.4</version>
	<configuration>
		<appendAssemblyId>false</appendAssemblyId>
		<descriptors>
			<descriptor>${basedir}/assembly.xml</descriptor> <!-- Assembly 描述符文件 -->
			<!-- <descriptor>src/main/assembly/assembly.xml</descriptor> -->
		</descriptors>
	</configuration>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>single</goal>
			</goals>
		</execution>
	</executions>
</plugin>

如上所示,绑定到package阶段,自动打包;需要指定一个Assembly描述符文件,该文件指定了打包格式,包含的文件/过滤的文件等信息,可以同时指定多个描述符文件,打包成不同的格式;

以下是assembly.xml文件内容(该内容表示,打包时,排除WEB-INF/lib目录下的所有文件):

<assembly xmlns="http://maven.apache.org/POM/4.0.0"
		  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.0.0.xsd">
	<id>full</id>
	<formats>
		<format>zip</format> <!--打包文件格式-->
	</formats>
	<includeBaseDirectory>true</includeBaseDirectory>
	<fileSets> 
		<fileSet>
			<outputDirectory>/</outputDirectory>
			<directory>WebRoot</directory>
			<includes>
				<include>**/*</include>
			</includes>
			<excludes>
				<exclude>WEB-INF/lib/*</exclude>
			</excludes>
		</fileSet>
	</fileSets>
</assembly>

如此即可。

细心的朋友也许会发现,如果同时管理多个Web项目,那么就要拷贝多个描述符文件到每一个项目中,重复的劳动;其实我更想说的是,假如管理着十几个甚至几十个Web项目(本人就同时修改十几个Web项目),而如上所述的重复劳动,仍然不厌其烦的做完了,突然有一天,领导说,打zip包时,需要在排除/添加某某文件,剩下的就不用我多说了吧,唉.....

下面再介绍另外一种指定描述符文件的做法(该做法应算作最佳实践了):

创建一个Java项目,该项目中仅仅有描述符文件,打包成jar文件,部署到私服中;如下图所示:

有一点要求:所有的描述符文件都必须放到assemblies文件夹下面,参考:

http://maven.apache.org/plugins/maven-assembly-plugin/examples/sharing-descriptors.html

项目中使用assembly插件如下:

<plugin>
	<groupId>org.apache.maven.plugins</groupId>
	<artifactId>maven-assembly-plugin</artifactId>
	<version>2.4</version>
	<dependencies>
		<dependency>
			<groupId>com.travelsky.tdp.pkgstock</groupId>
			<artifactId>stock-assembly-descriptor</artifactId>
			<version>1.0.0</version>
		</dependency>
	</dependencies>
	<executions>
		<execution>
			<id>make-assembly</id>
			<phase>package</phase>
			<goals>
				<goal>single</goal>
			</goals>
		</execution>
	</executions>
	<configuration>
		<ignoreMissingDescriptor>true</ignoreMissingDescriptor>
		<descriptorRefs>
			<descriptorRef>zipAll</descriptorRef>
			<descriptorRef>zipFilterConf</descriptorRef>
			<descriptorRef>zipJsCssOnly</descriptorRef>
			<descriptorRef>zipPicOnly</descriptorRef>
		</descriptorRefs>
	</configuration>
</plugin>

插件中增加对描述符jar的依赖,同时指定需要使用的描述符文件(无需添加.xml后缀);

如此使用,可在多个Web项目中共享同一份打包描述符文件,也更具有可扩展性,更好维护。

~~~~~~~~~~~~~喜悦的分割线~~~~~~~~~~~~~~~~~~~~~~~~~

2021-07-02补充：

一个maven项目，引用了第三方的jar，采用如下方式使用：

1、jar放到项目lib目录下；

2、配置 pom 依赖

<dependency>
  <groupId>com.taobao</groupId>
  <artifactId>pig</artifactId>
  <version>20210220</version>
  <scope>system</scope>
  <type>jar</type>
  <systemPath>${project.basedir}/lib/taobao-sdk-java.jar</systemPath>
</dependency>

使用 maven-assembly-plugin 插件打zip包，上传服务器，项目运行ok，但是某些功能报错，找不到指定的类（ClassNotFound）。本地编译、测试都没问题。

经过排查，发现system范围的jar没有被包含到zip中。

assembly资源文件相关配置如下：

<assembly>
	<!-- 依赖的 jar 包 copy 到 lib 目录下 -->
	<dependencySets>
		<dependencySet>
			<outputDirectory>lib</outputDirectory>
		</dependencySet>
	</dependencySets>
</assembly>

这是一种极简的写法，就好比Java的默认构造方法。其隐含的意思，只copy compile范围的jar到指定的lib文件夹中。

当需要copy system范围的jar时，需要增加配置（注意是增加，就好比Java类，增加自定义构造方法时，一般需要把默认构造方法显式写出），修改后的代码如下：

<assembly>
	<!-- 依赖的 jar 包 copy 到 lib 目录下 -->
	<dependencySets>
		<dependencySet>
			<outputDirectory>lib</outputDirectory>
			<includes>
				<include>*</include>
			</includes>
		</dependencySet>
		<dependencySet>
			<outputDirectory>lib</outputDirectory>
			<includes>
                <include>*</include>
            </includes>
			<scope>system</scope>
		</dependencySet>
	</dependencySets>
</assembly>

如此之后，system范围的jar会被包含到zip包中。