SpringBoot 部署 Jar 文件，瘦身優化指南！

時間 2021-04-10

標籤 java git github web spring express apache json api tomcat 欄目 Spring 简体版

原文原文鏈接

本文截取代碼片斷來自於對應的完整示例源碼工程：java

相關代碼和配置均實際執行測試過，如在驗證過程發現有任何問題可Issue反饋以便及時更正，感謝支持！git

概要說明github

隨着Spring Boot的流行，你們體驗到只需構建輸出一個jar文件，而後只需一個java -jar命令就能部署運行應用的爽快。常見一些單體應用隨着項目規模的擴展單個jar文件的大小愈來愈大，動輒兩三百MB。若是再引入微服務架構，動輒一二十個微服務，全部模塊jar加起來整個系統光部署文件就一兩個GB。web

一個系統一旦上線運行，不管新需求迭代仍是Bug修復，免不了須要作部署更新，尤爲對於一些交付類型項目，首次部署或異地更新，動不動就須要傳輸幾百MB或幾個GB的部署文件，確實是一個讓人頭疼的問題。spring

能夠想象一下，線上系統發現一個緊急嚴重Bug捅到了主管那裏，交代立刻緊急修復解決，研發同事火速分析排查分分鐘搞定提交代碼並完成構建打包並交付給運維。過一會領導着急上火來過問問題更新解決了嗎？運維只能很尷尬的回答：還沒呢，部署包文件比較大，正在上傳有點慢…express

一聽領導就火了，就改了幾行代碼，部署更新爲啥要上傳幾百MB的文件呢？難道沒有辦法優化一下嗎？apache

遇到這樣的狀況，建議你往下看，或許能找到你想要的答案。json

本文內容包括：api

如何把一兩百MB的單一Spring Boot jar文件，分離爲依賴組件lib目錄和一個業務jar來進行部署，優化單個jar文件大小到一兩百KB。。
如何把一二十個微服務高度重疊的依賴組件合併到單一lib目錄和多個一兩百KB的業務jar來進行部署，優化整個項目部署文件大小從一兩個GB大小到兩三百MB。

本文內容不包括：tomcat

不包括進行Spring Boot配置文件分離相關，通常簡單採用經過指定active profile從外部yaml配置文件覆蓋jar文件中配置便可或是採用Nacos等配置服務模式。
不包括Maven最佳實踐用法，列入樣例工程中出於演示方便的考慮好比把一些本應放到各個Boot模塊特定的配置聲明直接放到頂層的parent中定義，請注意按實際狀況優化調整使用。
不包括可執行jar的運行模式支持參考，文中實現方式主要面向java -jar運行模式。

瘦身打怪升級過程

Level 0：常規的Fat Jar構建
參考項目目錄：package-optimize-level0

主要配置：

<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

最終實現效果