SpringBoot 中怎么部署Jar 文件

SpringBoot 中怎么部署Jar 文件，針對這個問題，這篇文章詳細介紹了相對應的分析和解答，希望可以幫助更多想解決這個問題的小伙伴找到更簡單易行的方法。

主要配置：

<build>
    <finalName>${project.artifactId}</finalName>
    <!--
    特別注意：
    項目僅僅是為了演示配置方便，直接在parent的build部分做了插件配置和運行定義。
    但是實際項目中需要把這些定義只放到spring boot模塊項目（可優化使用pluginManagement形式），避免干擾其他util、common等模塊項目
    -->
    <plugins>
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
        </plugin>
    </plugins>
</build>

配置輸出：

cd package-optimize-level0
mvn clean install

ls -lh package-optimize-app1/target/package-optimize-app1.jar
-rw-r--r--  1 lixia  wheel    16M Feb 24 21:06 package-optimize-app1/target/package-optimize-app1.jar

java -jar package-optimize-app1/target/package-optimize-app1.jar

重點說明：

• （當前演示應用僅依賴了spring-boot-starter-web極少組件，所有構建輸出只有十來MB）實際情況單一構建根據項目依賴組件量輸出jar一般在幾十MB到一兩百MB甚至更大。

• 假如有十來個微服務需要部署，那就意味著需要傳輸一兩個GB的文件，耗時可想而知。就算是單一更新個別微服務也需要傳輸一兩百MB。

Level 1：常見的依賴jar分離構建方式

參考項目目錄：package-optimize-level1

關解決問題：

• 降低單個微服務jar的文件大小，以便部署過程秒傳文件。 主要配置：

重點配置說明請詳見如下注釋說明：

<build>
    <finalName>${project.artifactId}</finalName>
    <!--
    特別注意：
    項目僅僅是為了演示配置方便，直接在parent的build部分做了插件配置和運行定義。
    但是實際項目中需要把這些定義只放到spring boot模塊項目（可優化使用pluginManagement形式），避免干擾其他util、common等模塊項目
    -->
    <plugins>
        <!-- 拷貝項目所有依賴jar文件到構建lib目錄下 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <outputDirectory>${project.build.directory}/lib</outputDirectory>
                        <excludeTransitive>false</excludeTransitive>
                        <stripVersion>false</stripVersion>
                        <silent>true</silent>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- Spring Boot模塊jar構建 -->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <includes>
                    <!-- 不存在的include引用，相當于排除所有maven依賴jar，沒有任何三方jar文件打入輸出jar -->
                    <include>
                        <groupId>null</groupId>
                        <artifactId>null</artifactId>
                    </include>
                </includes>
                <layout>ZIP</layout>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

配置輸出：

cd package-optimize-level1
mvn clean install

ls -lh package-optimize-app1/target/package-optimize-app1.jar
-rw-r--r--  1 lixia  wheel   149K Feb 24 20:56 package-optimize-app1/target/package-optimize-app1.jar

java -jar -Djava.ext.dirs=lib package-optimize-app1/target/package-optimize-app1.jar

實現效果：

• 單一構建根據項目依賴組件量輸出jar一般僅有一兩百KB，基本可以做到秒傳。

• 這個是網上可見最常見的優化方案，還值得繼續深入：假如有十來個微服務，每個服務一個jar和一個lib目錄文件，首次部署也差不多需要傳輸一兩個GB文件。

Level 2：合并所有模塊依賴jar到同一個lib目錄

參考項目目錄：package-optimize-level2

解決問題：

• 合并所有模塊依賴jar到同一個lib目錄，一般由于各模塊項目依賴jar重疊程度很高，合并所有服務部署文件總計大小基本也就兩三百MB

• 但是如果采用-Djava.ext.dirs=lib加載所有jar到每個JVM，一來每個JVM都完整加載了所有jar耗費資源，二來各微服務組件版本不同會出現版本沖突問題

主要配置：

重點配置說明請詳見如下注釋說明：

