從零到一:使用 Dockerfile 構(gòu)建并部署 Spring Boot 應(yīng)用
在以往的實(shí)踐中,我們常常直接使用官方或第三方構(gòu)建的鏡像。然而,在真實(shí)的開(kāi)發(fā)流程中,將自研應(yīng)用打包成標(biāo)準(zhǔn)、可移植的鏡像是至關(guān)重要的一環(huán),它能確保開(kāi)發(fā)、測(cè)試與生產(chǎn)環(huán)境的絕對(duì)一致性。
本文將詳細(xì)闡述如何通過(guò)編寫 Dockerfile文件,將一個(gè)標(biāo)準(zhǔn)的 Spring Boot 應(yīng)用打包成一個(gè)獨(dú)立的 Docker 鏡像。我們將從一個(gè)簡(jiǎn)單的后端項(xiàng)目入手,逐步構(gòu)建并優(yōu)化 Dockerfile,最終得出一個(gè)生產(chǎn)級(jí)的解決方案。
一、項(xiàng)目準(zhǔn)備
本文將以一個(gè)標(biāo)準(zhǔn)的 Spring Boot 項(xiàng)目為例,該項(xiàng)目打包后的產(chǎn)物是一個(gè) .jar文件。項(xiàng)目功能非常簡(jiǎn)單:提供一個(gè) REST API,用于返回其加載的 application.properties配置文件的內(nèi)容。
(一)環(huán)境隔離的配置文件
在 Spring Boot 項(xiàng)目的 src/main/resources目錄下,我們通常會(huì)定義 application.properties文件,用于存放數(shù)據(jù)庫(kù)連接、外部服務(wù)地址等配置信息。
src/main/resources/application.properties(默認(rèn)配置):
spring.datasource.username=local
spring.mail.username=local@gmail.com
logging.file.path=./log為了應(yīng)對(duì)不同環(huán)境(如開(kāi)發(fā)、測(cè)試、生產(chǎn))的部署需求,我們需要為每個(gè)環(huán)境創(chuàng)建獨(dú)立的配置文件。為此,在項(xiàng)目根目錄下創(chuàng)建一個(gè) env-config文件夾,并按環(huán)境創(chuàng)建子目錄。
項(xiàng)目結(jié)構(gòu)如下:
.
├── env-config
│ ├── dev
│ │ └── application.properties
│ ├── test
│ │ └── application.properties
│ └── prod
│ └── application.properties
└── src
└── main
└── resources
└── application.propertiesenv-config/dev/application.properties(開(kāi)發(fā)環(huán)境):
spring.datasource.username=dev
spring.mail.username=dev@gmail.com
logging.file.path=./logenv-config/prod/application.properties(生產(chǎn)環(huán)境):
spring.datasource.username=prod
spring.mail.username=prod@gmail.com
logging.file.path=./log(測(cè)試環(huán)境配置在此省略,與上同理)
(二)功能接口實(shí)現(xiàn)
為了驗(yàn)證配置是否生效,我們創(chuàng)建一個(gè) Controller,它會(huì)讀取配置值并通過(guò) API 返回。同時(shí),它會(huì)向指定路徑寫入日志。
@RestController
publicclass MyController {
privatestaticfinal Logger logger = LoggerFactory.getLogger(MyController.class);
@Value("${spring.datasource.username}")
private String dbUser;
@Value("${spring.mail.username}")
private String mailUser;
@Value("${logging.file.path}")
private String logPath;
@GetMapping("/configs")
public Map<String, String> getConfigs() {
logger.info("Configuration API was called at {}", LocalTime.now());
return Map.of(
"dbUser", dbUser,
"mailUser", mailUser,
"logPath", logPath
);
}
}(三)應(yīng)用打包
我們使用 Maven 作為構(gòu)建工具。執(zhí)行以下命令,將項(xiàng)目打包成 JAR 文件。
mvn clean package命令執(zhí)行成功后,會(huì)在 target目錄下生成 JAR 文件。為了方便后續(xù)操作,我們將其重命名為 backend-app.jar。
此時(shí),項(xiàng)目結(jié)構(gòu)的關(guān)鍵部分如下:
.
├── env-config
├── src
└── target
└── backend-app.jar(四)容器內(nèi)啟動(dòng)策略
在將應(yīng)用容器化之前,必須規(guī)劃好文件在容器內(nèi)部的布局和應(yīng)用的啟動(dòng)方式。
我們規(guī)劃的容器內(nèi)文件結(jié)構(gòu)如下:
/app
├── backend-app.jar
├── config
│ └── application.properties
└── log為了讓 Spring Boot 加載外部的 config/目錄下的配置文件,我們采用以下啟動(dòng)命令:
java -jar -Dspring.config.location=config/ backend-app.jar --spring.config.name=application-Dspring.config.location: 指定外部配置文件的搜索路徑。--spring.config.name: 指定要加載的配置文件名稱(默認(rèn)為application)。
二、編寫基礎(chǔ) Dockerfile
在項(xiàng)目根目錄下創(chuàng)建一個(gè)名為 Dockerfile的文件(無(wú)任何擴(kuò)展名)。該文件包含一系列指令,用于定義鏡像的構(gòu)建過(guò)程。
(一)FROM:指定基礎(chǔ)鏡像
每個(gè) Docker 鏡像都必須基于一個(gè)父鏡像。FROM指令用于聲明這個(gè)基礎(chǔ)。我們的 Spring Boot 3 應(yīng)用需要 Java 17 的運(yùn)行時(shí)環(huán)境,因此選擇官方的 openjdk鏡像。
# 使用 Oracle Linux 8 作為底層系統(tǒng),并預(yù)裝了 OpenJDK 17
FROM openjdk:17-oracle這里的 openjdk:17-oracle鏡像自身也是通過(guò) Dockerfile 構(gòu)建的,其基礎(chǔ)鏡像是 oraclelinux:8-slim。因此,我們可以認(rèn)為當(dāng)前的環(huán)境是一個(gè)預(yù)裝了 Java 17 的精簡(jiǎn)版 Linux 系統(tǒng)。
(二)COPY:復(fù)制文件到鏡像
COPY指令用于將主機(jī)(構(gòu)建環(huán)境)的文件或目錄復(fù)制到鏡像的文件系統(tǒng)中。其語(yǔ)法為 COPY <源路徑>... <目標(biāo)路徑>。
為了保持容器內(nèi)部的整潔,我們將所有應(yīng)用相關(guān)文件都存放在 /app目錄下。
# 將構(gòu)建產(chǎn)物 JAR 文件復(fù)制到容器的 /app/ 目錄下
COPY ./target/backend-app.jar /app/
# 將生產(chǎn)環(huán)境的配置文件復(fù)制到容器的 /app/config/ 目錄下
COPY ./env-config/prod /app/config/注意:如果目標(biāo)路徑在容器中不存在,Docker 會(huì)自動(dòng)創(chuàng)建它。
(三)EXPOSE:聲明服務(wù)端口
EXPOSE指令用于聲明容器在運(yùn)行時(shí)監(jiān)聽(tīng)的網(wǎng)絡(luò)端口。這本身不會(huì)發(fā)布端口,但它有兩個(gè)重要作用:
- 作為一種文檔,告知使用者該容器的哪個(gè)端口提供服務(wù)。
- 在使用
docker run -P(大寫P) 時(shí),Docker 會(huì)自動(dòng)將此聲明的端口映射到主機(jī)的隨機(jī)端口。
Spring Boot 的默認(rèn)端口是 8080。
# 聲明容器將監(jiān)聽(tīng) 8080 端口
EXPOSE 8080(四)WORKDIR:設(shè)置工作目錄
WORKDIR指令用于設(shè)置后續(xù) RUN、CMD、ENTRYPOINT指令的執(zhí)行目錄,類似于在 shell 中執(zhí)行 cd命令。
為了確保我們的啟動(dòng)命令能在正確的路徑下執(zhí)行,我們將工作目錄切換到存放 JAR 文件的 /app。
# 設(shè)置工作目錄為 /app
WORKDIR /app(五)CMD:定義容器啟動(dòng)命令
CMD指令用于指定容器啟動(dòng)時(shí)要執(zhí)行的默認(rèn)命令。這通常是應(yīng)用的啟動(dòng)命令。
根據(jù)我們之前規(guī)劃的啟動(dòng)策略,CMD指令應(yīng)如下設(shè)置:
# 定義容器啟動(dòng)時(shí)執(zhí)行的命令
CMD ["java", "-Dspring.config.location=config/", "-jar", "backend-app.jar", "--spring.config.name=application"]核心概念:一個(gè)
Dockerfile中可以有多個(gè)CMD指令,但只有最后一個(gè)會(huì)生效。如果需要執(zhí)行復(fù)雜的啟動(dòng)腳本,建議編寫一個(gè) shell 腳本,COPY進(jìn)鏡像后由CMD調(diào)用。
三、構(gòu)建并驗(yàn)證鏡像
至此,我們已經(jīng)完成了一個(gè)基礎(chǔ)的 Dockerfile。
Dockerfile(基礎(chǔ)版):
FROM openjdk:17-oracle
COPY ["./target/backend-app.jar", "/app/"]
COPY ["./env-config/prod", "/app/config/"]
EXPOSE 8080
WORKDIR /app
CMD ["java", "-Dspring.config.location=config/", "-jar", "backend-app.jar", "--spring.config.name=application"]使用 docker image build命令來(lái)構(gòu)建鏡像:
# -t 指定鏡像名稱和標(biāo)簽, `.` 表示 Dockerfile 在當(dāng)前目錄
docker image build -t spring-demo:1.0.0 .構(gòu)建成功后,即可運(yùn)行容器進(jìn)行驗(yàn)證。
四、Dockerfile 進(jìn)階指令與優(yōu)化
基礎(chǔ)版 Dockerfile已經(jīng)可以工作,但為了提高可維護(hù)性、靈活性和健壯性,我們可以引入更多高級(jí)指令。
(一)ENV:設(shè)置環(huán)境變量
ENV指令用于在鏡像中定義環(huán)境變量。它不僅能被容器內(nèi)運(yùn)行的應(yīng)用訪問(wèn),還可以在 Dockerfile的后續(xù)指令中作為變量使用。這對(duì)于統(tǒng)一管理路徑、版本號(hào)等常量非常有用。
例如,/app這個(gè)路徑在我們的文件中出現(xiàn)了多次,可以將其提取為變量:
ENV APP_DIR=/app
COPY ["./target/backend-app.jar", "${APP_DIR}/"]
COPY ["./env-config/prod", "${APP_DIR}/config/"]
WORKDIR ${APP_DIR}(二)ARG:定義構(gòu)建時(shí)參數(shù)
ARG指令用于定義在 docker image build時(shí)才能傳遞的參數(shù)。這使得我們的 Dockerfile更加靈活,無(wú)需為不同環(huán)境(如 dev, test, prod)創(chuàng)建不同的 Dockerfile。
我們可以將環(huán)境名稱參數(shù)化:
ARG SERVER_TYPE=prod # 設(shè)置默認(rèn)值為 prod
# ...
COPY ["./env-config/${SERVER_TYPE}", "${APP_DIR}/config/"]在構(gòu)建時(shí),通過(guò) --build-arg標(biāo)志傳入具體的值:
# 構(gòu)建一個(gè)使用 dev 配置的鏡像
docker image build -t spring-demo:dev --build-arg SERVER_TYPE=dev .
# 構(gòu)建一個(gè)使用 prod 配置的鏡像 (不傳則使用默認(rèn)值)
docker image build -t spring-demo:prod --build-arg SERVER_TYPE=prod .
ARG與ENV的區(qū)別:ARG是構(gòu)建時(shí)變量,僅在Dockerfile構(gòu)建過(guò)程中有效,容器運(yùn)行時(shí)不可見(jiàn)。ENV是環(huán)境時(shí)變量,在容器的整個(gè)生命周期中都存在。
(三)VOLUME:定義數(shù)據(jù)卷
日志、用戶上傳的文件等動(dòng)態(tài)數(shù)據(jù)不應(yīng)存儲(chǔ)在容器的可寫層,否則會(huì)隨著容器的刪除而丟失。VOLUME指令用于在鏡像中創(chuàng)建一個(gè)掛載點(diǎn),用于持久化數(shù)據(jù)。
# 將 /app/log 目錄聲明為數(shù)據(jù)卷
VOLUME ${APP_DIR}/log這會(huì)在容器啟動(dòng)時(shí),自動(dòng)為 /app/log目錄創(chuàng)建一個(gè)匿名卷。你也可以在 docker run時(shí)通過(guò) -v參數(shù)將其映射到主機(jī)目錄或命名卷,從而實(shí)現(xiàn)數(shù)據(jù)的持久化管理。
(四)RUN:執(zhí)行構(gòu)建時(shí)命令
RUN指令用于在鏡像構(gòu)建過(guò)程中執(zhí)行命令,例如安裝依賴、創(chuàng)建目錄、解壓文件等。RUN的每一次執(zhí)行都會(huì)在當(dāng)前鏡像層之上創(chuàng)建一個(gè)新的層。
雖然 Spring Boot 會(huì)在寫入日志時(shí)自動(dòng)創(chuàng)建目錄,但我們也可以通過(guò) RUN命令顯式創(chuàng)建,以確保目錄存在。
# 使用 -p 選項(xiàng)可以確保父目錄存在且不會(huì)因目錄已存在而報(bào)錯(cuò)
RUN mkdir -p ${APP_DIR}/log(五)LABEL:添加元數(shù)據(jù)
LABEL指令用于為鏡像添加元數(shù)據(jù),如作者、描述、版本等。這有助于更好地組織和管理鏡像。
LABEL description="A demo Spring Boot application." \
maintainer="your-email@example.com" \
version="1.0.0"這些信息可以通過(guò) docker image inspect命令查看。
(六)HEALTHCHECK:容器健康檢查
有時(shí)容器雖然在運(yùn)行 (running狀態(tài)),但內(nèi)部的應(yīng)用可能已經(jīng)僵死或無(wú)法正常響應(yīng)。HEALTHCHECK指令允許 Docker 定期檢查容器的健康狀態(tài)。
HEALTHCHECK --start-period=60s --interval=180s --timeout=10s --retries=3 \
CMD curl -fs http://localhost:8080/configs || exit 1--start-period=60s: 容器啟動(dòng)后,等待 60 秒再開(kāi)始第一次健康檢查,給應(yīng)用足夠的時(shí)間啟動(dòng)。--interval=180s: 每隔 180 秒檢查一次。--timeout=10s: 檢查命令的超時(shí)時(shí)間為 10 秒。--retries=3: 如果檢查失敗,重試 3 次。CMD: 實(shí)際執(zhí)行的檢查命令。這里我們通過(guò)curl訪問(wèn)一個(gè)健康檢查接口。|| exit 1表示如果curl命令失?。ǚ祷胤?0 退出碼),則整個(gè)HEALTHCHECK命令返回1,標(biāo)記容器為unhealthy。
執(zhí)行 docker ps時(shí),健康狀態(tài)會(huì)顯示在 STATUS列中(例如 Up 5 minutes (healthy))。這對(duì)于 Docker Swarm 或 Kubernetes 等容器編排工具實(shí)現(xiàn)自動(dòng)故障恢復(fù)至關(guān)重要。
五、總結(jié)與最終版 Dockerfile
本文通過(guò)一個(gè) Spring Boot 項(xiàng)目,系統(tǒng)性地介紹了如何從零開(kāi)始編寫一個(gè) Dockerfile,并利用 ENV, ARG, VOLUME, HEALTHCHECK等指令逐步優(yōu)化,使其更具靈活性和生產(chǎn)適用性。
通過(guò) Dockerfile,我們將應(yīng)用的環(huán)境、依賴和配置代碼化,實(shí)現(xiàn)了構(gòu)建過(guò)程的標(biāo)準(zhǔn)化和自動(dòng)化,這是現(xiàn)代軟件工程與 DevOps 實(shí)踐中不可或缺的一環(huán)。
最終版 Dockerfile:
# 1. 基礎(chǔ)鏡像:使用官方 OpenJDK 17 鏡像
FROM openjdk:17-oracle
# 2. 元數(shù)據(jù):為鏡像添加描述和維護(hù)者信息
LABEL description="A demo Spring Boot application." \
maintainer="your-email@example.com"
# 3. 構(gòu)建參數(shù)與環(huán)境變量:用于靈活配置和路徑管理
ARG SERVER_TYPE=prod
ENV APP_DIR=/app
# 4. 創(chuàng)建應(yīng)用目錄和日志目錄
RUN mkdir -p ${APP_DIR}/log
# 5. 設(shè)置工作目錄
WORKDIR ${APP_DIR}
# 6. 復(fù)制應(yīng)用和配置文件到鏡像中
COPY target/backend-app.jar .
COPY env-config/${SERVER_TYPE}/ ./config/
# 7. 聲明數(shù)據(jù)卷,用于持久化日志
VOLUME ${APP_DIR}/log
# 8. 聲明端口
EXPOSE8080
# 9. 健康檢查
HEALTHCHECK --start-period=60s --interval=180s --timeout=10s --retries=3 \
CMD curl -fs http://localhost:8080/configs || exit 1
# 10. 容器啟動(dòng)命令
CMD ["java", "-Dspring.config.location=config/", "-jar", "backend-app.jar", "--spring.config.name=applicatio





























