Maven插件之maven-assembly-plugin

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

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

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

该插件使用如下:

 

[html][/html] view plaincopy

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-assembly-plugin</artifactId>
  4.     <version>2.4</version>
  5.     <configuration>
  6.         <appendAssemblyId>false</appendAssemblyId>
  7.         <descriptors>
  8.             <descriptor>${basedir}/assembly.xml</descriptor> <!– Assembly 描述符文件 –>
  9.             <!– <descriptor>src/main/assembly/assembly.xml</descriptor> –>
  10.         </descriptors>
  11.     </configuration>
  12.     <executions>
  13.         <execution>
  14.             <id>make-assembly</id>
  15.             <phase>package</phase>
  16.             <goals>
  17.                 <goal>single</goal>
  18.             </goals>
  19.         </execution>
  20.     </executions>
  21. </plugin>

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

 

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

 

[html][/html] view plaincopy

  1. <assembly xmlns=”http://maven.apache.org/POM/4.0.0″
  2.           xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”
  3.           xsi:schemaLocation=”http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/assembly-1.0.0.xsd”>
  4.     <id>full</id>
  5.     <formats>
  6.         <format>zip</format> <!–打包文件格式–>
  7.     </formats>
  8.     <includeBaseDirectory>true</includeBaseDirectory>
  9.     <fileSets>
  10.         <fileSet>
  11.             <outputDirectory>/</outputDirectory>
  12.             <directory>WebRoot</directory>
  13.             <includes>
  14.                 <include>**/*</include>
  15.             </includes>
  16.             <excludes>
  17.                 <exclude>WEB-INF/lib/*</exclude>
  18.             </excludes>
  19.         </fileSet>
  20.     </fileSets>
  21. </assembly>

如此即可。

 

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

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

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

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

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

项目中使用assembly插件如下:

 

[html][/html] view plaincopy

  1. <plugin>
  2.     <groupId>org.apache.maven.plugins</groupId>
  3.     <artifactId>maven-assembly-plugin</artifactId>
  4.     <version>2.4</version>
  5.     <dependencies>
  6.         <strong><dependency>
  7.             <groupId>com.travelsky.tdp.pkgstock</groupId>
  8.             <artifactId>stock-assembly-descriptor</artifactId>
  9.             <version>1.0.0</version>
  10.         </dependency></strong>
  11.     </dependencies>
  12.     <executions>
  13.         <execution>
  14.             <id>make-assembly</id>
  15.             <phase>package</phase>
  16.             <goals>
  17.                 <goal>single</goal>
  18.             </goals>
  19.         </execution>
  20.     </executions>
  21.     <configuration>
  22.         <ignoreMissingDescriptor>true</ignoreMissingDescriptor>
  23.         <strong><descriptorRefs>
  24.             <descriptorRef>zipAll</descriptorRef>
  25.             <descriptorRef>zipFilterConf</descriptorRef>
  26.             <descriptorRef>zipJsCssOnly</descriptorRef>
  27.             <descriptorRef>zipPicOnly</descriptorRef>
  28.         </descriptorRefs></strong>
  29.     </configuration>
  30. </plugin>

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

 

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

标签