spring boot 分层构建镜像

勇敢并不是一个人手中拿着枪,而是在你动手之前你已经知道自己会输,但依然会动手,而且无论如何会坚持到底 —— 哈珀·李《杀死一只知更鸟》

一、概述

spring boot 2.3 开始spring-boot-maven-plugin 插件默认开启了分层构建 jar包 或者 war包,本文主要根据官方文档记录一下如何使用分层jar构建镜像。

二、spring-boot-maven-plugin 分层构建 jar 包

配置 spring boot 项目继承自 spring-boot-starter-parent,设置 <parent> 如下:

<!-- Inherit defaults from Spring Boot -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.5.1</version>
</parent>

继承自 spring-boot-starter-parent 的项目有如下的默认配置:

  • 默认编译jdk:JDK 1.8
  • 默认编码:UTF-8
  • 默认依赖项管理部分继承自 spring-boot-dependencies POM,管理公共依赖项的版本,这种依赖管理允许您在自己的 POM 中使用时省略那些依赖项的<version>标记
  • 默认配置的 excution goal为:repackage

当在项目中引入 spring-boot-maven-plugin 插件默认就开启了分层构建 jar包,我们可以使用如下方式进行验证:

  • 在项目的 pom.xml 文件中添加如下插件配置:
<project>
    <modelVersion>4.0.0</modelVersion>
    <artifactId>getting-started</artifactId>
    <!-- ... -->
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>
</project>

  • 执行如下命令进行打包:
mvn clean package 

在 target 目录下面生成对应的 jar 包,解压 jar 包目录结构如下:

image.png

jar 分别在 BOOT-INF/classesBOOT-INF/lib 中包含应用程序的类和依赖项。 类似地,可执行 war 包含 WEB-INF/classes 中的应用程序类和 WEB-INF/libWEB-INF/lib-provided 中的依赖项。 对于需要从 jar 或 war 的内容构建 docker 镜像的情况,需要分离这些目录以便将它们写入不同的层。

其中的 BOOT-INF/layers.idx 文件就是用来定义分层 jar 的构建顺序的,层的顺序很重要,因为它决定了在应用程序的一部分发生更改时,尽可能将发生更改的内容放在后面,应该先添加最不可能更改的内容,然后再添加最可能更改的层,默认顺序是:

  • dependencies(用于存放不包含 snapshot 的依赖)
  • spring-boot-loader(用于存放类加载器)
  • snapshot-dependencies(用于存放包含 snapshot 的依赖)
  • application(用于存放应用程序的类和资源)
image.png

此分层旨在根据应用程序构建之间更改的可能性来分离代码,项目的依赖不太可能在内部版本之间经常更改,因此将其放置在单独的层dependencies中,以允许工具重新使用缓存中的层,应用程序代码更可能在内部版本之间进行更改,因此将其隔离在单独的层application中。

使用下面的命令查看分层jar 的目录顺序:

java -Djarmode=layertools -jar probedemo-0.0.1-SNAPSHOT.jar list

dependencies
spring-boot-loader
snapshot-dependencies
application

使用下面的命令将jar包按照分层的目录结构进行解压以便创建分层镜像:

java -Djarmode=layertools -jar probedemo-0.0.1-SNAPSHOT.jar extract

关于 java -Djarmode=layertools -jar application.jar 官方的说明如下:

Usage:
  java -Djarmode=layertools -jar probedemo-0.0.1-SNAPSHOT.jar

Available commands:
  list     List layers from the jar that can be extracted
  extract  Extracts layers from the jar for image creation
  help     Help about any command

要禁用此特性,可以采用以下方式


<project>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
                <configuration>
                    <layers>
                        <enabled>false</enabled>
                    </layers>
                </configuration>
            </plugin>
        </plugins>
    </build>
</project>

三、多阶段构建 docker 镜像

知道了上面分层 jar 包的构建目录之后,我们可以使用多阶段来构建 docker 镜像,Dockerfile 的内容如下:

# 指定基础镜像,这是多阶段构建的前期阶段
FROM openjdk:11-jre-slim as builder
# 指定工作目录,目录不存在会自动创建
WORKDIR /app
# 将生成的 jar 复制到容器镜像中
COPY target/*.jar application.jar
# 通过工具spring-boot-jarmode-layertools从application.jar中提取拆分后的构建结果
RUN java -Djarmode=layertools -jar application.jar extract

# 正式构建镜像
FROM openjdk:11-jre-slim
# 指定工作目录,目录不存在会自动创建
WORKDIR /app
# 前一阶段从jar中提取除了多个文件,这里分别执行COPY命令复制到镜像空间中,每次COPY都是一个layer
COPY --from=builder app/dependencies ./
COPY --from=builder app/spring-boot-loader ./
COPY --from=builder app/snapshot-dependencies ./
COPY --from=builder app/application ./
# 指定时区
ENV TZ="Asia/Shanghai"
RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone
# 定义一些环境变量,方便环境变量传参
ENV JVM_OPTS=""
ENV JAVA_OPTS=""
# 指定暴露的端口,起到说明的作用,不指定也会暴露对应端口
EXPOSE 8080
# 启动 jar 的命令
ENTRYPOINT ["sh","-c","java $JVM_OPTS $JAVA_OPTS org.springframework.boot.loader.JarLauncher"]

使用下面的命令构建 docker 镜像:

docker build -t demo:1.0.0 . 

使用如下命令查看镜像的分层信息:

docker history demo:1.0.0
image.png

如上图,整个 jar 的内容,例如 class、依赖库、依赖资源等,分多次 COPY 到镜像空间中,所以以后如果只改了class,在更新镜像的时候,只需要下载 class 的 layer 即可(其他 layer 可以直接用之前缓存到本地的)。

image.png

参考文章:

https://docs.spring.io/spring-boot/docs/2.5.1/maven-plugin/reference/htmlsingle/#packaging.layers

https://blog.csdn.net/boling_cavalry/article/details/106598189

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,657评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,662评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,143评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,732评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,837评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,036评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,126评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,868评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,315评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,641评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,773评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,859评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,584评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,676评论 2 351

推荐阅读更多精彩内容