SpringBoot瘦身打包部署

我不是女神ヾ 2023-09-30 15:44 21阅读 0赞

**一、前言**

最近做的项目由于引入第三方库导致在运行mvn clean package 打jar时，编译出来的 Jar 包很大（服务器多达500MB）。

**二、瘦身前的Jar包**

SpringBoot编译出来的Jar包中，磁盘占用大的，是一些外部依赖库（jar包），例如：

进入项目工程根目录，执行 mvn clean package命令，得到的Jar包目录结构如下：

![img][]

整个Jar包 524 MB(可以通过解压软件查看，会发现基本都是lib下的依赖包占用)

![img][img 1]

**三、解决方法**

步骤1: 正常编译JAR包，解压出lib文件夹

POM文件如下：

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

进入项目根目录，执行命令： mvn clean package

将编译后的Jar包解压，拷贝 BOOT-INF 目录下的lib文件夹 到目标路径；

步骤2: 修改pom.xml配置，编译出不带 lib 文件夹的Jar包

<build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <layout>ZIP</layout>
                    <includes>
                        <include>
                            <groupId>nothing</groupId>
                            <artifactId>nothing</artifactId>
                        </include>
                    </includes>
                </configuration>
                <executions>
                    <execution>
                        <goals>
                            <goal>repackage</goal>
                        </goals>
                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

配置完成后，再次执行编译：mvn clean package

生成的 Jar 包体积明显变小(还有175KB)，如下所示， 外部的 jar 包已经不会被引入了：

![img][img 2]

![img][img 3]

步骤3: 运行编译后的Jar包

将 步骤1 解压出来的lib文件夹、步骤2编译的jar包放在同一个目录, 运行下面命令：

java -Dloader.path=/path/to/lib -jar /path/to/springboot-jsp-0.0.1-SNAPSHOT.jar

备注：

将/path/to/改成实际的路径。  
\-Dloader.path=lib文件夹路径  
最终目录文件结构是：

├── lib \#lib文件夹

└── springboot-jsp-0.0.1-SNAPSHOT.jar

说明

1、通常，一个工程项目架构确定后，引入的jar包基本上不会变，改变的大部分是业务逻辑；

2、后面如果需要变更业务逻辑，只需要轻量地编译工程，大大提高项目部署的效率。

**四、特殊处理**

1、以上步骤打包去除所有依赖包，如果想引入内部编译的依赖包可以通过includes属性进行添加，利用引用了内部的dubbo可以通过如下配置

![img][img 4]

配置完成后，再次执行编译：mvn clean package

结构如下：

![img][img 5]

2、如果引入内部包过多，也可以通过excludeGroupIds属性去掉不变的依赖包。

![img][img 6]

为什么瘦身打包：Spring Boot把整个项目打包成一个可运行的Jar包（即所谓的Fat Jar），导致了这个Jar包很大（通常有40M+）。如今迭代发布时常有的事情，每次都上传一个如此庞大的文件，会浪费很多时间  
瘦身打包好处：springboot瘦身打包就是把工程依赖jar提取到外部进行引用，这样每次上传到服务器的文件只有十几KB

springboot瘦身打包步骤：

(1)首先备份原先的依赖（在项目的pom.xml同级目录执行命令）：mvn dependency:copy-dependencies -DoutputDirectory=lib（在每个微服务下生成lib文件夹）  
(2)在pom.xml中去除依赖，然后执行mvn clean package -Dmaven.test.skip=true生成jar包  
(3)删除jar包中lib下的依赖jar（避免引用重复）  
(4)启动jar包：java -Dloader.path=“…/lib/” -jar ErurekaService-0.0.1-SNAPSHOT-exec.jar

--------------------

### 正常打包部署的方式 ###

打包完jar包很大，每次上传jar包到服务器的时候都要很久。为什么呢？也许我们只是创建了一个最基本的SpirngBoot项目，也许我们只是写了三四行代码，最后生成的jar包大小也大的离谱，足足有17M，原因在于生成的可执行jar不仅包含编译之后的类，**还包含了程序运行所依赖的jar包**，而这大部分占比就是这些jar包。

我们通过压缩软件查看生成jar包中的内容：

slimming.jar # 17M
      - BOOT-INF
        - classes # 存放编译后的class文件 
        - lib # 运行需要的依赖  
        - classpath.idx
     - META-INF # 存放应用相关的辕信息，如MANIFEST.MF
     - org #存放Springboot相关的class文件

我们可以明显看到，导致jar包体积那么大的罪魁祸首就是这个lib，且往往我们很少改动这些依赖，频繁改动的往往是一些代码中的逻辑，因此，瘦身的思路就在于：将lib从jar中抽离出来，只需上传一次lib，其他部分的体积就微不足道了，就能够实现秒传。

### 瘦身部署 ###

#### 拿到lib目录 ####

按照原先的maven配置方式，在target目录下生成jar。

<build>
           <finalName>slimming</finalName>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                </plugin>
            </plugins>
        </build>

$ mvn clean package

拿到BOOT-INF/lib目录。

#### 改变默认的打包方式 ####

<build>
           <finalName>slimming</finalName>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <configuration>
                        
                        <mainClass>com.hyh.SpringBootSlimmingApplication</mainClass>
                        
                        <layout>ZIP</layout>
                        <includes>
                            
                            <include>
                                <groupId>nothing</groupId>
                                <artifactId>nothing</artifactId>
                            </include>
                        </includes>
                    </configuration>
                    <executions>
                        <execution>
                            <goals>
                                
                                <goal>repackage</goal>
                            </goals>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>

#### 再次打包 ####

$ mvn clean package

此时，`/target`目录下的slimming.jar已经从18000K变成121K。

#### 上传lib和jar ####

- lib
    - slimming.jar

$ nohup java -Dloader.path=./lib -jar slimming.jar $

*  Dloader.path：告知项目运行依赖的jar包在哪。

[img]: https://img-blog.csdnimg.cn/20190524185845974.png
[img 1]: https://img-blog.csdnimg.cn/20190524184247616.png
[img 2]: https://img-blog.csdnimg.cn/20190524190022545.png
[img 3]: https://img-blog.csdnimg.cn/20190524184635715.png
[img 4]: https://img-blog.csdnimg.cn/20190524185419234.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNTk3MTU0Nw==,size_16,color_FFFFFF,t_70
[img 5]: https://img-blog.csdnimg.cn/20190524185627713.png
[img 6]: https://img-blog.csdnimg.cn/20190524190134728.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl8zNTk3MTU0Nw==,size_16,color_FFFFFF,t_70