<build>
    <finalName>${project.artifactId}</finalName>
    <!--
    特別注意：
    項目僅僅是為了演示配置方便，直接在parent的build部分做了插件配置和運行定義。
    但是實際項目中需要把這些定義只放到spring boot模塊項目（可優化使用pluginManagement形式），避免干擾其他util、common等模塊項目
    -->
    <plugins>
        <!-- 基于maven-jar-plugin插件實現把依賴jar定義寫入輸出jar的META-INFO/MANIFEST文件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>lib/</classpathPrefix>
                        <useUniqueVersions>false</useUniqueVersions>
                    </manifest>
                </archive>
            </configuration>
        </plugin>
        <!-- 拷貝項目所有依賴jar文件到構建lib目錄下 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <!--
                        各子模塊按照實際層級定義各模塊對應的屬性值，檢查所有微服務模塊依賴jar文件合并復制到同一個目錄
                        詳見各子模塊中 boot-jar-output 屬性定義
                        -->
                        <outputDirectory>${boot-jar-output}/lib</outputDirectory>
                        <excludeTransitive>false</excludeTransitive>
                        <stripVersion>false</stripVersion>
                        <silent>false</silent>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- Spring Boot模塊jar構建 -->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <includes>
                    <!-- 不存在的include引用，相當于排除所有maven依賴jar，沒有任何三方jar文件打入輸出jar -->
                    <include>
                        <groupId>null</groupId>
                        <artifactId>null</artifactId>
                    </include>
                </includes>
                <layout>ZIP</layout>
                <!--
                基于maven-jar-plugin輸出微服務jar文件進行二次spring boot重新打包文件的輸出目錄
                所有微服務構建輸出jar文件統一輸出到與lib同一個目錄，便于共同引用同一個lib目錄
                詳見各子模塊中boot-jar-output屬性定義
                -->
                <!--  -->
                <outputDirectory>${boot-jar-output}</outputDirectory>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

所有lib目錄文件及各微服務構建jar聚合到devops公共目錄。

微服務jar文件中的META-INFO/MANIFEST文件中會生成根據模塊依賴組件列表的Class-Path屬性， 從而避免了不同版本jar：

Class-Path: lib/spring-boot-starter-web-2.4.3.jar lib/spring-boot-starte
 r-2.4.3.jar lib/spring-boot-2.4.3.jar lib/spring-boot-autoconfigure-2.4
 .3.jar lib/spring-boot-starter-logging-2.4.3.jar lib/logback-classic-1.
 2.3.jar lib/logback-core-1.2.3.jar lib/slf4j-api-1.7.30.jar lib/log4j-t
 o-slf4j-2.13.3.jar lib/log4j-api-2.13.3.jar lib/jul-to-slf4j-1.7.30.jar
  lib/jakarta.annotation-api-1.3.5.jar lib/spring-core-5.3.4.jar lib/spr
 ing-jcl-5.3.4.jar lib/snakeyaml-1.27.jar lib/spring-boot-starter-json-2
 .4.3.jar lib/jackson-databind-2.11.4.jar lib/jackson-annotations-2.11.4
 .jar lib/jackson-core-2.11.4.jar lib/jackson-datatype-jdk8-2.11.4.jar l
 ib/jackson-datatype-jsr310-2.11.4.jar lib/jackson-module-parameter-name
 s-2.11.4.jar lib/spring-boot-starter-tomcat-2.4.3.jar lib/tomcat-embed-
 core-9.0.43.jar lib/jakarta.el-3.0.3.jar lib/tomcat-embed-websocket-9.0
 .43.jar lib/spring-web-5.3.4.jar lib/spring-beans-5.3.4.jar lib/spring-
 webmvc-5.3.4.jar lib/spring-aop-5.3.4.jar lib/spring-context-5.3.4.jar 
 lib/spring-expression-5.3.4.jar

配置輸出：

cd package-optimize-level2
mvn clean install

ls -lh devops/
total 912
drwxr-xr-x  34 lixia  wheel   1.1K Feb 24 22:27 lib
-rw-r--r--   1 lixia  wheel   150K Feb 24 22:31 package-optimize-app1.jar
-rw-r--r--   1 lixia  wheel   149K Feb 24 22:31 package-optimize-app2.jar
-rw-r--r--   1 lixia  wheel   149K Feb 24 22:31 package-optimize-app3.jar

java -jar devops/package-optimize-app1.jar

實現效果：

• 啟動過程不再需要 -Djava.ext.dirs=lib 參數定義。

• 所有微服務jar引用所有項目合并依賴組件的公共目錄，部署文件總計大小一般在兩三百MB。

