如何编写Gradle task创建Docker MySQL容器并初始化数据库与空表

方案可行性确认 #

你提到的「Gradle 调用 Docker Compose 启动 MySQL 容器 + Liquibase 初始化库表」的方案完全可行，是Java生态中本地开发、集成测试场景初始化数据库的主流实现方式之一，优势是环境一致性高、流程可标准化，能避免不同开发人员本地环境、CI/CD环境的配置差异导致的问题。

具体落地步骤 #

• 第一步：编写docker-compose.yml配置文件
  记得添加健康检查配置，确保MySQL完全启动后再执行Liquibase脚本，避免连接失败，参考配置如下：

version: '3.8'
services:
  mysql:
    image: mysql:8.0
    ports:
      - "3307:3306"
    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: your_target_db
    healthcheck:
      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost"]
      timeout: 20s
      retries: 10

• 第二步：配置Gradle插件
  分别引入Docker Compose插件和Liquibase官方Gradle插件，参考build.gradle配置如下（Groovy语法）：

plugins {
    id 'java'
    // Docker Compose 管理插件
    id 'com.avast.gradle.docker-compose' version '0.16.11'
    // Liquibase 官方插件
    id 'org.liquibase.gradle' version '2.2.0'
}

dependencies {
    // 引入Liquibase核心依赖和MySQL驱动
    liquibaseRuntime 'org.liquibase:liquibase-core:4.20.0'
    liquibaseRuntime 'mysql:mysql-connector-java:8.0.33'
}

// Docker Compose 插件配置
dockerCompose {
    useComposeFiles = ['docker-compose.yml']
    // 等待容器健康检查通过再结束任务
    waitForHealthyState = true
}

// Liquibase 配置
liquibase {
    activities {
        main {
            // 对应你的changelog主文件路径
            changeLogFile 'src/main/resources/db/changelog/db.changelog-master.xml'
            // 端口和docker-compose中暴露的端口保持一致
            url 'jdbc:mysql://localhost:3307/your_target_db?useSSL=false&allowPublicKeyRetrieval=true'
            username 'root'
            password 'root'
        }
    }
}

// 自定义串联任务：启动容器 -> 执行Liquibase初始化
task initLocalDb {
    dependsOn dockerComposeUp, update
    group = 'db'
    description = '启动本地MySQL容器并初始化库表'
}

// 可选清理任务
task stopLocalDb {
    dependsOn dockerComposeDown
    group = 'db'
    description = '停止并删除本地MySQL容器'
}

• 第三步：按你自己的业务需求编写Liquibase changelog文件，放在上面配置的对应路径下即可。
• 第四步：执行./gradlew initLocalDb即可完成整个初始化流程，不需要用数据库的时候执行./gradlew stopLocalDb就能清理环境。

优化建议 #

• 可以将MySQL端口、账号密码、库名等配置放到gradle.properties中，避免硬编码，方便多人协作时各自调整本地配置。
• 如果是给集成测试使用，可以将initLocalDb绑定为test任务的前置依赖，测试执行完成后自动触发容器销毁，不需要手动操作。

其他可选方案 #

你可以根据自己的使用场景选择更适配的方案：

• Testcontainers方案：如果这个数据库环境主要用于集成测试，Testcontainers是更轻量化的选择，不需要单独维护docker-compose.yml文件，在测试代码中即可配置容器参数，测试执行完成后自动销毁，不会残留本地容器占用资源。
• H2内存数据库方案：如果只是做简单的本地功能验证、不需要持久化数据，可以选择H2内存数据库，启动速度更快、不需要依赖Docker，适合小项目快速迭代；缺点是和MySQL语法存在少量差异，可能出现本地验证通过、线上MySQL执行报错的问题。
• 本地MySQL直连方案：如果所有开发人员的本地环境都统一安装了固定版本的MySQL，也可以编写Gradle任务直接调用本地MySQL命令行工具建库建表，缺点是环境一致性差，不同开发人员的本地配置差异容易导致各类奇怪问题。

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