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

时间：2023-03-08 17:26:32
Maven生成可以直接运行的jar包的多种方式

Maven可以使用mvn package指令对项目进行打包，如果使用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中配置：

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

	<plugins>

	&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;


</build>

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文件片段：

  1. Class-Path: lib/commons-logging-1.2.jar lib/commons-io-2.4.jar  
  2. Main-Class: com.xxg.Main  
Class-Path: lib/commons-logging-1.2.jar lib/commons-io-2.4.jar


Main-Class: com.xxg.Main

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

配置完成后，通过mvn package指令打包，会在target目录下生成jar包，并将依赖包拷贝到target/lib目录下，目录结构如下：

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

指定了Main-Class，有了依赖包，那么就可以直接通过java -jar xxx.jar运行jar包。

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

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

在pom.xml中配置：

  1. <build>  
  2.     <plugins>  
  3.   
  4.         <plugin>  
  5.             <groupId>org.apache.maven.plugins</groupId>  
  6.             <artifactId>maven-assembly-plugin</artifactId>  
  7.             <version>2.5.5</version>  
  8.             <configuration>  
  9.                 <archive>  
  10.                     <manifest>  
  11.                         <mainClass>com.xxg.Main</mainClass>  
  12.                     </manifest>  
  13.                 </archive>  
  14.                 <descriptorRefs>  
  15.                     <descriptorRef>jar-with-dependencies</descriptorRef>  
  16.                 </descriptorRefs>  
  17.             </configuration>  
  18.         </plugin>  
  19.   
  20.     </plugins>  
  21. </build>  
<build>


<plugins>

	&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;/plugin&gt;

&lt;/plugins&gt;


</build>

打包方式：

  1. mvn package assembly:single  
mvn package assembly:single

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

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

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


<plugins>

	&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;


</build>

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

不过，如果项目中用到spring Framework，用这种方式打出来的包运行时会出错，使用下面的方法三可以处理。

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

在pom.xml中配置：

  1. <build>  
  2.     <plugins>  
  3.   
  4.         <plugin>  
  5.             <groupId>org.apache.maven.plugins</groupId>  
  6.             <artifactId>maven-shade-plugin</artifactId>  
  7.             <version>2.4.1</version>  
  8.             <executions>  
  9.                 <execution>  
  10.                     <phase>package</phase>  
  11.                     <goals>  
  12.                         <goal>shade</goal>  
  13.                     </goals>  
  14.                     <configuration>  
  15.                         <transformers>  
  16.                             <transformer implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">  
  17.                                 <mainClass>com.xxg.Main</mainClass>  
  18.                             </transformer>  
  19.                         </transformers>  
  20.                     </configuration>  
  21.                 </execution>  
  22.             </executions>  
  23.         </plugin>  
  24.   
  25.     </plugins>  
  26. </build>  
<build>


<plugins>

	&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;/transformers&gt;

				&lt;/configuration&gt;

			&lt;/execution&gt;

		&lt;/executions&gt;

	&lt;/plugin&gt;

&lt;/plugins&gt;


</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来对文件内容追加合并：

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


<plugins>

	&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;


</build>

相关文章