• 通過定制每個微服務jar文件中的META-INFO/MANIFEST文件中的Class-Path明確指明依賴版本組件類，解決各微服務不同組件版本沖突問題。

Level 3：支持system引入的非官方的三方依賴組件

參考項目目錄：package-optimize-level3

解決問題：

• 有些非官方三方的諸如sdk jar，一種做法是提交到Maven本地私服中去引用，那和普通依賴jar處理相同；但是在沒有maven私服的情況下，常見的簡化做法都是直接在項目中放置依賴jar然后在pom中以system scope方式定義。

• 對于在pom中是以systemPath方式引入的，maven-jar-plugin組件沒有直接參數聲明包含指定scope的組件， 如果不做特殊處理META-INFO/MANIFEST中不會出現這些scope定義的組件，導致運行時類找不到。

主要配置：

重點配置說明請詳見如下注釋說明：

<build>
    <finalName>${project.artifactId}</finalName>
    <!--
    特別注意：
    項目僅僅是為了演示配置方便，直接在parent的build部分做了插件配置和運行定義。
    但是實際項目中需要把這些定義只放到spring boot模塊項目（可優化使用pluginManagement形式），避免干擾其他util、common等模塊項目
    -->
    <plugins>
        <!-- 基于maven-jar-plugin插件實現把依賴jar定義寫入輸出jar的META-INFO/MANIFEST文件 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-jar-plugin</artifactId>
            <configuration>
                <archive>
                    <manifest>
                        <addClasspath>true</addClasspath>
                        <classpathPrefix>lib/</classpathPrefix>
                        <useUniqueVersions>false</useUniqueVersions>
                    </manifest>
                    <manifestEntries>
                        <!--
                        有些非官方三方的諸如sdk jar在pom中是以systemPath方式引入的，maven-jar-plugin組件沒有直接參數聲明包含指定scope的組件
                        通過使用額外定義 Class-Path 值來追加指定依賴組件列表，在子模塊按實際情況指定 jar-manifestEntries-classpath 值即可
                        例如(注意前面個點字符及各空格分隔符)：. lib/xxx-1.0.0.jar lib/yyy-2.0.0.jar
                        詳見各子模塊中 boot-jar-output 屬性定義示例
                        -->
                        <Class-Path>${jar-manifestEntries-classpath}</Class-Path>
                    </manifestEntries>
                </archive>
            </configuration>
        </plugin>
        <!-- 拷貝項目所有依賴jar文件到構建lib目錄下 -->
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-dependency-plugin</artifactId>
            <executions>
                <execution>
                    <id>copy-dependencies</id>
                    <phase>package</phase>
                    <goals>
                        <goal>copy-dependencies</goal>
                    </goals>
                    <configuration>
                        <!--
                        各子模塊按照實際層級定義各模塊對應的屬性值，檢查所有微服務模塊依賴jar文件合并復制到同一個目錄
                        詳見各子模塊中 boot-jar-output 屬性定義
                        -->
                        <outputDirectory>${boot-jar-output}/lib</outputDirectory>
                        <excludeTransitive>false</excludeTransitive>
                        <stripVersion>false</stripVersion>
                        <silent>false</silent>
                    </configuration>
                </execution>
            </executions>
        </plugin>
        <!-- Spring Boot模塊jar構建 -->
        <plugin>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-maven-plugin</artifactId>
            <configuration>
                <includes>
                    <!-- 不存在的include引用，相當于排除所有maven依賴jar，沒有任何三方jar文件打入輸出jar -->
                    <include>
                        <groupId>null</groupId>
                        <artifactId>null</artifactId>
                    </include>
                </includes>
                <layout>ZIP</layout>
                <!--
                基于maven-jar-plugin輸出微服務jar文件進行二次spring boot重新打包文件的輸出目錄
                所有微服務構建輸出jar文件統一輸出到與lib同一個目錄，便于共同引用同一個lib目錄
                詳見各子模塊中boot-jar-output屬性定義
                -->
                <!--  -->
                <outputDirectory>${boot-jar-output}</outputDirectory>
            </configuration>
            <executions>
                <execution>
                    <goals>
                        <goal>repackage</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

