maven之打包插件(maven-assembly-plugin,maven-shade-plugin与maven-assembly-plugin)
一. 介绍
plugin | function |
maven-jar-plugin | maven 默认打包插件,用来创建 project jar |
maven-shade-plugin | 用来打可执行包,executable(fat) jar |
maven-assembly-plugin | 支持定制化打包方式,例如 apache 项目的打包方式 |
每种打包方式都具有自己的应用场景。
二. 打包准备
<properties><project.build.sourceEncoding>UTF-8</project.build.sourceEncoding><java.version>1.8</java.version></properties>
2). 需要确定依赖的scope:默认的scope包括如下
scope | 说明 |
compile | 默认的范围;如果没有提供一个范围,那该依赖的范围就是编译范围。编译范围依赖在所有的classpath 中可用,同时它们也会被打包 |
provided | 依赖只有在当JDK 或者一个容器已提供该依赖之后才使用。例如, 如果你开发了一个web 应用,你可能在编译 classpath 中需要可用的Servlet API 来编译一个servlet,但是你不会想要在打包好的WAR 中包含这个Servlet API;这个Servlet API JAR 由你的应用服务器或者servlet 容器提供。已提供范围的依赖在编译classpath (不是运行时)可用。它们不是传递性的,也不会被打包。 |
runtime | 依赖在运行和测试系统的时候需要,但在编译的时候不需要。比如,你可能在编译的时候只需要JDBC API JAR,而只有在运行的时候才需要JDBC驱动实现。 |
test | test范围依赖 在一般的编译和运行时都不需要,它们只有在测试编译和测试运行阶段可用 |
system | system范围依赖与provided 类似,但是你必须显式的提供一个对于本地系统中JAR 文件的路径。这么做是为了允许基于本地对象编译,而这些对象是系统类库的一部分。这样的构件应该是一直可用的,Maven 也不会在仓库中去寻找它。如果你将一个依赖范围设置成系统范围,你必须同时提供一个 systemPath 元素。注意该范围是不推荐使用的(你应该一直尽量去从公共或定制的 Maven 仓库中引用依赖) |
3) maven的build:
<build> <defaultGoal>install</defaultGoal> <directory>${basedir}/target</directory> <finalName>${artifactId}-${version}</finalName> <filters> <filter>filters/filter1.properties</filter> </filters> ...
</build>
上述例子中:
<build> ... <resources> <resource> <targetPath>META-INF/plexus</targetPath> <filtering>false</filtering> <directory>${basedir}/src/main/plexus</directory> <includes> <include>configuration.xml</include> </includes> <excludes> <exclude>**/*.properties</exclude> </excludes> </resource> </resources> <testResources> ... </testResources> ...
</build>
1、resources:一个resource元素的列表,每一个都描述与项目关联的文件是什么和在哪里;
2、targetPath:指定build后的resource存放的文件夹。该路径默认是basedir。通常被打包在JAR中的resources的目标路径为META-INF;
3、filtering:true/false,表示为这个resource,filter是否激活。
4、directory:定义resource所在的文件夹,默认为${basedir}/src/main/resources;
5、includes:指定作为resource的文件的匹配模式,用*作为通配符;
6、excludes:指定哪些文件被忽略,如果一个文件同时符合includes和excludes,则excludes生效;
7、testResources:定义和resource类似,但只在test时使用,默认的test resource文件夹路径是${basedir}/src/test/resources,test resource不被部署。
<build> ... <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.0</version> <extensions>false</extensions> <inherited>true</inherited> <configuration> <classifier>test</classifier> </configuration> <dependencies>...</dependencies> <executions>...</executions> </plugin> </plugins>
</build>
除了groupId:artifactId:version标准坐标,plugin还需要如下属性:
1、extensions:true/false,是否加载plugin的extensions,默认为false;
2、inherited:true/false,这个plugin是否应用到该POM的孩子POM,默认true;
3、configuration:配置该plugin期望得到的properies,如上面的例子,我们为maven-jar-plugin的Mojo设置了classifier属性;如果你的POM有一个parent,它可以从parent的build/plugins或者pluginManagement集成plugin配置。
三. maven-jar-plugin插件
使用 Maven 构建一个 JAR 文件比较容易:只要定义项目包装为 “jar”,然后执行包装生命周期阶段即可。但是定义一个可执行 JAR 文件却比较麻烦。采取以下步骤可以更高效:
- a. 在您定义可执行类的 JAR 的 MANIFEST.MF 文件中定义一个
main
类。(MANIFEST.MF 是包装您的应用程序时 Maven 生成的。) - b. 找到您项目依赖的所有库。
- c. 在您的 MANIFEST.MF 文件中包含那些库,便于您的应用程序找到它们。
您可以手工进行这些操作,或者要想更高效,您可以使用两个 Maven 插件帮助您完成:maven-jar-plugin
和 maven-dependency-plugin
。
01.指定manfestFile位置:具体配置如下:
<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><version>3.0.2</version><configuration><archive><manifestFile>${project.build.outputDirectory}/META-INF/MANIFEST.MF</manifestFile></archive></configuration>...</plugin></plugins></build>...
</project>
02. 使用maven-jar-plugin 修改 MANIFEST.MF文件,具体代码如下:
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-jar-plugin</artifactId><configuration><archive><manifest><addClasspath>true</addClasspath><classpathPrefix>lib/</classpathPrefix><mainClass>com.mypackage.MyClass</mainClass></manifest></archive></configuration>
</plugin>
所有 Maven 插件通过一个 <configuration>
元素公布了其配置,在本例中,maven-jar-plugin
修改它的 archive
属性,特别是存档文件的 manifest
属性,它控制 MANIFEST.MF 文件的内容。包括 3 个元素:
addClassPath
:将该元素设置为 true 告知maven-jar-plugin
添加一个Class-Path
元素到 MANIFEST.MF 文件,以及在Class-Path
元素中包括所有依赖项。classpathPrefix
:如果您计划在同一目录下包含有您的所有依赖项,作为您将构建的 JAR,那么您可以忽略它;否则使用classpathPrefix
来指定所有依赖 JAR 文件的前缀。在清单 1 中,classpathPrefix
指出,相对存档文件,所有的依赖项应该位于 “lib
” 文件夹。mainClass
:当用户使用lib
命令执行 JAR 文件时,使用该元素定义将要执行的类名。上述可以通过是用maven-dependency-plugin将依赖包添加进去
lib
文件夹。为此,使用 maven-dependency-plugin。代码如下:
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-dependency-plugin</artifactId><executions><execution><id>copy</id><phase>install</phase><goals><goal>copy-dependencies</goal></goals><configuration><outputDirectory>${project.build.directory}/lib</outputDirectory></configuration></execution></executions>
</plugin>
maven-dependency-plugin
有一个 copy-dependencies
,目标是将您的依赖项复制到您所选择的目录。本例中,我将依赖项复制到 build
目录下的 lib
目录(project-home/target/lib
)。
将您的依赖项和修改的 MANIFEST.MF 放在适当的位置后,您就可以用一个简单的命令启动应用程序:
java -jar jarfilename.jar
<project>...<build><plugins><plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>3.1.0</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><relocations><relocation><pattern>org.codehaus.plexus.util</pattern><shadedPattern>org.shaded.plexus.util</shadedPattern><excludes><exclude>org.codehaus.plexus.util.xml.Xpp3Dom</exclude><exclude>org.codehaus.plexus.util.xml.pull.*</exclude></excludes></relocation></relocations></configuration></execution></executions></plugin></plugins></build>...
</project>
上面的配置将 org.codehaus.plexus.util jar 包重命名为 org.shaded.plexus.util。
<plugin><groupId>org.apache.maven.plugins</groupId><artifactId>maven-shade-plugin</artifactId><version>1.3.3</version><executions><execution><phase>package</phase><goals><goal>shade</goal></goals><configuration><outputFile>../target/ddstutorial.jar</outputFile><transformers><transformerimplementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer"/><transformerimplementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"><mainClass>XX.XXX.XXX.XXX.XXXMainclass</mainClass></transformer><transformerimplementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/spring.handlers</resource></transformer><transformeri implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/spring.schemas</resource></transformer></transformers></configuration></execution></executions></plugin>
上述列子中:注意transformer标签:主要作用为了防止classes/resource标签出现重叠,而导致混乱,引入了transfirner标签:其主要包括:
<transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/spring.handlers</resource></transformer><transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"><resource>META-INF/spring.schemas</resource></transformer>
<plugin><artifactId>maven-assembly-plugin</artifactId><version>3.1.0</version><configuration><outputDirectory>D:/testfolder</outputDirectory><descriptorRefs><descriptorRef>jar-with-dependencies</descriptorRef></descriptorRefs> <archive> <manifest> <mainClass>mainclass</mainClass> </manifest> </archive> </configuration><executions><execution><id>make-assembly</id><phase>package</phase><goals><goal>single</goal></goals></execution></executions></plugin></plugins>
<?xml version="1.0"?>-<assembly xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"><id>bin</id>-<formats><format>zip</format></formats>-<dependencySets>-<dependencySet><useProjectArtifact>true</useProjectArtifact><outputDirectory>lib</outputDirectory></dependencySet></dependencySets>-<fileSets>-<fileSet><outputDirectory>${file.separator}</outputDirectory>-<includes><include>README.txt</include></includes></fileSet>-<fileSet><directory>src/main/resources</directory><outputDirectory>${file.separator}bin</outputDirectory>-<includes><include>start.sh</include><include>start.bat</include></includes></fileSet>-<fileSet><directory>logs</directory><outputDirectory>${file.separator}logs</outputDirectory></fileSet>-<fileSet><directory>datas</directory><outputDirectory>${file.separator}datas</outputDirectory></fileSet>-<fileSet><directory>doc</directory><outputDirectory>${file.separator}doc</outputDirectory></fileSet></fileSets></assembly>
在POM中加入如下配置:
<plugin><artifactId>maven-assembly-plugin</artifactId><version>3.1.0</version><configuration><outputDirectory>D:/testfolder</outputDirectory><descriptors><descriptor>assembly.xml</descriptor></descriptors><archive> <manifest> <mainClass>XXXXMainClass</mainClass> </manifest> </archive> </configuration></plugin>
自此,介绍完毕
maven之打包插件(maven-assembly-plugin,maven-shade-plugin与maven-assembly-plugin)相关推荐
- maven项目打包报错Failed to execute goal org.apache.maven.plugins:maven-install-plugin:2.4:install (default
原因:缺少maven打包插件 解决办法:在pom.xml中加入如下 <build><plugins><plugin><groupId>org.apach ...
- Maven自定义打包插件Assembly Plugin简单使用
使用Assembly Plugin实现自定义打包 1.修改pom.xml <!-- 编译时自动打包,规则见distribution.xml文件--> <build><pl ...
- maven项目打包插件:将maven项目打包成一个可执行的jar(瘦jar)
通过maven-dependency-plugin插件和maven-jar-plugin来组合,maven-jar-plugin其实是maven项目自带的,在pom文件里面不依赖也是可以的,但是我需要 ...
- Maven学习总结(27)——Maven自定义打包插件maven-assembly-plugin详解
Assembly插件会生成 "assemblies", 此特性等同于的Maven 1 distribution plug-in..该插件不仅支持创建二进制归档文件,也支持创建源码归 ...
- maven assembly打包插件详解
定义 来自官方的定义: Maven Assembly Plugin relies on the provided assembly descriptors to dictate its executi ...
- 使用Maven 实现打包生成一个可执行jar包:附详细配置解释说明
1. 需求 项目打包,满足以下要求: 1.整个项目打一个Zip包下面包括应用程序.应用程序依赖的jar包.说明文档 2.项目打的jar包可以执行不同类里的Main函数 3.项目源码打的jar包要与依赖 ...
- maven-assembly-plugin maven自定义打包
当你使用 Maven 对项目打包时,你需要了解以下 3 个打包 plugin,它们分别是 plugin function maven-jar-plugin maven 默认打包插件,用来创建 proj ...
- Maven 生成打包可执行jar包
文章目录 1. 需求 2. 开发环境 3. Maven打包插件介绍 4. Maven使用maven-jar-plugin打可执行jar包 5. Maven使用maven-assembly-plugin ...
- maven项目打包成zip文件
1.添加Maven插件 pom.xml <!--maven自定义打包插件--><plugin><artifactId>maven-assembly-plugin&l ...
最新文章
- android handler作用,Android中Handler的作用
- Java并发- 读写锁中的性能之王:StampedLock
- .net 开发人员当前必须掌握的技术
- 职场社交方向私密研究(脉脉、linkedin、会会…)| 北京活动
- python最短路径例子_[python]dijkstra 算法的 加权的最短路径 案例
- win10 安装 cognos 10.2.0
- GNU make manual 翻译(六十六)
- 【Luat-air105】8.1 camera拍照
- android x5webview截长图
- unix下的softlink和hardlink
- MapReduce作业提交流程
- Map Coloring(翻译)
- leetcode 1175. Prime Arrangements(python)
- spring boot读取resources下面的文件图片
- CAD软件中沿墙镜像功能的使用技巧
- 腾讯IM实战:低代码超快实现即时通讯录
- 炸锅了!Google称2029年人类开始实现永生不死!疾病,衰老,痛苦将彻底消失!?...
- 阿里云天池大赛赛题(机器学习)——O2O优惠券预测(完整代码)
- 传统企业IT系统迁移上云-构建公有云PaaS+SaaS平台
- My97DatePicker设置,包括隐藏 清空,设置最大日期等
热门文章
- 网易编程题------操作序列
- 大兄dei,早点看清this吧
- Ubuntu 16.04安装Caffe的记录及FCN官方代码的配置
- linux下安装软件后的环境变量设置
- Phaser开源2d引擎 html5游戏框架中文简介
- http请求头中包含未编码中文时webapi self host崩溃
- 设计模式练习:Decorate模式
- deeplab v3+---Encoder-Decoder with Atrous Separable Convolution for Semantic Image Segmentation
- Navicat15连接Oracal失败解决办法
- 收集的图像处理网站http://blog.csdn.net/chief1985/article/details/1898358