瘦身Spring Boot应用(thinJar)

爱游泳的老白

已于 2024-04-02 13:51:05 修改

阅读量1.4k

点赞数 15

分类专栏： Java语言 Spring 文章标签： spring boot 后端 java

于 2024-04-02 12:28:23 首次发布

本文链接：https://blog.csdn.net/wjw465150/article/details/137265630

版权

Java语言同时被 2 个专栏收录

23 篇文章 1 订阅

订阅专栏

Spring

12 篇文章 0 订阅

订阅专栏

本文介绍了如何使用SpringBoot的thin-launcher来减少jar包大小，只打包自定义代码，依赖项在运行时自动下载。通过Maven或Gradle配置，实现快速上传和首次运行时的依赖下载。

摘要由CSDN通过智能技术生成

瘦身Spring Boot应用(thinJar)

简介

我们使用Spring Boot提供的spring-boot-maven-plugin打包Spring Boot应用，可以直接获得一个完整的可运行的jar包，把它上传到服务器上再运行就极其方便。

但是这种方式也不是没有缺点。最大的缺点就是包太大了，动不动几十MB，在网速不给力的情况下，上传服务器非常耗时。并且，其中我们引用到的Tomcat、Spring和其他第三方组件，只要版本号不变，这些jar就相当于每次都重复打进去，再重复上传了一遍。

真正经常改动的代码其实是我们自己编写的代码。如果只打包我们自己编写的代码，通常jar包也就几百KB。但是，运行的时候，classpath中没有依赖的jar包，肯定会报错。

所以问题来了：如何只打包我们自己编写的代码，同时又自动把依赖包下载到某处，并自动引入到classpath中。解决方案就是使用spring-boot-thin-launcher。

项目地址: https://github.com/spring-projects-experimental/spring-boot-thin-launcher

使用spring-boot-thin-launcher

我们先演示如何使用spring-boot-thin-launcher，再详细讨论它的工作原理。

修改<build>-<plugins>-<plugin>，给原来的spring-boot-maven-plugin增加一个<dependency>如下：

<project ...>
    ...
    <build>
        <finalName>awesome-app</finalName>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <dependencies>
                    <dependency>
                        <groupId>org.springframework.boot.experimental</groupId>
                        <artifactId>spring-boot-thin-layout</artifactId>
                        <version>1.0.31.RELEASE</version>
                    </dependency>
                </dependencies>
            </plugin>
        </plugins>
    </build>
</project>

不需要任何其他改动了，我们直接按正常的流程打包，执行mvn clean package，观察target目录最终生成的可执行simple-0.0.1-SNAPSHOT.jar，只有79KB左右。

直接运行java -jar simple-0.0.1-SNAPSHOT.jar，显然，79KB的jar肯定无法放下Tomcat和Spring这样的大块头。那么，运行时这个simple-0.0.1-SNAPSHOT.jar又是怎么找到它自己依赖的jar包呢？

实际上spring-boot-thin-launcher这个插件改变了spring-boot-maven-plugin的默认行为。它输出的jar包只包含我们自己代码编译后的class，一个很小的ThinJarWrapper，以及解析pom.xml后得到的所有依赖jar的列表。

运行的时候，入口实际上是ThinJarWrapper，它会先在指定目录搜索看看依赖的jar包是否都存在，如果不存在，先从Maven中央仓库下载到本地，然后，再执行我们自己编写的main()入口方法。这种方式有点类似很多在线安装程序：用户下载后得到的是一个很小的exe安装程序，执行安装程序时，会首先在线下载所需的若干巨大的文件，再进行真正的安装。

这个spring-boot-thin-launcher在启动时搜索的默认目录是用户主目录的.m2，我们也可以指定下载目录，例如，将下载目录指定为当前目录：

$ java -Dthin.root=. -jar simple-0.0.1-SNAPSHOT.jar

上述命令通过环境变量thin.root传入当前目录，执行后发现当前目录下自动生成了一个repository目录，这和Maven的默认下载目录~/.m2/repository的结构是完全一样的，只是它仅包含simple-0.0.1-SNAPSHOT.jar所需的运行期依赖项。

注意：只有首次运行时会自动下载依赖项，再次运行时由于无需下载，所以启动速度会大大加快。如果删除了repository目录，再次运行时就会再次触发下载。

预热

把79KB大小的simple-0.0.1-SNAPSHOT.jar直接扔到服务器执行，上传过程就非常快。但是，第一次在服务器上运行simple-0.0.1-SNAPSHOT.jar时，仍需要从Maven中央仓库下载大量的jar包，所以，spring-boot-thin-launcher还提供了一个dryrun选项，专门用来下载依赖项而不执行实际代码：

java -Dthin.trace=true -Dthin.force=true -Dthin.dryrun=true -Dthin.root=. -jar simple-0.0.1-SNAPSHOT.jar

执行上述代码会在当前目录创建repository目录，并下载所有依赖项，但并不会运行我们编写的main()方法。此过程称之为“预热”（warm up）。

如果服务器由于安全限制不允许从外网下载文件，那么可以在本地预热，然后把simple-0.0.1-SNAPSHOT.jar和repository目录上传到服务器。只要依赖项没有变化，后续改动只需要上传simple-0.0.1-SNAPSHOT.jar即可。

