如何在Dockerfile中添加DB migration并在构建镜像时先执行迁移再启动应用

核心前提 #

要在构建阶段执行数据库迁移，必须保证Docker构建环境能访问目标数据库（比如数据库处于同一私有网络、公网可访问）。如果构建环境无法连接数据库，建议改为容器启动时执行迁移（下文会给出替代方案）。

方案1：构建阶段执行迁移（以Flyway为例，Java应用） #

1. 准备迁移资源 #

• 在项目src/main/resources/db/migration目录下放置Flyway格式的迁移脚本（如V1__initial_schema.sql）
• 创建flyway.conf配置文件，填写数据库连接信息

2. 编写Dockerfile #

# 构建阶段：执行迁移+打包应用
FROM openjdk:17-jdk-slim AS builder

WORKDIR /app

# 复制迁移脚本和配置
COPY src/main/resources/db/migration/ ./db/migration/
COPY flyway.conf ./

# 安装Flyway
RUN apt-get update && apt-get install -y wget unzip \
    && wget https://repo1.maven.org/maven2/org/flywaydb/flyway-commandline/9.22.3/flyway-commandline-9.22.3-linux-x64.zip \
    && unzip flyway-commandline-9.22.3-linux-x64.zip \
    && mv flyway-9.22.3 /opt/flyway \
    && rm flyway-commandline-9.22.3-linux-x64.zip

# 执行数据库迁移（构建阶段完成）
ENV FLYWAY_CONFIG_FILE=/app/flyway.conf
RUN /opt/flyway/flyway migrate

# 打包应用
COPY . .
RUN ./mvnw clean package -DskipTests

# 最终运行镜像
FROM openjdk:17-jdk-slim
WORKDIR /app
COPY --from=builder /app/target/your-app.jar ./
CMD ["java", "-jar", "your-app.jar"]

3. Flyway配置示例（flyway.conf） #

flyway.url=jdbc:postgresql://your-db-host:5432/your-db-name
flyway.user=db-username
flyway.password=db-password
flyway.locations=filesystem:/app/db/migration

方案2：自定义迁移脚本（Python+PostgreSQL示例） #

如果用自定义SQL脚本和psql客户端：

FROM python:3.11-slim AS builder

WORKDIR /app

# 安装psql客户端
RUN apt-get update && apt-get install -y postgresql-client

# 复制迁移脚本
COPY migration/ ./migration/

# 执行迁移（构建阶段）
ARG DB_HOST
ARG DB_NAME
ARG DB_USER
ARG DB_PASSWORD
RUN PGPASSWORD=$DB_PASSWORD psql -h $DB_HOST -U $DB_USER -d $DB_NAME -f ./migration/initial.sql

# 安装依赖并准备应用
COPY requirements.txt ./
RUN pip install --no-cache-dir -r requirements.txt
COPY . .

# 最终镜像
FROM python:3.11-slim
WORKDIR /app
COPY --from=builder /app ./
CMD ["python", "app.py"]

构建时通过--build-arg传递敏感信息：

docker build --build-arg DB_HOST=your-db-host --build-arg DB_NAME=your-db --build-arg DB_USER=user --build-arg DB_PASSWORD=pass -t your-app .

关键注意事项 #

• 敏感信息：绝对不要在Dockerfile或配置文件中硬编码密码，用构建参数、Docker secrets或环境变量传递
• 幂等迁移：所有迁移脚本必须是幂等的（比如用CREATE TABLE IF NOT EXISTS），避免重复执行报错
• 构建环境限制：如果构建阶段无法连接数据库，改用下面的启动时迁移方案

替代方案：容器启动时执行迁移 #

如果构建环境无法访问数据库，编写一个启动脚本先执行迁移再启动应用：

启动脚本（start.sh） #

#!/bin/bash
set -e

# 执行迁移
echo "Running DB migrations..."
flyway migrate

# 启动应用
echo "Starting application..."
java -jar your-app.jar

调整后的Dockerfile #

FROM openjdk:17-jdk-slim

WORKDIR /app

# 复制应用、迁移资源和启动脚本
COPY target/your-app.jar ./
COPY db/migration/ ./db/migration/
COPY flyway.conf ./
COPY start.sh ./

# 安装Flyway并赋予脚本执行权限
RUN apt-get update && apt-get install -y wget unzip \
    && wget https://repo1.maven.org/maven2/org/flywaydb/flyway-commandline/9.22.3/flyway-commandline-9.22.3-linux-x64.zip \
    && unzip flyway-commandline-9.22.3-linux-x64.zip \
    && mv flyway-9.22.3 /opt/flyway \
    && rm flyway-commandline-9.22.3-linux-x64.zip \
    && chmod +x start.sh

CMD ["./start.sh"]

内容的提问来源于stack exchange，提问作者Gani P