多模块Gradle项目Testcontainers多测试套件共享单个容器的实现方法

核心问题原因 #

Gradle多模块项目中，每个子模块的测试任务会运行在独立的JVM进程中，你之前用的单例模式仅在单个JVM内有效，跨模块的测试进程无法共享同一个单例实例，所以每个套件都会启动新容器。

具体解决步骤 #

1. 启用Testcontainers全局复用模式 #

首先确保全局复用开关打开，同时保证所有模块的容器配置完全一致：

• 在Gradle构建脚本中为所有测试任务添加系统属性：

allprojects {
    tasks.withType(Test) {
        systemProperty "TESTCONTAINERS_REUSE_ENABLE", "true"
    }
}

• 统一容器配置类（建议放在buildSrc或通用子模块中）：

public class SharedContainer {
    private static final MySQLContainer<?> CONTAINER;

    static {
        CONTAINER = new MySQLContainer<>("mysql:8.0")
                .withDatabaseName("test_db")
                .withUsername("test")
                .withPassword("test")
                .withReuse(true); // 开启容器复用
        CONTAINER.start();
    }

    public static MySQLContainer<?> getInstance() {
        return CONTAINER;
    }
}

• 所有子模块的测试类都调用这个统一的容器实例获取连接信息。

2. 用Gradle共享构建服务（Gradle 7.0+推荐） #

这是最可靠的跨模块共享方式，通过Gradle的Shared Build Services管理容器生命周期，确保整个构建过程只启动一次：

• 在根项目build.gradle中定义共享服务：

plugins {
    id 'java'
}

extensions.create("testcontainers", TestcontainersExtension)

abstract class TestcontainersExtension {
    abstract Property<String> getMysqlImage()
}

abstract class SharedMysqlContainerService implements BuildService<SharedMysqlContainerService.Params>, AutoCloseable {
    interface Params extends BuildServiceParameters {
        Property<String> getImage()
    }

    private final MySQLContainer<?> container

    @Inject
    SharedMysqlContainerService(Params params) {
        container = new MySQLContainer<>(params.getImage().get())
                .withDatabaseName("test_db")
                .withUsername("test")
                .withPassword("test")
                .withReuse(true)
        container.start()
    }

    String getJdbcUrl() {
        return container.getJdbcUrl()
    }

    String getUsername() {
        return container.getUsername()
    }

    String getPassword() {
        return container.getPassword()
    }

    @Override
    void close() {
        // 复用模式下不要主动stop，让Testcontainers自动管理
        // container.stop()
    }
}

// 注册服务
def mysqlService = gradle.sharedServices.registerIfAbsent("mysqlContainer", SharedMysqlContainerService) {
    parameters.image = project.extensions.testcontainers.mysqlImage
}

// 所有子模块测试任务注入连接信息
subprojects {
    plugins.withId('java') {
        tasks.withType(Test) {
            def service = mysqlService.get()
            systemProperty "db.url", service.jdbcUrl
            systemProperty "db.username", service.username
            systemProperty "db.password", service.password
            // 让测试任务依赖服务，确保容器先启动
            usesService(mysqlService)
        }
    }
}

• 在子模块的测试类中通过系统属性获取连接：

String jdbcUrl = System.getProperty("db.url");
String username = System.getProperty("db.username");
String password = System.getProperty("db.password");

3. 关键注意事项 #

• 所有模块的容器配置必须完全一致（镜像版本、端口映射、环境变量、标签等），否则Testcontainers会认为是不同容器，无法复用。
• 不要在测试代码中手动调用container.stop()，复用模式下容器会在构建结束后由Testcontainers自动清理（或保留供下次构建复用）。
• 若之前有残留的容器，可手动执行docker rm $(docker ps -aq -f label=org.testcontainers=true)清理后再测试。

验证方法 #

运行测试时查看控制台日志，若出现Reusing container with ID: xxx的日志，说明复用生效；也可在测试运行中执行docker ps，确认只有一个Testcontainers容器在运行。

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