maven-assembly-plugin使用描述(拷自 maven-assembly-plugin 主页)
The Assembly Plugin for Maven is primarily intended to allow users to aggregate the project output along with its dependencies, modules, site documentation, and other files into a single distributable archive.
目前它只有一个有意义的goal, 详细的请看(http://maven.apache.org/plugins/maven-assembly-plugin/plugin-info.html):
assembly:single
single操作有很多可配置的参数,详细的请看(http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html)。
简单的说,maven-assembly-plugin 就是用来帮助打包用的,比如说打出一个什么类型的包,包里包括哪些内容等等。 目前至少支持以下打包类型:
默认情况下,打jar包时,只有在类路径上的文件资源会被打包到jar中,并且文件名是${artifactId}-${version}.jar,下面看看怎么用maven-assembly-plugin插件来定制化打包。
首先需要添加插件声明:
1 <plugin>
2 <groupId>org.apache.maven.plugins</groupId>
3 <artifactId>maven-assembly-plugin</artifactId>
4 <version>2.4</version>
5 <executions>
6 <execution>
7 <phase>package</phase>
8 <goals>
9 <goal>single</goal>
10 </goals>
11 </execution>
12 </executions>
13 </plugin>
要使用maven-assembly-plugin,需要指定至少一个要使用的assembly descriptor 文件,对于当前使用的版本(2.4)对应的assembly descriptor的schema定义为:Assembly Schema ,其中assembly descriptor中又可以包括 component 的定义 (component 可以很方便的用于多个assembly descriptor之间共享),component 的schema 定义在:Component Schema 。 关于assembly descriptor的component descriptor的更详细的说明,请见:Component Descriptor 和 Assembly Descriptor 。
默认情况下,maven-assembly-plugin内置了几个可以用的assembly descriptor:
要查看它们的详细定义,可以到maven-assembly-plugin-2.4.jar里去看,例如对应 bin 的assembly descriptor 如下:
1 <assembly xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0"
2 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
3 xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.0 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
4 <id>bin</id>
5 <formats>
6 <format>tar.gz</format>
7 <format>tar.bz2</format>
8 <format>zip</format>
9 </formats>
10 <fileSets>
11 <fileSet>
12 <directory>${project.basedir}</directory>
13 <outputDirectory>/</outputDirectory>
14 <includes>
15 <include>README*</include>
16 <include>LICENSE*</include>
17 <include>NOTICE*</include>
18 </includes>
19 </fileSet>
20 <fileSet>
21 <directory>${project.build.directory}</directory>
22 <outputDirectory>/</outputDirectory>
23 <includes>
24 <include>*.jar</include>
25 </includes>
26 </fileSet>
27 <fileSet>
28 <directory>${project.build.directory}/site</directory>
29 <outputDirectory>docs</outputDirectory>
30 </fileSet>
31 </fileSets>
32 </assembly>
一般来说,内置的assembly descriptor都不满足需求,这个时候就需要写自己的assembly descriptor的实现了。先从一个最简单的定义开始:
1 <?xml version='1.0' encoding='UTF-8'?>
2 <assembly 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
5 http://maven.apache.org/xsd/assembly-1.1.0.xsd">
6 <id>demo</id>
7 <formats>
8 <format>jar</format>
9 </formats>
10 <includeBaseDirectory>false</includeBaseDirectory>
11 <fileSets>
12 <fileSet>
13 <directory>${project.build.directory}/classes</directory>
14 <outputDirectory>/</outputDirectory>
15 </fileSet>
16 </fileSets>
17 </assembly>
这个定义很简单:
1 <configuration>
2 <finalName>demo</finalName>
3 <descriptors>
4 <descriptor>assemblies/demo.xml</descriptor>
5 </descriptors>
6 <outputDirectory>output</outputDirectory>
7 </configuration>
最后会生成一个demo-demo.jar 文件在目录 output 下,其中前一个demo来自finalName,后一个demo来自assembly descriptor中的id,其中的内容和默认的打包出来的jar类似。
如果只想有finalName,则增加配置:
1 <appendAssemblyId>false</appendAssemblyId>
上面演示了添加所有编译后的资源,同样的可以增加其他资源,例如想添加当前工程目录下的某个文件 b.txt ,在assembly descriptor的assembly结点下增加
1 <files>
2 <file>
3 <source>b.txt</source>
4 <outputDirectory>/</outputDirectory>
5 </file>
6 </files>
这里用到了 files 元素类型,可以想象 fileSets 下的结点都是针对文件夹的;files 下的结点都是针对文件的。
也可以改变打包后的文件名,例如上面的 b.txt ,希望打包后的名字为 b.txt.bak, 只需要在file 里添加以下配置 :
1 <destName>b.txt.bak</destName>
在fileSet里可以使用includes 和 excludes来更精确的控制哪些文件要添加,哪些文件要排除。 例如要排除某个目录下所有的txt文件:
1 <fileSet>
2 <directory>${project.build.directory}/classes</directory>
3 <outputDirectory>/</outputDirectory>
4 <excludes>
5 <exclude>**/*.txt</exclude>
6 </excludes>
7 </fileSet>
或者某个目录下只想 .class 文件:
1 <fileSet>
2 <directory>${project.build.directory}/classes</directory>
3 <outputDirectory>/</outputDirectory>
4 <includes>
5 <include>**/*.class</include>
6 </includes>
7 </fileSet>
如果想把一些依赖库打到包里,可以用 dependencySets 元素,例如最简单的,把当前工程的所有依赖都添加到包里:
1 <dependencySets>
2 <dependencySet>
3 <outputDirectory>/</outputDirectory>
4 </dependencySet>
5 </dependencySets>
在assembly下添加以上配置,则当前工程的依赖和工程本身生成的jar都会被打包进来。
如果要排除工程自身生成的jar,则可以添加
1 <useProjectArtifact>false</useProjectArtifact>
unpack参数可以控制依赖包是否在打包进来时是否解开,例如解开所有包,添加以下配置:
1 <unpack>true</unpack>
和 fileSet 一样,可以使用 excludes 和 includes 来更详细的控制哪些依赖需要打包进来;另外 useProjectAttachments,useTransitiveDependencies,useTransitiveFiltering等参数可以对间接依赖、传递依赖进行控制。
上面已经看到了一些Assembly Plugin本身的配置,例如 finalName, outputDirectory, appendAssemblyId和descriptors等,除了这些还有其他的一些可配置参数,参见:single,其中某些参数会覆盖在assembly descriptor中的参数。有一个比较有用的参数是: archive,它的详细配置在:archive。 下面介绍一些archive的用法。
archive的一个重要用处就是配置生成的MANIFEST.MF文件。默认会生成一个MANIFEST.MF文件,不过这个文件默认值没什么意义。如果想指定生成jar的Main-Class,可以如下配置:
1 <archive>
2 <manifest>
3 <mainClass>demo.DemoMain</mainClass>
4 </manifest>
5 </archive>
除了可以指定Main-Class外,还可以添加任意项。比如在OSGI bundle的MANIFEST.MF定义里就有很多用来定义bundle的属性的项,如Import-Package,Export-Package等等。要添加项,可以使用如下配置:
1 <archive>
2 <manifestEntries>
3 <Import-Package>javax.xml.ws.*</Import-Package>
4 </manifestEntries>
5 </archive>
还可以直接指定MANIFEST.MF文件。如下:
1 <archive>
2 <manifestFile>META-INF/MANIFEST.MF</manifestFile>
3 </archive>
-END-