FatJar减肥: 解决SpringBoot jar包太大的问题

﹏ヽ暗。殇╰゛Y 2022-06-06 02:26 454阅读 0赞

spring boot添加spring-boot-maven-plugin插件后, 打出来的Jar动辄几十上百兆. 这种FatJar包在传输时会相当不便, 尤其是某些外企, 服务器可能在美国, 上传速度可能不到200K, 严重影响工作效率.

本文就说说怎样减少FatJar的大小.

SpringBoot的web应用一般都添加了spring-boot-maven-plugin插件.

Maven xml代码   ![收藏代码][icon_star.png]

1.  <build>  
2.      <plugins>  
3.          <plugin>  
4.              <groupId>org.springframework.boot</groupId>  
5.              <artifactId>spring-boot-maven-plugin</artifactId>  
6.          </plugin>  
7.      </plugins>  
8.  </build>

打出来的jar包内置了所有的依赖jar, 放在BOOT-INF/lib目录, 所以体积很大.

解决步骤:

1. 修改spring-boot-maven-plugin的参数, 使其将内置的jar包exclude掉, 例如:

Xml代码   ![收藏代码][icon_star.png]

1.  <plugin>  
2.     <groupId>org.springframework.boot</groupId>  
3.     <artifactId>spring-boot-maven-plugin</artifactId>  
4.     <version>1.5.1.RELEASE</version>  
5.     <configuration>  
6.        <layout>ZIP</layout>  
7.         <excludes>  
8.             <exclude>  
9.                 <groupId>ch.qos.logback</groupId>  
10.                <artifactId>logback-classic</artifactId>  
11.            </exclude>  
12.            <exclude>  
13.                <groupId>com.google.guava</groupId>  
14.                <artifactId>guava</artifactId>  
15.            </exclude>  
16.        </excludes>  
17.    </configuration>  
18. lt;/plugin>

这样, 打出来的jar中就不会包含被exclude掉的依赖了.注意layout应设置为ZIP,不然后面会出现找不到类的错误.

exclude不止一种写法, 其他的exclude方式参见[http://docs.spring.io/spring-boot/docs/current/maven-plugin/start-mojo.html][http_docs.spring.io_spring-boot_docs_current_maven-plugin_start-mojo.html].

可以通过mvn dependency:tree命令查看当前项目的依赖.

因为依赖的jar已经被排除掉了, FatJar变瘦, 直接运行就会报ClassNotFoundException. 所以还要进行下一步.

可以在公司的parent pom.xml的pluginManagement部分添加spring-boot-maven-plugin的配置, 这样每个web项目就可以继承一套全公司统一的配置.

2. 将上一步exclude掉的jar放到一个外置的目录中. 如:

![20c3f868-de39-3924-b2ed-4b12fc5d0182.png][]

然后执行如下命令启动应用:

Cmd代码   ![收藏代码][icon_star.png]

1.  java -Dloader.path="lib/" -jar common-service.jar

loader.path指向了外置目录,告诉springboot允许从外部加载依赖.

loader.path的更多用法参见:[http://docs.spring.io/spring-boot/docs/current/reference/html/executable-jar.html\#executable-jar-launching][http_docs.spring.io_spring-boot_docs_current_reference_html_executable-jar.html_executable-jar-launching].

可以用mvn dependency:copy-dependencies命令将jar包copy到这个外置目录.

经测试, 经过上面的两个步骤, 笔者的应用从70MB缩小为1.3MB, 极大地缩小了体积.

既缩小了体积, 便于传输, 又很容易地控制依赖jar的版本, 做到全公司统一, 共享同一套依赖集合.

特别地, 如果要讲应用部署到docker中, 需要修改dockerfile, 将依赖目录挂载到docker镜像中, 修改应用的启动命令(可能会是dockerfile的entrypoint),添加loader.path参数, 指向挂载进来的依赖目录. 不建议将依赖ADD到docker镜像, 那样的话docker镜像会很大.

原文地址：[http://rickgong.iteye.com/blog/2368985][http_rickgong.iteye.com_blog_2368985]

[icon_star.png]: /images/20220606/75f7034f37524d9c96ffaf5ef46de0f1.png
[http_docs.spring.io_spring-boot_docs_current_maven-plugin_start-mojo.html]: http://docs.spring.io/spring-boot/docs/current/maven-plugin/start-mojo.html
[20c3f868-de39-3924-b2ed-4b12fc5d0182.png]: /images/20220606/36b28046ed0240f08b5553f37a1ff47d.png
[http_docs.spring.io_spring-boot_docs_current_reference_html_executable-jar.html_executable-jar-launching]: http://docs.spring.io/spring-boot/docs/current/reference/html/executable-jar.html#executable-jar-launching
[http_rickgong.iteye.com_blog_2368985]: http://rickgong.iteye.com/blog/2368985