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





























