Maven生成可以直接运行的jar包的多种方式

港控/mmm° 2022-06-12 02:24 345阅读 0赞

转载自：http://xxgblog.com/2015/08/07/maven-create-executable-jar/

大家都知道一个java应用项目可以打包成一个jar，当然你必须指定一个拥有main函数的main class作为你这个jar包的程序入口。

具体的方法是修改jar包内目录META-INF下的MANIFEST.MF文件。

比如有个叫做test.jar的jar包，里面有一个拥有main函数的main class：test.someClassName

我们就只要在MANIFEST.MF里面添加如下一句话：

Main-Class: test.someClassName

然后我们可以在控制台里输入java -jar test.jar即可以运行这个jar。

Maven可以使用`mvn package`指令对项目进行打包生成jar文件，如果直接使用`java -jar xxx.jar`指令运行jar文件，会出现”no main manifest attribute, in xxx.jar”（没有设置Main-Class）、ClassNotFoundException（找不到依赖包）等错误。

要想jar包能直接通过`java -jar xxx.jar`运行，需要满足：

1、在jar包中的META-INF/MANIFEST.MF中指定Main-Class，这样才能确定程序的入口在哪里；

2、要能加载到依赖包。

使用Maven有以下几种方法可以生成满足以上两个条件能直接运行的jar包，可以根据需要选择一种合适的方法。

## 方法一：使用maven-jar-plugin和maven-dependency-plugin插件打包 ##

在pom.xml中配置：

<table style=""> 
 <tbody style=""> 
 <tr style=""> 
 <td style=""> <pre style="">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 </pre> </td> 
 <td style=""> <pre style="">&lt;build&gt; &lt;plugins&gt; &lt;plugin&gt; &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt; &lt;artifactId&gt;maven-jar-plugin&lt;/artifactId&gt; &lt;version&gt;2.6&lt;/version&gt; &lt;configuration&gt; &lt;archive&gt; &lt;manifest&gt; &lt;addClasspath&gt;true&lt;/addClasspath&gt; &lt;classpathPrefix&gt;lib/&lt;/classpathPrefix&gt; &lt;mainClass&gt;com.xxg.Main&lt;/mainClass&gt; &lt;/manifest&gt; &lt;/archive&gt; &lt;/configuration&gt; &lt;/plugin&gt; &lt;plugin&gt; &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt; &lt;artifactId&gt;maven-dependency-plugin&lt;/artifactId&gt; &lt;version&gt;2.10&lt;/version&gt; &lt;executions&gt; &lt;execution&gt; &lt;id&gt;copy-dependencies&lt;/id&gt; &lt;phase&gt;package&lt;/phase&gt; &lt;goals&gt; &lt;goal&gt;copy-dependencies&lt;/goal&gt; &lt;/goals&gt; &lt;configuration&gt; &lt;outputDirectory&gt;${project.build.directory}/lib&lt;/outputDirectory&gt; &lt;/configuration&gt; &lt;/execution&gt; &lt;/executions&gt; &lt;/plugin&gt; &lt;/plugins&gt; &lt;/build&gt; </pre> </td> 
 </tr> 
 </tbody> 
</table>

maven-jar-plugin用于生成META-INF/MANIFEST.MF文件的部分内容，`<mainClass>com.xxg.Main</mainClass>`指定MANIFEST.MF中的Main-Class，`<addClasspath>true</addClasspath>`会在MANIFEST.MF加上Class-Path项并配置依赖包，`<classpathPrefix>lib/</classpathPrefix>`指定依赖包所在目录。

例如下面是一个通过maven-jar-plugin插件生成的MANIFEST.MF文件片段：

<table style=""> 
 <tbody style=""> 
 <tr style=""> 
 <td style=""> <pre style="">1 2 </pre> </td> 
 <td style=""> <pre style="">Class-Path: lib/commons-logging-1.2.jar lib/commons-io-2.4.jar Main-Class: com.xxg.Main </pre> </td> 
 </tr> 
 </tbody> 
</table>

不过仅仅生成MANIFEST.MF文件还不够，maven-dependency-plugin插件用于将依赖包拷贝到`<outputDirectory>${project.build.directory}/lib</outputDirectory>`指定的位置，即lib目录下。

配置完成后，通过`mvn package`指令打包，会在target目录下生成jar包，并将依赖包拷贝到target/lib目录下，目录结构如下：  
[![目录结构][20150807174107439.jpg]][20150807174107439.jpg]目录结构  
指定了Main-Class，有了依赖包，那么就可以直接通过`java -jar xxx.jar`运行jar包。

