Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

江南一點雨發表於2019-07-09

前兩天被人問到這樣一個問題:

“鬆哥,為什麼我的 Spring Boot 專案打包成的 jar ,被其他專案依賴之後,總是報找不到類的錯誤?”

大夥有這樣的疑問,就是因為還沒搞清楚可執行 jar 和普通 jar 到底有什麼區別?今天鬆哥就和大家來聊一聊這個問題。

多了一個外掛

Spring Boot 中預設打包成的 jar 叫做 可執行 jar,這種 jar 不同於普通的 jar,普通的 jar 不可以通過 java -jar xxx.jar 命令執行,普通的 jar 主要是被其他應用依賴,Spring Boot 打成的 jar 可以執行,但是不可以被其他的應用所依賴,即使強制依賴,也無法獲取裡邊的類。但是可執行 jar 並不是 Spring Boot 獨有的,Java 工程本身就可以打包成可執行 jar 。

有的小夥伴可能就有疑問了,既然同樣是執行 mvn package 命令進行專案打包,為什麼 Spring Boot 專案就打成了可執行 jar ,而普通專案則打包成了不可執行 jar 呢?

這我們就不得不提 Spring Boot 專案中一個預設的外掛配置 spring-boot-maven-plugin ,這個打包外掛存在 5 個方面的功能,從外掛命令就可以看出:

Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

五個功能分別是:

  • build-info:生成專案的構建資訊檔案 build-info.properties
  • repackage:這個是預設 goal,在 mvn package 執行之後,這個命令再次打包生成可執行的 jar,同時將 mvn package 生成的 jar 重新命名為 *.origin
  • run:這個可以用來執行 Spring Boot 應用
  • start:這個在 mvn integration-test 階段,進行 Spring Boot 應用生命週期的管理
  • stop:這個在 mvn integration-test 階段,進行 Spring Boot 應用生命週期的管理

這裡功能,預設情況下使用就是 repackage 功能,其他功能要使用,則需要開發者顯式配置。

打包

repackage 功能的 作用,就是在打包的時候,多做一點額外的事情:

  1. 首先 mvn package 命令 對專案進行打包,打成一個 jar,這個 jar 就是一個普通的 jar,可以被其他專案依賴,但是不可以被執行
  2. repackage 命令,對第一步 打包成的 jar 進行再次打包,將之打成一個 可執行 jar ,通過將第一步打成的 jar 重新命名為 *.original 檔案

舉個例子:

對任意一個 Spring Boot 專案進行打包,可以執行 mvn package 命令,也可以直接在 IDEA 中點選 package ,如下 :

Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

打包成功之後, target 中的檔案如下:

Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

這裡有兩個檔案,第一個 restful-0.0.1-SNAPSHOT.jar 表示打包成的可執行 jar ,第二個 restful-0.0.1-SNAPSHOT.jar.original 則是在打包過程中 ,被重新命名的 jar,這是一個不可執行 jar,但是可以被其他專案依賴的 jar。通過對這兩個檔案的解壓,我們可以看出這兩者之間的差異。

兩種 jar 的比較

可執行 jar 解壓之後,目錄如下:

Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

可以看到,可執行 jar 中,我們自己的程式碼是存在 於 BOOT-INF/classes/ 目錄下,另外,還有一個 META-INF 的目錄,該目錄下有一個 MANIFEST.MF 檔案,開啟該檔案,內容如下:

Manifest-Version: 1.0
Implementation-Title: restful
Implementation-Version: 0.0.1-SNAPSHOT
Start-Class: org.javaboy.restful.RestfulApplication
Spring-Boot-Classes: BOOT-INF/classes/
Spring-Boot-Lib: BOOT-INF/lib/
Build-Jdk-Spec: 1.8
Spring-Boot-Version: 2.1.6.RELEASE
Created-By: Maven Archiver 3.4.0
Main-Class: org.springframework.boot.loader.JarLauncher

可以看到,這裡定義了一個 Start-Class,這就是可執行 jar 的入口類,Spring-Boot-Classes 表示我們自己程式碼編譯後的位置,Spring-Boot-Lib 則表示專案依賴的 jar 的位置。

換句話說,如果自己要打一個可執行 jar 包的話,除了新增相關依賴之外,還需要配置 META-INF/MANIFEST.MF 檔案。

這是可執行 jar 的結構,那麼不可執行 jar 的結構呢?

我們首先將預設的字尾 .original 除去,然後給檔案重新命名,重新命名完成,進行解壓:

Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

解壓後可以看到,不可執行 jar 根目錄就相當於我們的 classpath,解壓之後,直接就能看到我們的程式碼,它也有 META-INF/MANIFEST.MF 檔案,但是檔案中沒有定義啟動類等。

Manifest-Version: 1.0
Implementation-Title: restful
Implementation-Version: 0.0.1-SNAPSHOT
Build-Jdk-Spec: 1.8
Created-By: Maven Archiver 3.4.0

注意

這個不可以執行 jar 也沒有將專案的依賴打包進來。

從這裡我們就可以看出,兩個 jar ,雖然都是 jar 包,但是內部結構是完全不同的,因此一個可以直接執行,另一個則可以被其他專案依賴。

一次打包兩個 jar

一般來說,Spring Boot 直接打包成可執行 jar 就可以了,不建議將 Spring Boot 作為普通的 jar 被其他的專案所依賴。如果有這種需求,建議將被依賴的部分,單獨抽出來做一個普通的 Maven 專案,然後在 Spring Boot 中引用這個 Maven 專案。

如果非要將 Spring Boot 打包成一個普通 jar 被其他專案依賴,技術上來說,也是可以的,給 spring-boot-maven-plugin 外掛新增如下配置:

<build>
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <classifier>exec</classifier>
            </configuration>
        </plugin>
    </plugins>
</build>

配置的 classifier 表示可執行 jar 的名字,配置了這個之後,在外掛執行 repackage 命令時,就不會給 mvn package 所打成的 jar 重新命名了,所以,打包後的 jar 如下:

Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

第一個 jar 表示可以被其他專案依賴的 jar ,第二個 jar 則表示一個可執行 jar。

好了,關於 Spring Boot 中 jar 的問題,我們就說這麼多,有問題歡迎留言討論。

關注公眾號【江南一點雨】,專注於 Spring Boot+微服務以及前後端分離等全棧技術,定期視訊教程分享,關注後回覆 Java ,領取鬆哥為你精心準備的 Java 乾貨!
Spring Boot 打包成的可執行 jar ,為什麼不能被其他專案依賴?

相關文章