Maven打包的三种方式

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>

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

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

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

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

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

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

在pom.xml中配置：

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

打包方式：

1. mvn package assembly:single

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

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

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

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

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

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

在pom.xml中配置：

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

自己代码中的shade+assembly:

pom.xml:

         <plugin>

                 <groupId>org.apache.maven.plugins</groupId>

                 <artifactId>maven-shade-plugin</artifactId>

                 <dependencies>

                     <dependency>

                         <groupId>org.springframework.boot</groupId>

                         <artifactId>spring-boot-maven-plugin</artifactId>

                         <version>1.5.17.RELEASE</version>

                     </dependency>

                 </dependencies>

                 <configuration>

                     <shadedArtifactAttached>true</shadedArtifactAttached>

                     <keepDependenciesWithProvidedScope>true</keepDependenciesWithProvidedScope>

                     <createDependencyReducedPom>false</createDependencyReducedPom>

                     <finalName>demo-web-server-shade</finalName>

                     <filters>

                         <filter>

                             <artifact>*:*</artifact>

                             <excludes>

                                 <exclude>META-INF/*.SF</exclude>

                                 <exclude>META-INF/*.DSA</exclude>

                                 <exclude>META-INF/*.RSA</exclude>

                             </excludes>

                         </filter>

                     </filters>

                 </configuration>

                 <executions>

                     <execution>

                         <phase>package</phase>

                         <goals>

                             <goal>shade</goal>

                         </goals>

                         <configuration>

                             <transformers>

                                 <transformer

                                     implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">

                                     <resource>META-INF/spring.handlers</resource>

                                 </transformer>

                                 <transformer

                                     implementation="org.springframework.boot.maven.PropertiesMergingResourceTransformer">

                                     <resource>META-INF/spring.factories</resource>

                                 </transformer>

                                 <transformer

                                     implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">

                                     <resource>META-INF/spring.schemas</resource>

                                 </transformer>

                                 <transformer

                                     implementation="org.apache.maven.plugins.shade.resource.ServicesResourceTransformer" />

                                 <transformer

                                     implementation="org.apache.maven.plugins.shade.resource.ManifestResourceTransformer">

                                     <mainClass>com.my.demo.httpserver.WebServerApplication</mainClass>

                                 </transformer>

                             </transformers>

                         </configuration>

                     </execution>

                 </executions>

             </plugin>

             <plugin>

                 <groupId>org.apache.maven.plugins</groupId>

                 <artifactId>maven-assembly-plugin</artifactId>

                 <executions>

                     <execution>

                         <id>assemble</id>

                         <goals>

                             <goal>single</goal>

                         </goals>

                         <phase>package</phase>

                         <configuration>

                             <descriptors>

                                 <descriptor>assembly.xml</descriptor>

                             </descriptors>

                         </configuration>

                     </execution>

                 </executions>

             </plugin>

assembly.xml:

 <?xml version="1.0" encoding="utf-8"?>

<assembly>

  <id>assembly</id>

  <includeBaseDirectory>false</includeBaseDirectory>

  <formats>

    <format>zip</format>

  </formats>

  <fileSets>

    <!-- <fileSet>

      <directory>src/main/resources/bin</directory>

      <includes>

        <include>start.sh</include>

        <include>env.sh</include>

        <include>stop.sh</include>

      </includes>

      <fileMode>0755</fileMode>

      <outputDirectory>/</outputDirectory>

    </fileSet> -->

    <fileSet>

      <directory>src/main/resources/configsec</directory>

      <includes>

        <include>important.properties</include>

      </includes>

      <outputDirectory>configsec/</outputDirectory>

    </fileSet>

    <fileSet>

      <directory>src/main/resources/lib</directory>

      <includes>

        <include>quasar-core-0.7.9-jdk8.jar</include>

      </includes>

      <outputDirectory>/</outputDirectory>

    </fileSet>

  </fileSets>

  <files>

    <file>

      <source>${project.build.directory}/demo-web-server-shade.jar</source>

      <outputDirectory>/</outputDirectory>

    </file>

  </files>

</assembly>

转自：https://blog.csdn.net/daiyutage/article/details/53739452

参考资料：

https://yq.aliyun.com/articles/308777

maven-shade-plugin：https://my.oschina.net/u/2377110/blog/1584205

maven-assembly-plugin：https://www.jianshu.com/p/14bcb17b99e0 https://blog.csdn.net/liupeifeng3514/article/details/79777976