Gradle方式

配置 `build.gradle`

在 Gradle 中，您需要添加 thin-launcher 插件和（最好）具有显式发布定义的 maven-publish 插件。

plugins {
    ...
    id 'maven-publish'
    id 'org.springframework.boot.experimental.thin-launcher' version '1.0.31.RELEASE'
}

...

repositories {
    mavenLocal()
    mavenCentral()
    maven { url "https://repo.spring.io/snapshot" }
    maven { url "https://repo.spring.io/milestone" }
}

...

publishing {
    publications {
        maven(MavenPublication) {
            from components.java
        }
    }
}

使用 Gradle 打 thin 包

Gradle 执行 thinJar 任务:

./gradlew thinJar

使用 Gradle 打 thin 包并下载所有依赖项

如果我们将 Gradle 与 Thin-Launcher 插件一起使用，则我们有一个 ThinResolve 任务可用。该任务会将应用程序及其依赖项保存在 build/thin/root/ 目录中，类似于上一节的 Maven 插件：

gradlew thinResolve
cd build/thin/deploy
$ java -Dthin.root=. -jar simple-0.0.1-SNAPSHOT.jar

命令行选项

您可以在命令行或系统属性 ( -D... ) 上设置各种选项。 thin.* 属性在调用主类之前全部从命令行中删除，因此主类不必知道它是如何启动的。

Option 选项	Default 默认	Description 描述
`thin.main`	Start-Class in MANIFEST.MF MANIFEST.MF 中的启动类	要启动的主类（对于 Spring Boot 应用程序，通常是带有 `@SpringBootApplication` 的类）
`thin.dryrun`	false	仅解决并下载依赖项。不要运行任何主类。注意：除“false”（甚至为空）之外的任何值都是 true。
`thin.offline`	false	切换到“离线”模式。所有依赖项必须在本地可用（例如通过之前的试运行），否则将会出现异常。
`thin.force`	false	强制进行依赖项解析，即使依赖项已被计算并在 `thin.properties` 中标记为“已计算”。
`thin.classpath`	false	只打印类路径。不要运行主类。支持两种格式：“路径”和“属性”。为了向后兼容，“true”或空相当于“path”。
`thin.root`	`${user.home}/.m2`	本地 jar 缓存的位置，布置为 Maven 存储库。如果不存在，启动器会在此处创建一个名为“repository”的新目录。
`thin.libs`	`<empty>`	在运行时附加的其他类路径条目的形式与您在 `java -classpath ...` 中使用的形式相同。如果定义了此属性，则在计算类路径时将忽略未解析的依赖项，可能会导致运行时类未找到异常。
`thin.archive`	the same as the target archive	要启动的存档。例如，可用于启动使用不同版本的瘦启动器构建的 JAR 文件，或由 Spring Boot 在不使用瘦启动器的情况下构建的胖 jar 文件。
`thin.parent`	`<empty>`	用于依赖关系管理和公共类路径条目的父存档。如果您运行具有相同父级的两个应用程序，它们将具有相同的类路径，从左到右读取，直到它们实际上不同。
`thin.location`	`file:.,classpath:/`	包含精简属性文件的目录路径（按照 `thin.name` ），作为资源位置（目录）的逗号分隔列表。将搜索这些位置以及相对于 /META-INF 的相同路径。
`thin.name`	“thin”	用于搜索依赖项规范和覆盖的属性文件的名称。
`thin.profile`		用于查找精简属性的以逗号分隔的配置文件列表。例如。如果 `thin.profile=foo` 启动器搜索名为 `thin.properties` 和 `thin-foo.properties` 的文件。
`thin.library`	`org.springframework.boot.experimental:spring-boot-thin-launcher:1.0.31.RELEASE`	启动器库的定位器。可以是 Maven 坐标（带有可选的 `maven://` 前缀），也可以是文件（带有可选的 `file://` 前缀）。
`thin.repo`	`https://repo.spring.io/snapshot` (also contains GA releases)	`thin.library` 的基本 URL（如果它是 Maven 形式）（默认）。
`thin.launcher`	`org.springframework.boot.thin.ThinJarLauncher`	`thin.library` 中的主类。如果未指定，则从清单 `Main-Class` 属性中发现。
`thin.parent.first`	true	表示类加载器是“父级优先”的标志（即系统类加载器将用作默认值）。这是“标准”JDK 类加载器策略。将其设置为 false 类似于 Web 容器和应用程序服务器中通常使用的设置。
`thin.parent.boot`	true	标志表明父类加载器应该是引导类加载器而不是“系统”类加载器。引导加载程序通常包含 JDK 类，但不包含目标存档，也不包含在命令行上添加的任何代理 jar。
`thin.debug`	false	`(like in Spring Boot).<br>标记以在依赖关系解析期间打开一些稍微详细的日志记录。也可以使用` debug` 打开（就像在 Spring Boot 中一样）。
`thin.trace`	false	超级详细地记录依赖项解析和启动过程中的所有活动。也可以使用 `trace` 打开。