Maven是什么
Maven是一个流行的Java构建工具,它提供了许多插件来帮助开发人员自动化构建和部署Java应用程序。其中一个重要的插件是Maven打包插件,它可以将Java项目打包成可执行的JAR或WAR文件。在本文中,我们将深入探讨Maven打包插件的技术细节和使用方法。
Maven打包插件的作用
Maven打包插件是一个用于打包Java项目的Maven插件。它可以将项目的源代码、依赖项和其他资源打包成一个可执行的JAR或WAR文件。这个插件可以自动处理项目的依赖关系,并将它们打包到生成的文件中。此外,它还可以执行其他任务,如压缩文件、生成文档等。
首先先梳理一下关于打包 相关的常用的Maven插件工具:
- 使用清理插件:maven-clean-plugin: 执行清理删除已有target目录;
- 使用资源插件:maven-resources-plugin: 执行资源文件的处理
- 使用编译插件:maven-compiler-plugin: 编译所有源文件生成class文件至target\classes目录下
- 使用资源插件:maven-resources-plugin: 执行测试资源文件的处理
- 使用编译插件:maven-compiler-plugin: 编译测试目录下的所有源代码
- 使用插件:maven-surefire-plugin: 运行测试用例
- 使用插件:maven-jar-plugin: 对编译后生成的文件进行打包,
包名称默认为:artifactId-version,包文件保存在target目录下(这个生成的包不能在命令行中直接执行,因为我们还没有入口类配置到Manifest资源配置文件中去,后续会阐述)。
注意:不管是compile、package还是install等前三个步骤都是必不可少的。
Maven打包后经常出现的问题
- Maven可以使用mvn package指令对项目进行打包,如果使用Java -jar xxx.jar执行运行jar文件,会出现" no main manifest attribute, in xxx.jar"(没有设置Main-Class)、ClassNotFoundException(找不到依赖包)等错误。
这个原因属于maven没有执行构建:maven构建可运行Jar包。
maven构建可运行Jar包
要想jar包能直接通过java -jar xxx.jar运行,需要满足: 1. 在jar包中的META-INF/MANIFEST.MF中指定Main-Class,这样才能确定程序的入口在哪里 2. 要能加载到依赖包,使用Maven有以下几种方法可以生成能直接运行的jar包,可以根据需要选择一种合适的方法
Maven打包的三种方式
Maven打包的最简单的方法
Maven打包插件的配置非常简单,只需要在项目的pom.xml文件中添加以下代码即可。
maven-jar-plugin
首先是在maven项目的pom.xml中添加打包的插件,这里有很多种方式的。最最简单的就是只使用maven-compiler-plugin、maven-jar-plugin插件,并且指定程序入口。
pom.xml文件为:
xml
复制代码
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>xx</groupId> <artifactId>xx</artifactId> <version>1.0-SNAPSHOT</version> <build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>1.8</source> <target>1.8</target> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <configuration> <archive> <manifest> <addClasspath>true</addClasspath> <useUniqueVersions>false</useUniqueVersions> <classpathPrefix>lib/</classpathPrefix> <mainClass>com.xx.Main</mainClass> </manifest> </archive> </configuration> </plugin> </plugins> </build> </project>
这个配置中,我们使用了Maven的maven-jar-plugin插件来打包项目。在插件的配置中,我们指定了生成的JAR文件的元数据,包括主类和类路径。这些信息将被写入JAR文件的MANIFEST.MF文件中,以便Java虚拟机可以正确地执行JAR文件。
MANIFEST.MF文件部分
- com.xx.Main指定MANIFEST.MF中的Main-Class
- true会在MANIFEST.MF加上Class-Path项并配置依赖包
- lib/指定依赖包所在目录。
MANIFEST.MF的文件内容
通过maven-jar-plugin插件生成的MANIFEST.MF文件片段:
vbnet
复制代码
Class-Path: lib/x.jar lib/xx.jar Main-Class: com.xxg.Main
当然生成MANIFEST.MF文件还不够,maven-dependency-plugin插件用于将依赖包拷贝到${project.build.directory}/lib指定的位置,即lib目录下。
jar包的拷贝机制
配置完成后,通过mvn package指令打包,会在target目录下生成jar包,并将依赖包拷贝到target/lib目录下。
在pom.xml中配置
xml
复制代码
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>2.6</version> <configuration> <archive> <manifest> <addClasspath>true</addClasspath> <classpathPrefix>lib/</classpathPrefix> <mainClass>com.xx.Main</mainClass> </manifest> </archive> </configuration> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-dependency-plugin</artifactId> <version>2.10</version> <executions> <execution> <id>copy-dependencies</id> <phase>package</phase> <goals> <goal>copy-dependencies</goal> </goals> <configuration> <outputDirectory>${project.build.directory}/lib</outputDirectory> </configuration> </execution> </executions> </plugin> </plugins> </build>
指定了Main-Class,有了依赖包,那么就可以直接通过java -jar xxx.jar运行jar包。这种方式生成jar包有个缺点,就是生成的jar包太多不便于管理,下面两种方式只生成一个jar文件,包含项目本身的代码、资源以及所有的依赖包,接下来我们 好好分析一下这种打包方式的局限性。
maven-jar-plugin的局限性
如果一个maven项目中有多个子目录,每一个子目录中的pom.xml对应一个项目,它的作用范围只有这一个目录下的。比如扫描配置文件,如果要让一个目录下的pom.xml扫描另一个目录下的配置文件,那是做不到的。在打jar包的时候,只运行当前的pom.xml文件。
当然也有其他的打包方法,比如使用spring-boot-maven-plugin插件在打Jar包时,会引入依赖包。
maven-shade-plugin
由于上面的打包过程实在是过于的繁琐,而且也没有利用到maven管理项目的特色。接下来我们采用maven中的maven-shade-plugin插件进行资源打包,在pom.xml中,加入如下的信息来加入插件。
使用maven-shade-plugin插件打包
在pom.xml中配置:
xml
复制代码
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>2.4.1</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <configuration> <transformers> <transformer implementation="org.apache.maven.plugins.shade.resource.Mani festResourceTransformer"> <mainClass>com.xx.Main</mainClass> </transformer> </transformers> </configuration> </execution> </executions> </plugin> </plugins> </build>
配置完成后,执行mvn package即可打包。在target目录下会生成两个jar包,注意不是original-xxx.jar文件,而是另外一个。
和maven-assembly-plugin一样,生成的jar文件包含了所有依赖,所以可以直接运行。如果项目中用到了Spring Framework,将依赖打到一个jar包中,运行时会出现读取XML schema文件出错。
原因是Spring Framework的多个jar包中包含相同的文件spring.handlers和spring.schemas,如果生成一个jar包会互相覆盖。为了避免互相影响,可以使用AppendingTransformer来对文件内容追加合并:
xml
复制代码
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-shade-plugin</artifactId> <version>2.4.1</version> <executions> <execution> <phase>package</phase> <goals> <goal>shade</goal> </goals> <configuration> <transformers> <transformer implementation="org.apache.maven.plugins.shade.resource.Mani festResourceTransformer"> <mainClass>com.xxg.Main</mainClass> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.App endingTransformer"> <resource>META-INF/spring.handlers</resource> </transformer> <transformer implementation="org.apache.maven.plugins.shade.resource.App endingTransformer"> <resource>META-INF/spring.schemas</resource> </transformer> </transformers> </configuration> </execution> </executions> </plugin> </plugins> </build>
这里面配置了一个configuration标签内容,在此标签下面 有一个transformer标签,用来配置Main函数的入口 ( com.xx.Main),当然此标签内容很复杂,不是上面写的那么简单,上面之所以如此简单,是因为在所有类中(包括第三方Jar)只有一个Main方法。如果第三方jar中有Main方法,就要进行额外的配置,上面这么配置,不一定能执行成功。
在加入这段代码到pom.xml之后,我们就可以用maven的命令去打包了。其指令如下:
- mvn clean compile :清除之前target编译文件并重新编译
- mvn clean package :对项目进行打包(因为配置过插件,所以jar包是可执行的)
- mvn clean install :安装项目,然后就可以使用了
上面的方法,我们还需要点击很多命令去打包。这次利用一个新的插件,可以打包更简单。同样,在pom.xml中加入如下代码。上文的maven-shade-plugin插件代码可以删除。
maven-assembly-plugin
使用maven-assembly-plugin插件打包,这里同样配置了一个manifest标签来配置Main函数的入口。然后通过如下指令来实现打包。
在pom.xml中配置:
xml
复制代码
<plugin> <artifactId>maven-assembly-plugin</artifactId> <version>2.4</version> <configuration> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> <archive> <manifest> <mainClass>Main.Main</mainClass> </manifest> </archive> </configuration> <executions> <execution> <id>make-assembly</id> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin>
maven指令
shell
复制代码
mvn assembly:assembly
含有依赖方面所对应的jar包依赖的核心数据包
xml
复制代码
<build> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>2.5.5</version> <configuration> <archive> <manifest> <mainClass>com.xxg.Main</mainClass> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> </plugin> </plugins> </build>
打包方式:
vbnet
复制代码
mvn package assembly:single
打包后会在target目录下生成一个xxx-jar-with-dependencies.jar文件,这个文件不但包含了自己项目中的代码和资源,还包含了所有依赖包的内容。所以可以直接通过java -jar来运行。此外还可以直接通过mvn package来打包,无需assembly:single,不过需要加上一些配置:
xml
复制代码
<plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <version>2.5.5</version> <configuration> <archive> <manifest> <mainClass>com.xxg.Main</mainClass> </manifest> </archive> <descriptorRefs> <descriptorRef>jar-with-dependencies</descriptorRef> </descriptorRefs> </configuration> <executions> <execution> <id>make-assembly</id> <phase>package</phase> <goals> <goal>single</goal> </goals> </execution> </executions> </plugin> </plugins> </build>
其中package、single即表示在执行package打包时,执行assembly:single,所以可以直接使用mvn package打包。
不过,如果项目中用到spring Framework,用这种方式打出来的包运行时会出错,使用下面的方法三可以处理。