2023年12月13日发(作者：)
mavenpom配置学习笔记（一）之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.
assembly:single
简单的说，maven-assembly-plugin 就是用来帮助打包用的，比如说打出一个什么类型的包，包里包括哪些内容等等。 目前至少支持以下打包类型：
zip
tar
2
jar
dir
war
默认情况下，打jar包时，只有在类路径上的文件资源会被打包到jar中，并且文件名是${artifactId}-${version}.jar，下面看看怎么用maven-assembly-plugin插件
来定制化打包。
首先需要添加插件声明：
使用内置的Assembly Descriptor
要使用maven-assembly-plugin，需要指定至少一个要使用的assembly descriptor 文件，对于当前使用的版本(2.4)对应的assembly descriptor的schema定义
为： ，其中assembly descriptor中又可以包括 component 的定义 (component 可以很方便的用于多个assembly descriptor之间共享)，component 的schema
定义在： 。 关于assembly descriptor的component descriptor的更详细的说明，请见： 和 。
默认情况下，maven-assembly-plugin内置了几个可以用的assembly descriptor：
bin ： 类似于默认打包，会将bin目录下的文件打到包中
jar-with-dependencies ： 会将所有依赖都解压打包到生成物中
src ：只将源码目录下的文件打包
project ： 将整个project资源打包
要查看它们的详细定义，可以到里去看，例如对应 bin 的assembly descriptor 如下：
xmlns:xsi="/2001/XMLSchema-instance" xsi:schemaLocation="/plugins/maven-assembly-plugin/assembly/1.1.0 /xsd/">
自定义Assembly Descriptor
一般来说，内置的assembly descriptor都不满足需求，这个时候就需要写自己的assembly descriptor的实现了。先从一个最简单的定义开始：
xmlns:xsi="/2001/XMLSchema-instance" xsi:schemaLocation="/plugins/maven-assembly-plugin/assembly/1.1.0 /xsd/">
这个定义很简单：
format：指定打包类型
includeBaseDirectory：指定是否包含打包层目录（比如finalName是output，当值为true，所有文件被放在output目录下，否则直接放在包的根目录下）
fileSets：指定要包含的文件集，可以定义多个fileSet
directory：指定要包含的目录
outputDirectory：指定当前要包含的目录的目的地 要使用这个assembly descriptor，需要如下配置：
最后会生成一个 文件在目录 output 下，其中前一个demo来自finalName，后一个demo来自assembly descriptor中的id，其
中的内容和默认的打包出来的jar类似。
如果只想有finalName，则增加配置：
添加文件
上面演示了添加所有编译后的资源，同样的可以增加其他资源，例如想添加当前工程目录下的某个文件 ，在assembly descriptor的assembly结点下增加
这里用到了 files 元素类型，可以想象 fileSets 下的结点都是针对文件夹的；files 下的结点都是针对文件的。
也可以改变打包后的文件名，例如上面的 ，希望打包后的名字为 ， 只需要在file 里添加以下配置 ：
排除文件
在fileSet里可以使用includes 和 excludes来更精确的控制哪些文件要添加，哪些文件要排除。 例如要排除某个目录下所有的txt文件：
或者某个目录下只想 .class 文件：
添加依赖
如果想把一些依赖库打到包里，可以用 dependencySets 元素，例如最简单的，把当前工程的所有依赖都添加到包里：
在assembly下添加以上配置，则当前工程的依赖和工程本身生成的jar都会被打包进来。
如果要排除工程自身生成的jar，则可以添加
unpack参数可以控制依赖包是否在打包进来时是否解开，例如解开所有包，添加以下配置：
和 fileSet 一样，可以使用 excludes 和 includes 来更详细的控制哪些依赖需要打包进来；另外
useProjectAttachments，useTransitiveDependencies，useTransitiveFiltering等参数可以对间接依赖、传递依赖进行控制。
其他选项
moduleSets：当有子模块时候用
repositories：想包含库的时候用
containerDescriptorHandlers：可以进行一些合并，定义ArtifactHandler之类的时候可以用，（可以参考： ）
componentDescriptors：如上所述，可以包含一些componentDescriptor定义，这些定义可以被多个assembly共享
Assembly Plugin更多配置
上面已经看到了一些Assembly Plugin本身的配置，例如 finalName， outputDirectory， appendAssemblyId和descriptors等，除了这些还有其他的一些可配置
参数，参见：，其中某些参数会覆盖在assembly descriptor中的参数。有一个比较有用的参数是： archive，它的详细配置在：。 下面介绍一些archive的用
法。
指定Main-Class
archive的一个重要用处就是配置生成的文件。默认会生成一个文件，不过这个文件默认值没什么意义。如果想指定生成jar的
Main-Class，可以如下配置：
添加MANIFEST项
除了可以指定Main-Class外，还可以添加任意项。比如在OSGI bundle的定义里就有很多用来定义bundle的属性的项，如Import-
Package，Export-Package等等。要添加项，可以使用如下配置：
指定文件
还可以直接指定文件。如下：
发布评论