Maven 打包的三种方式 和 Springboot 分离jar包

蔚落 2022-06-02 00:08 604阅读 0赞

http://blog.csdn.net/daiyutage/article/details/53739452

aven可以使用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中配置：

[html] view plain copy

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

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

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

[plain] view plain copy

  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插件用于将依赖包拷贝到${project.build.directory}/lib指定的位置，即lib目录下。

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

20150807174107439

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

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

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

在pom.xml中配置：

[html] view plain copy

  1. <**build**>
  2. <**plugins**>
  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**>
  20. </**plugins**>
  21. </**build**>

打包方式：

[plain] view plain copy

  1. mvn package assembly:single

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

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

[html] view plain copy

  1. <**build**>
  2. <**plugins**>
  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**>
  29. </**plugins**>
  30. </**build**>

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

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

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

在pom.xml中配置：

[html] view plain copy

  1. <**build**>
  2. <**plugins**>
  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**>
  25. </**plugins**>
  26. </**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来对文件内容追加合并：

[html] view plain copy

  1. <**build**>
  2. <**plugins**>
  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**>
  31. </**plugins**>
  32. </**build**>

SpringBoot 打包一般会自动打成一个统一的jar包，这样觉得比较臃肿,所以习惯上把配置文件和lib分离出来，便于修改替换。

参考文档：https://www.jianshu.com/p/dbdece9062b3

下面给出pom.xml样例

  1. <build>
  2.       <plugins>
  3. <!--         <plugin>
  4.             <groupId>org.springframework.boot</groupId>
  5.             <artifactId>spring-boot-maven-plugin</artifactId>
  6.          </plugin>-->
  8.          <!--打包jar-->
  9.          <plugin>
  10.             <groupId>org.apache.maven.plugins</groupId>
  11.             <artifactId>maven-jar-plugin</artifactId>
  12.             <configuration>
  13.                <!--   指定打出的jar的名字，下面打出来的名字就是atc.jar -->
  14.                <finalName>atc</finalName>
  15.                <archive>
  16.                   <manifest>
  17.                      <addClasspath>true</addClasspath>
  18.                      <!--MANIFEST.MF 中 Class-Path 加入前缀-->
  19.                      <classpathPrefix>lib/</classpathPrefix>
  20.                      <!--jar包不包含唯一版本标识-->
  21.                      <useUniqueVersions>false</useUniqueVersions>
  22.                      <!--指定入口类-->
  23.                      <mainClass>com.hdkg.atc.AtcApplication</mainClass>
  24.                   </manifest>
  25.                   <manifestEntries>
  26.                      <!--MANIFEST.MF 中 Class-Path 加入资源文件目录-->
  27.                      <Class-Path>./resources/</Class-Path>
  28.                   </manifestEntries>
  29.                </archive>
  30.                <excludes>
  31.                   <exclude>*.xml</exclude>
  32.                   <exclude>*.properties</exclude>
  33.                </excludes>
  34.                <outputDirectory>${project.build.directory}/dis</outputDirectory>
  35.             </configuration>
  36.          </plugin>
  38.          <!--拷贝依赖 copy-dependencies-->
  39.          <plugin>
  40.             <groupId>org.apache.maven.plugins</groupId>
  41.             <artifactId>maven-dependency-plugin</artifactId>
  42.             <executions>
  43.                <execution>
  44.                   <id>copy-dependencies</id>
  45.                   <phase>package</phase>
  46.                   <goals>
  47.                      <goal>copy-dependencies</goal>
  48.                   </goals>
  49.                   <configuration>
  50.                      <outputDirectory>
  51.                         ${project.build.directory}/dis/lib/
  52.                      </outputDirectory>
  53.                   </configuration>
  54.                </execution>
  55.             </executions>
  56.          </plugin>
  58.          <!--拷贝资源文件 copy-resources-->
  59.          <plugin>
  60.             <artifactId>maven-resources-plugin</artifactId>
  61.             <executions>
  62.                <execution>
  63.                   <id>copy-resources</id>
  64.                   <phase>package</phase>
  65.                   <goals>
  66.                      <goal>copy-resources</goal>
  67.                   </goals>
  68.                   <configuration>
  69.                      <resources>
  70.                         <resource>
  71.                            <directory>src/main/resources</directory>
  72.                         </resource>
  73.                      </resources>
  74.                      <outputDirectory>${project.build.directory}/dis/resources</outputDirectory>
  75.                   </configuration>
  76.                </execution>
  77.             </executions>
  78.          </plugin>
  79.       </plugins>
  80.    </build>

发表评论

表情：
评论列表 （有 0 条评论，604人围观）

还没有评论，来说两句吧...

相关阅读