Maven插件之maven-assembly-plugin

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

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

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

该插件使用如下:

	org.apache.maven.plugins
	maven-assembly-plugin
	2.4
	
		false
		
			${basedir}/assembly.xml 
			
		
	
	
		
			make-assembly
			package
			
				single
			
		
	

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

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

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

	full
	
		zip 
	
	true
	 
		
			/
			WebRoot
			
				**/*
			
			
				WEB-INF/lib/*
			
		
	

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21

如此即可。

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

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

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

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

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

项目中使用assembly插件如下:

	org.apache.maven.plugins
	maven-assembly-plugin
	2.4
	
		
			com.travelsky.tdp.pkgstock
			stock-assembly-descriptor
			1.0.0
		
	
	
		
			make-assembly
			package
			
				single
			
		
	
	
		true
		
			zipAll
			zipFilterConf
			zipJsCssOnly
			zipPicOnly
		
	

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

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

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

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

2021-07-02补充：

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

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

2、配置 pom 依赖

  com.taobao
  pig
  20210220
  system
  jar
  ${project.basedir}/lib/taobao-sdk-java.jar

1
2
3
4
5
6
7
8

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

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

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

	
	
		
			lib
		
	

1
2
3
4
5
6
7
8

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

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

	
	
		
			lib
			
				*
			
		
		
			lib
			
                *
            
			system
		
	

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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