子模塊主要配置：

    <properties>
        <!-- 按各模塊實際目錄層次定義相對數據，使所有服務模塊輸出資源匯聚到相同目錄 -->
        <boot-jar-output>../devops</boot-jar-output>
        <!--
        有些供應商的sdk jar在pom中是以systemPath方式引入的，maven-jar-plugin組件沒有直接參數聲明包含指定scope的組件
        通過使用額外定義 Class-Path 值來追加指定依賴組件列表，按實際情況指定 jar-manifestEntries-classpath 值即可
        例如(注意前面個點字符及各空格分隔符，lib后面部分是 artifactId-version.jar 格式而不是實際文件名)：. lib/xxx-1.0.0.jar lib/yyy-2.0.0.jar
        -->
        <jar-manifestEntries-classpath>. lib/hik-sdk-1.0.0.jar</jar-manifestEntries-classpath>
    </properties>
    <dependencies>
        <!-- 以相對路徑方式定義非官方三方依賴組件 -->
        <dependency>
            <groupId>com.hik</groupId>
            <artifactId>hik-sdk</artifactId>
            <version>1.0.0</version>
            <scope>system</scope>
            <systemPath>${project.basedir}/lib/hik-sdk-1.0.0.jar</systemPath>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>

微服務輸出jar文件中的META-INFO/MANIFEST文件中會生成根據模塊依賴組件列表的Class-Path屬性， 最前面會追加 jar-manifestEntries-classpath 屬性定義值：

Class-Path: . lib/hik-sdk-1.0.0.jar lib/spring-boot-starter-web-2.4.3.ja
 r lib/spring-boot-starter-2.4.3.jar lib/spring-boot-2.4.3.jar lib/sprin
 g-boot-autoconfigure-2.4.3.jar lib/spring-boot-starter-logging-2.4.3.ja
 r lib/logback-classic-1.2.3.jar lib/logback-core-1.2.3.jar lib/slf4j-ap
 i-1.7.30.jar lib/log4j-to-slf4j-2.13.3.jar lib/log4j-api-2.13.3.jar lib
 /jul-to-slf4j-1.7.30.jar lib/jakarta.annotation-api-1.3.5.jar lib/sprin
 g-core-5.3.4.jar lib/spring-jcl-5.3.4.jar lib/snakeyaml-1.27.jar lib/sp
 ring-boot-starter-json-2.4.3.jar lib/jackson-databind-2.11.4.jar lib/ja
 ckson-annotations-2.11.4.jar lib/jackson-core-2.11.4.jar lib/jackson-da
 tatype-jdk8-2.11.4.jar lib/jackson-datatype-jsr310-2.11.4.jar lib/jacks
 on-module-parameter-names-2.11.4.jar lib/spring-boot-starter-tomcat-2.4
 .3.jar lib/tomcat-embed-core-9.0.43.jar lib/jakarta.el-3.0.3.jar lib/to
 mcat-embed-websocket-9.0.43.jar lib/spring-web-5.3.4.jar lib/spring-bea
 ns-5.3.4.jar lib/spring-webmvc-5.3.4.jar lib/spring-aop-5.3.4.jar lib/s
 pring-context-5.3.4.jar lib/spring-expression-5.3.4.jar

配置輸出：

cd package-optimize-level3
mvn clean install

ls -lh devops/
total 912
drwxr-xr-x  36 lixia  wheel   1.1K Feb 24 23:14 lib
-rw-r--r--@  1 lixia  wheel   150K Feb 24 23:14 package-optimize-app1.jar
-rw-r--r--   1 lixia  wheel   150K Feb 24 23:14 package-optimize-app2.jar
-rw-r--r--   1 lixia  wheel   150K Feb 24 23:14 package-optimize-app3.jar

java -jar devops/package-optimize-app1.jar

最終實現效果

• 所有服務的依賴組件合并到一個目錄，總計大小在兩三百MB，首次部署傳輸效率明顯提速。

• 各微服務jar一兩百KB大小，日常緊急修復Bug更新個別jar基本就是瞬間秒傳。

• 各微服務jar中各自定義依賴指定版本組件列表，不會出現組件不同版本加載沖突問題。

• 非官方的三方依賴組件也能正常引用處理。

關于SpringBoot 中怎么部署Jar 文件問題的解答就分享到這里了，希望以上內容可以對大家有一定的幫助，如果你還有很多疑惑沒有解開，可以關注億速云行業資訊頻道了解更多相關知識。