Maven学习(五) - 插件maven-assembly-plugin
Assembly插件主要是聚合项目的输出，好比依赖，模块以及其余文件。通俗的来讲，就是将项目内容按照必定规则及指定格式从新组合并输出。它支持的输出格式有多种：html
- jar jar包
- war war包
- dir 文件目录
- zip zip压缩包
- tar tar压缩包
- tar.gz
- tar.bz2
- tar.xz
为何须要Assembly插件呢？由于对于服务类型的后台程序，线上运行时通常经过脚本的方式启动和中止，而项目中的目录结构复杂且不够直观，且项目文件也须要合并和过滤，Assembly插件就能够帮助咱们完成。java
Assembly使用
使用Assembly插件须要在pom.xml中加入如下配置正则表达式
<plugin> <artifactId>maven-assembly-plugin</artifactId> <version>3.1.0</version> <configuration> <descriptors> <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>
Assembly插件通常绑定的阶段为package，主要的插件目标就是assembly:single。在<configuration>的<descriptor>中指定assembly组装规则的XML。spring
如今咱们的项目目录以下apache
+ src
+ main
+ java
+ resources
+ jdbc.properties
+ bin
+ start.sh
+ stop.sh
+ assembly
+ assembly.xml
最终咱们想要生成的目录以下app
+ bin
start.sh
stop.sh
+ conf
jdbc.properties
+ lib(依赖jar包目录)
xxx.jar
同时但愿能输出成zip格式，那么assembly.xml的配置以下maven
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
<id>distribution</id>
<!-- 输出格式 -->
<formats>
<format>jar</format>
<format>zip</format>
</formats>
<!-- 指定文件组的组装方式 -->
<fileSets>
<!-- 将项目中src/main/bin目录下的脚本文件copy到target目录的bin目录下 -->
<fileSet>
<directory>src/main/bin</directory>
<outputDirectory>bin</outputDirectory>
</fileSet>
<!-- 将项目中src/main/resources目录下的资源文件copy到target目录的conf目录下 -->
<fileSet>
<directory>src/main/resources</directory>
<outputDirectory>conf</outputDirectory>
<!-- 过滤资源文件，对其中的maven变量进行复制 -->
<filtered>true</filtered>
</fileSet>
</fileSets>
<!-- 指定依赖jar包输出的目录 -->
<dependencySets>
<dependencySet>
<useProjectArtifact>true</useProjectArtifact>
<outputDirectory>lib</outputDirectory>
<!-- 只包含runtime做用域的依赖 -->
<scope>runtime</scope>
</dependencySet>
</dependencySets>
</assembly>
命令行执行插件
mvn clean package
项目的target目录下会生成两个文件命令行
- xxx-distribution.jar
- xxx-distribution.zip
xxx是项目的finalName-version，而distribution后缀是默认加上assembly.xml中的id，若是不想要这个后缀，能够在pom.xml的插件的<configuration>中设置appendAssemblyId为falsecode
<configuration> <appendAssemblyId>false</appendAssemblyId> <descriptors> <descriptor>src/main/assembly/assembly.xml</descriptor> </descriptors> </configuration>
若是有另外的变量属性文件，也能够在<configuration>中配置
<configuration> <appendAssemblyId>false</appendAssemblyId> <filters> <filter>src/main/filter/filter.properties</filter> </filters> <descriptors> <descriptor>src/main/assembly/assembly.xml</descriptor> </descriptors> </configuration>
assembly.xml中的更多配置见http://maven.apache.org/plugins/maven-assembly-plugin/assembly.html
pom文件中插件的更多配置见http://maven.apache.org/plugins/maven-assembly-plugin/single-mojo.html
includes/excludes
在<fileSet>中可使用includes/excludes进行细粒度的控制，此控制对<filtered>也生效
<fileSet> <directory>src/main/resources</directory> <outputDirectory>conf</outputDirectory> <filtered>true</filtered> <excludes> <exclude>some/path1</exclude> </excludes> </fileSet> <fileSet> <directory>src/main/resources</directory> <outputDirectory>conf</outputDirectory> <filtered>false</filtered> <includes> <include>some/path2</include> </includes> </fileSet>
第一个<fileSet>将src/main/resources输出到target/conf，而且过滤变量属性，可是排除some/path1的文件。第二个<fileSet>将src/main/resources下的some/path2输出到target/conf，但不过滤变量属性。
建立可执行的jar
默认状况下，经过mvn package生成的jar包中由于没有指定Main-Class属性，所以并不能使用-jar配置直接运行。Assembly插件支持<archive>元素(maven-archive)配置Main-Class。
<configuration> <archive> <manifest> <mainClass>com.lcifn.maven.Application</mainClass> </manifest> </archive> </configuration>
再执行命令
mvn clean package
新生成的jar包中的META-INF/MANIFEST.MF中就包含了Main-Class属性
使用containerDescriptorHandlers合并文件
Assembly插件支持经常使用的文件合并功能，特别是META-INF下的services文件或spirng文件(spring.handlers和spring.schemas)。
metaInf-services
聚合全部的META-INF/services文件合并成一个文件
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
....
<containerDescriptorHandlers>
<containerDescriptorHandler>
<handlerName>metaInf-services</handlerName>
</containerDescriptorHandler>
</containerDescriptorHandlers>
</assembly>
metaInf-spring
聚合全部的**META-INF/spring.**文件合并成一个文件
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
....
<containerDescriptorHandlers>
<containerDescriptorHandler>
<handlerName>metaInf-spring</handlerName>
</containerDescriptorHandler>
</containerDescriptorHandlers>
</assembly>
file-aggregator
也能够给定正则表达式匹配文件合并成一个文件，如下匹配全部file.txt而后合并成一个file.txt
<assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
....
<containerDescriptorHandlers>
<containerDescriptorHandler>
<handlerName>file-aggregator</handlerName>
<configuration>
<filePattern>.*/file.txt</filePattern>
<outputPath>file.txt</outputPath>
</configuration>
</containerDescriptorHandler>
</containerDescriptorHandlers>
</assembly>
参考文档：
- 1. maven学习：jetty插件与Tomcat插件
- 2. maven学习：jetty的插件
- 3. Maven学习之 插件plugin
- 4. Maven学习(四) - 插件maven-resources-plugin
- 5. Maven学习(六) - 插件maven-shade-plugin
- 6. Maven实战（五） eclipse安装maven插件
- 7. Maven（五）Eclipse配置Maven插件
- 8. Maven学习(十五)-----Maven常用命令
- 9. mybatis plus学习笔记 插件 五
- 10. Maven的生命周期和插件（五）
- 更多相关文章...
- • Maven 插件 - Maven教程
- • 我们已经学习了 SQL，下一步学习什么呢？ - SQL 教程
- • Tomcat学习笔记（史上最全tomcat学习笔记）
- • 适用于PHP初学者的学习线路和建议
-
每一个你不满意的现在，都有一个你没有努力的曾经。