1. 程式人生 > >Maven生成可以直接運行的jar包的多種方式

Maven生成可以直接運行的jar包的多種方式

install 找不到 source pre cti nta plugin work ofo

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中配置:

[html] view plain copy
  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文件片段:

[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插件用於將依賴包拷貝到<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中配置:

[html] view plain copy
  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>

打包方式:

[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>
  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中配置:

[html] view plain copy
  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來對文件內容追加合並:

[html] view plain copy
    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>

只有mvn install 和 mvn package
mvn install 是將你打好的jar包安裝到你的本地庫中,一般沒有設置過是在 用戶目錄下的 .m2\下面。
mvn package 只是將你的代碼打包到輸出目錄,一般的是 target下面。

這裏的maven install相當於maven原生的命令: mvn install

而這裏的maven build是 m2eclipse這個插件自己創造的概念,需要你來配置到底需要執行什麽命令

Maven生成可以直接運行的jar包的多種方式