此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Boot 3.3.1！

此版本仍在开发中，尚未被视为稳定版本。对于最新的稳定版本，请使用 Spring Boot 3.3.1！

Testcontainers 库提供了一种管理在 Docker 容器中运行的服务的方法。 它与 JUnit 集成，允许您编写一个测试类，该类可以在任何测试运行之前启动容器。 Testcontainers 对于编写与真正的后端服务（如 MySQL、MongoDB、Cassandra 等）通信的集成测试特别有用。

Testcontainers 可以在 Spring Boot 测试中使用，如下所示：

  • Java

  • Kotlin

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Container
	static Neo4jContainer<?> neo4j = new Neo4jContainer<>("neo4j:5");

	@Test
	void myTest() {
		// ...
	}

}
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		// ...
	}

	companion object {
		@Container
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");
	}
}

这将在运行任何测试之前启动运行 Neo4j 的 docker 容器（如果 Docker 在本地运行）。 在大多数情况下，需要将应用程序配置为连接到容器中运行的服务。

服务连接

服务连接是与任何远程服务的连接。 Spring Boot 的自动配置可以使用服务连接的详细信息，并使用它们来建立与远程服务的连接。 执行此操作时，连接详细信息优先于任何与连接相关的配置属性。

使用 Testcontainers 时，可以通过批注测试类中的容器字段，为容器中运行的服务自动创建连接详细信息。

  • Java

  • Kotlin

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Container
	@ServiceConnection
	static Neo4jContainer<?> neo4j = new Neo4jContainer<>("neo4j:5");

	@Test
	void myTest() {
		// ...
	}

}
import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		// ...
	}

	companion object {

		@Container
		@ServiceConnection
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");

	}

}

多亏了 ，上述配置允许应用程序中与 Neo4j 相关的 bean 与 Testcontainers 管理的 Docker 容器内运行的 Neo4j 进行通信。 这是通过自动定义一个 bean 来完成的，然后 Neo4j 自动配置使用它，覆盖任何与连接相关的配置属性。@ServiceConnectionNeo4jConnectionDetails

需要将模块添加为测试依赖项，以便将服务连接与 Testcontainers 配合使用。spring-boot-testcontainers

服务连接注释由注册到 的类处理。 A 可以基于特定的子类或 Docker 映像名称创建 Bean。ContainerConnectionDetailsFactoryspring.factoriesContainerConnectionDetailsFactoryConnectionDetailsContainer

jar 中提供了以下服务连接工厂：spring-boot-testcontainers

连接详细信息 匹配于

ActiveMQConnectionDetails

名为“symptoma/activemq”或ActiveMQContainer

ArtemisConnectionDetails

容器类型ArtemisContainer

CassandraConnectionDetails

容器类型CassandraContainer

CouchbaseConnectionDetails

容器类型CouchbaseContainer

ElasticsearchConnectionDetails

容器类型ElasticsearchContainer

FlywayConnectionDetails

容器类型JdbcDatabaseContainer

JdbcConnectionDetails

容器类型JdbcDatabaseContainer

KafkaConnectionDetails

容器类型或org.testcontainers.containers.KafkaContainerRedpandaContainer

LiquibaseConnectionDetails

容器类型JdbcDatabaseContainer

MongoConnectionDetails

容器类型MongoDBContainer

Neo4jConnectionDetails

容器类型Neo4jContainer

OtlpMetricsConnectionDetails

名为“otel/opentelemetry-collector-contrib”的容器

OtlpTracingConnectionDetails

名为“otel/opentelemetry-collector-contrib”的容器

PulsarConnectionDetails

容器类型PulsarContainer

R2dbcConnectionDetails

类型为 、 、 、 或 的容器MariaDBContainerMSSQLServerContainerMySQLContainerOracleContainerPostgreSQLContainer

RabbitConnectionDetails

容器类型RabbitMQContainer

RedisConnectionDetails

名为“redis”的容器

ZipkinConnectionDetails

名为“openzipkin/zipkin”的容器

缺省情况下，将为给定的 . 例如，a 将同时创建 和 。ContainerPostgreSQLContainerJdbcConnectionDetailsR2dbcConnectionDetails

如果只想创建适用类型的子集，则可以使用 的属性。type@ServiceConnection

默认情况下，用于获取用于查找连接详细信息的名称。 Docker 映像名称的存储库部分忽略任何注册表和版本。 只要 Spring Boot 能够获取 的实例，这就有效，这在使用如上例所示的字段时就是这种情况。Container.getDockerImageName().getRepository()Containerstatic

如果您使用的是某个方法，Spring Boot 不会调用 bean 方法来获取 Docker 映像名称，因为这会导致急切的初始化问题。 相反，Bean 方法的返回类型用于找出应使用哪个连接详细信息。 只要您使用类型化容器，这就有效，例如 或。 如果您使用 ，例如与 Redis 一起使用，这将停止工作，如以下示例所示：@BeanNeo4jContainerRabbitMQContainerGenericContainer

  • Java

  • Kotlin

