如何在Gradle中正确配置jOOQ、Testcontainers与Flyway

问题根因 #

你遇到的多容器启动、容器无法自动停止问题由两个配置错误导致：

• 容器启动代码写在Gradle配置顶层：Gradle构建分为配置、执行两个阶段，顶层代码会在每次构建的配置阶段（哪怕仅执行./gradlew tasks查看任务）直接运行，每触发一次配置就会新建一个容器实例，最终出现多个冗余容器。
• 容器停止逻辑未绑定具体任务生命周期：原写法中tasks { doLast {} }是给所有任务统一追加动作，既会在无关任务中触发无效判断，也无法保证代码生成流程结束后一定执行容器停止操作。
  另外原配置存在笔误：jOOQ版本变量写为jookVersion，会导致版本读取失败。

完整可用配置 #

// 版本定义，按需修改
def postgresImageTag = "14-alpine"
def testContainersVersion = "1.18.3"
def jooqPluginVersion = "8.2"
def flywayPluginVersion = "9.22.3"
def jooqVersion = "3.18.7"
def postgresDriverVersion = "42.6.0"
def junitVersion = "5.10.0"
def generatedPackageName = "dataflow.generated" // 替换为实际jOOQ代码生成包名

buildscript {
    repositories {
        mavenLocal()
        mavenCentral()
    }
    dependencies {
        // 给构建脚本本身添加Testcontainers、PostgreSQL驱动依赖，用于构建期启动临时数据库
        classpath "org.testcontainers:postgresql:$testContainersVersion"
        classpath "org.postgresql:postgresql:$postgresDriverVersion"
    }
}

plugins {
    id 'java'
    id 'nu.studer.jooq' version "$jooqPluginVersion"
    id "org.flywaydb.flyway" version "$flywayPluginVersion"
}

repositories {
    mavenLocal()
    mavenCentral()
}

dependencies {
    // Spring 相关
    implementation 'org.springframework.boot:spring-boot-starter'
    implementation 'org.springframework.boot:spring-boot-starter-jooq'

    // PostgreSQL 运行时驱动
    runtimeOnly 'org.postgresql:postgresql'

    // jOOQ 代码生成器依赖
    jooqGenerator "org.postgresql:postgresql:$postgresDriverVersion"

    // Flyway
    implementation 'org.flywaydb:flyway-core'

    // 测试依赖
    testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
    testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
    testImplementation "org.testcontainers:testcontainers:$testContainersVersion"
    testImplementation "org.testcontainers:postgresql:$testContainersVersion"
}

// 用Gradle BuildService托管PostgreSQL容器，保证全局仅创建一个实例
abstract class PostgresContainerService implements BuildService<Params>, AutoCloseable {
    interface Params extends BuildServiceParameters {
        Property<String> getImageTag()
    }

    private final org.testcontainers.containers.JdbcDatabaseContainer<?> container

    PostgresContainerService() {
        container = new org.testcontainers.containers.PostgreSQLContainer(getParameters().getImageTag().get())
                .withDatabaseName("jooq_gen")
                .withUsername("gen_user")
                .withPassword("gen_pwd")
        container.start()
        println("PostgreSQL 代码生成容器已启动，JDBC地址：${container.getJdbcUrl()}")
    }

    org.testcontainers.containers.JdbcDatabaseContainer<?> getContainer() {
        return container
    }

    @Override
    void close() throws Exception {
        if (container.isRunning()) {
            container.stop()
            println("PostgreSQL 代码生成容器已停止并清理")
        }
    }
}

// 注册容器服务
def postgresService = gradle.sharedServices.registerIfAbsent("postgresContainer", PostgresContainerService) {
    parameters {
        imageTag.set(postgresImageTag)
    }
    // 同一时间仅允许一个任务使用该服务
    maxParallelUsages.set(1)
}

// Flyway基础配置
flyway {
    locations = ['classpath:db/migration']
    baselineOnMigrate = true
    schemas = ['public']
}

// jOOQ基础配置
jooq {
    version = jooqVersion
    edition = nu.studer.gradle.jooq.JooqEdition.OSS

    configurations {
        main {
            generateSchemaSourceOnCompilation = true
            generationTool {
                logging = org.jooq.meta.jaxb.Logging.WARN
                jdbc {
                    driver = 'org.postgresql.Driver'
                }
                generator {
                    name = 'org.jooq.codegen.DefaultGenerator'
                    database {
                        name = 'org.jooq.meta.postgres.PostgresDatabase'
                        inputSchema = 'public'
                        forcedTypes {
                            forcedType {
                                userType = 'com.fasterxml.jackson.databind.JsonNode'
                                includeTypes = '.*'
                                includeExpression = '.*JSON.*'
                                binding = 'dataflow.binding.PostgresJSONBBinding'
                            }
                        }
                    }
                    generate {
                        pojosAsKotlinDataClasses = true
                        deprecated = false
                        records = true
                        pojos = true
                        immutablePojos = false
                        fluentSetters = true
                        daos = true
                    }
                    target {
                        packageName = generatedPackageName
                        directory = 'build/generated-src/jooq/main'
                    }
                    strategy.name = 'org.jooq.codegen.DefaultGeneratorStrategy'
                }
            }
        }
    }
}

// 绑定任务依赖与运行时配置
tasks.named('flywayMigrate') {
    // 执行Flyway迁移前必须先启动容器服务
    usesService(postgresService)
    doFirst {
        // 任务执行时才动态注入数据库连接信息，避免配置阶段提前启动容器
        def container = postgresService.get().getContainer()
        flyway.url = container.jdbcUrl
        flyway.user = container.username
        flyway.password = container.password
    }
}

tasks.named('jooqCodegen') {
    // jOOQ代码生成必须等Flyway迁移执行完
    dependsOn('flywayMigrate')
    usesService(postgresService)
    doFirst {
        // 任务执行时才动态注入数据库连接信息
        def container = postgresService.get().getContainer()
        jooq.configurations.main.generationTool.jdbc.url = container.jdbcUrl
        jooq.configurations.main.generationTool.jdbc.user = container.username
        jooq.configurations.main.generationTool.jdbc.password = container.password
    }
}

配置特性 #

• 全局仅会创建1个PostgreSQL容器，不存在冗余实例
• 仅在执行jooqCodegen或依赖该任务的构建动作时才会启动容器，执行编译、测试、打包等其他任务不会额外占用资源
• 任务执行完成后AutoCloseable接口会自动触发容器停止、删除逻辑，不会残留容器实例
• 完全兼容原有jOOQ生成规则、Flyway迁移逻辑，不需要修改业务代码
• 执行./gradlew jooqCodegen即可一键完成「启动容器->执行数据库迁移->生成jOOQ代码->清理容器」全流程

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