不过这种方式生成jar包有个缺点，就是生成的jar包太多不便于管理，下面两种方式只生成单个jar文件，包含项目本身的代码、资源以及所有的依赖包。

## 方法二：使用maven-assembly-plugin插件打包 ##

在pom.xml中配置：

打包方式：

<table style=""> 
 <tbody style=""> 
 <tr style=""> 
 <td style=""> <pre style="">1 </pre> </td> 
 <td style=""> <pre style="">mvn package assembly:single </pre> </td> 
 </tr> 
 </tbody> 
</table>

打包后会在target目录下生成一个`xxx-jar-with-dependencies.jar`文件，这个文件不但包含了自己项目中的代码和资源，还包含了所有依赖包的内容。所以可以直接通过`java -jar`来运行。

此外还可以直接通过`mvn package`来打包，无需`assembly:single`，不过需要加上一些配置：

<table style=""> 
 <tbody style=""> 
 <tr style=""> 
 <td style=""> <pre style="">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 </pre> </td> 
 <td style=""> <pre style="">&lt;build&gt; &lt;plugins&gt; &lt;plugin&gt; &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt; &lt;artifactId&gt;maven-assembly-plugin&lt;/artifactId&gt; &lt;version&gt;2.5.5&lt;/version&gt; &lt;configuration&gt; &lt;archive&gt; &lt;manifest&gt; &lt;mainClass&gt;com.xxg.Main&lt;/mainClass&gt; &lt;/manifest&gt; &lt;/archive&gt; &lt;descriptorRefs&gt; &lt;descriptorRef&gt;jar-with-dependencies&lt;/descriptorRef&gt; &lt;/descriptorRefs&gt; &lt;/configuration&gt; &lt;executions&gt; &lt;execution&gt; &lt;id&gt;make-assembly&lt;/id&gt; &lt;phase&gt;package&lt;/phase&gt; &lt;goals&gt; &lt;goal&gt;single&lt;/goal&gt; &lt;/goals&gt; &lt;/execution&gt; &lt;/executions&gt; &lt;/plugin&gt; &lt;/plugins&gt; &lt;/build&gt; </pre> </td> 
 </tr> 
 </tbody> 
</table>

其中`<phase>package</phase>`、`<goal>single</goal>`表示在执行package打包时，执行`assembly:single`，所以可以直接使用`mvn package`打包。

不过，如果项目中用到Spring Framework，用这种方式打出来的包运行时会出现读取XML schema文件异常等奇怪的错误，使用下面的方法三可以处理。

## 方法三：使用maven-shade-plugin插件打包 ##

在pom.xml中配置：

配置完成后，执行`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`来对文件内容追加合并：

<table style=""> 
 <tbody style=""> 
 <tr style=""> 
 <td style=""> <pre style="">1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 </pre> </td> 
 <td style=""> <pre style="">&lt;build&gt; &lt;plugins&gt; &lt;plugin&gt; &lt;groupId&gt;org.apache.maven.plugins&lt;/groupId&gt; &lt;artifactId&gt;maven-shade-plugin&lt;/artifactId&gt; &lt;version&gt;2.4.1&lt;/version&gt; &lt;executions&gt; &lt;execution&gt; &lt;phase&gt;package&lt;/phase&gt; &lt;goals&gt; &lt;goal&gt;shade&lt;/goal&gt; &lt;/goals&gt; &lt;configuration&gt; &lt;transformers&gt; &lt;transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer"&gt; &lt;mainClass&gt;com.xxg.Main&lt;/mainClass&gt; &lt;/transformer&gt; &lt;transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"&gt; &lt;resource&gt;META-INF/spring.handlers&lt;/resource&gt; &lt;/transformer&gt; &lt;transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer"&gt; &lt;resource&gt;META-INF/spring.schemas&lt;/resource&gt; &lt;/transformer&gt; &lt;/transformers&gt; &lt;/configuration&gt; &lt;/execution&gt; &lt;/executions&gt; &lt;/plugin&gt; &lt;/plugins&gt; &lt;/build&gt;</pre> </td> 
 </tr> 
 </tbody> 
</table>

[20150807174107439.jpg]: http://7xidft.com1.z0.glb.clouddn.com/blog/20150807174107439.jpg