import org.testcontainers.containers.GenericContainer;

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.service.connection.ServiceConnection;
import org.springframework.context.annotation.Bean;

@TestConfiguration(proxyBeanMethods = false)
public class MyRedisConfiguration {

	@Bean
	@ServiceConnection(name = "redis")
	public GenericContainer<?> redisContainer() {
		return new GenericContainer<>("redis:7");
	}

}
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.testcontainers.service.connection.ServiceConnection
import org.springframework.context.annotation.Bean
import org.testcontainers.containers.GenericContainer

@TestConfiguration(proxyBeanMethods = false)
class MyRedisConfiguration {
	@Bean
	@ServiceConnection(name = "redis")
	fun redisContainer(): GenericContainer<*> {
		return GenericContainer("redis:7")
	}
}

Spring Boot 无法判断使用了哪个容器映像，因此必须使用 from 属性来提供该提示。GenericContainername@ServiceConnection

您还可以使用 of 属性来覆盖将使用的连接详细信息，例如在使用自定义映像时。 如果您使用的是 Docker 映像，则用于确保已创建。name@ServiceConnectionregistry.mycompany.com/mirror/myredis@ServiceConnection(name="redis")RedisConnectionDetails

需要将模块添加为测试依赖项，以便将服务连接与 Testcontainers 配合使用。spring-boot-testcontainers
连接详细信息 匹配于

ActiveMQConnectionDetails

名为“symptoma/activemq”或ActiveMQContainer

ArtemisConnectionDetails

容器类型ArtemisContainer

CassandraConnectionDetails

容器类型CassandraContainer

CouchbaseConnectionDetails

容器类型CouchbaseContainer

ElasticsearchConnectionDetails

容器类型ElasticsearchContainer

FlywayConnectionDetails

容器类型JdbcDatabaseContainer

JdbcConnectionDetails

容器类型JdbcDatabaseContainer

KafkaConnectionDetails

容器类型或org.testcontainers.containers.KafkaContainerRedpandaContainer

LiquibaseConnectionDetails

容器类型JdbcDatabaseContainer

MongoConnectionDetails

容器类型MongoDBContainer

Neo4jConnectionDetails

容器类型Neo4jContainer

OtlpMetricsConnectionDetails

名为“otel/opentelemetry-collector-contrib”的容器

OtlpTracingConnectionDetails

名为“otel/opentelemetry-collector-contrib”的容器

PulsarConnectionDetails

容器类型PulsarContainer

R2dbcConnectionDetails

类型为 、 、 、 或 的容器MariaDBContainerMSSQLServerContainerMySQLContainerOracleContainerPostgreSQLContainer

RabbitConnectionDetails

容器类型RabbitMQContainer

RedisConnectionDetails

名为“redis”的容器

ZipkinConnectionDetails

名为“openzipkin/zipkin”的容器

缺省情况下，将为给定的 . 例如，a 将同时创建 和 。ContainerPostgreSQLContainerJdbcConnectionDetailsR2dbcConnectionDetails

如果只想创建适用类型的子集，则可以使用 的属性。type@ServiceConnection

动态属性

服务连接的一个稍微冗长但也更灵活的替代方法是。 静态方法允许将动态属性值添加到 Spring 环境。@DynamicPropertySource@DynamicPropertySource

  • Java

  • Kotlin

import org.junit.jupiter.api.Test;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.junit.jupiter.Testcontainers;

import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.DynamicPropertyRegistry;
import org.springframework.test.context.DynamicPropertySource;

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Container
	static Neo4jContainer<?> neo4j = new Neo4jContainer<>("neo4j:5");

	@Test
	void myTest() {
		// ...
	}

	@DynamicPropertySource
	static void neo4jProperties(DynamicPropertyRegistry registry) {
		registry.add("spring.neo4j.uri", neo4j::getBoltUrl);
	}

}
import org.junit.jupiter.api.Test
import org.springframework.boot.test.context.SpringBootTest
import org.springframework.test.context.DynamicPropertyRegistry
import org.springframework.test.context.DynamicPropertySource
import org.testcontainers.containers.Neo4jContainer
import org.testcontainers.junit.jupiter.Container
import org.testcontainers.junit.jupiter.Testcontainers

@Testcontainers
@SpringBootTest
class MyIntegrationTests {

	@Test
	fun myTest() {
		// ...
	}

	companion object {
		@Container
		@JvmStatic
		val neo4j = Neo4jContainer("neo4j:5");

		@DynamicPropertySource
		@JvmStatic
		fun neo4jProperties(registry: DynamicPropertyRegistry) {
			registry.add("spring.neo4j.uri") { neo4j.boltUrl }
		}
	}
}

上述配置允许应用程序中与 Neo4j 相关的 Bean 与 Testcontainers 托管的 Docker 容器内运行的 Neo4j 进行通信。