开发时服务

开发时服务提供运行应用程序时所需的外部依赖项。它们仅应在开发过程中使用，并在应用程序部署时禁用。

Spring Boot 支持两种开发时服务：Docker Compose 和 Testcontainers。接下来的部分将提供有关它们的更多详细信息。

Docker Compose 支持

Docker Compose 是一种流行的技术，可用于定义和管理应用程序所需的多个服务容器。通常会在应用程序旁边创建一个 compose.yml 文件，用于定义和配置服务容器。

使用 Docker Compose 的典型工作流程是运行 docker compose up，在应用程序连接到已启动的服务时进行开发，然后在完成后运行 docker compose down。

spring-boot-docker-compose 模块可以包含在项目中，以提供对使用 Docker Compose 工作的容器的支持。将模块依赖项添加到您的构建中，如下面的 Maven 和 Gradle 列表所示

Maven
<dependencies>
	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-docker-compose</artifactId>
		<optional>true</optional>
	</dependency>
</dependencies>
Gradle
dependencies {
	developmentOnly("org.springframework.boot:spring-boot-docker-compose")
}

当此模块作为依赖项包含时，Spring Boot 将执行以下操作

  • 在您的工作目录中搜索 compose.yml 和其他常见的 compose 文件名

  • 使用发现的 compose.yml 调用 docker compose up

  • 为每个支持的容器创建服务连接 Bean

  • 在应用程序关闭时调用 docker compose stop

如果 Docker Compose 服务在启动应用程序时已在运行，Spring Boot 将仅为每个支持的容器创建服务连接 Bean。它不会再次调用 docker compose up，也不会在应用程序关闭时调用 docker compose stop。

重新打包的存档默认不包含 Spring Boot 的 Docker Compose。如果您想使用此支持，您需要包含它。使用 Maven 插件时，将 excludeDockerCompose 属性设置为 false。使用 Gradle 插件时，配置任务的类路径以包含 developmentOnly 配置.

先决条件

您需要在路径上拥有 docker 和 docker compose（或 docker-compose）CLI 应用程序。支持的最低 Docker Compose 版本为 2.2.0。

服务连接

服务连接是到任何远程服务的连接。Spring Boot 的自动配置可以消耗服务连接的详细信息，并使用它们建立到远程服务的连接。这样做时，连接详细信息优先于任何与连接相关的配置属性。

使用 Spring Boot 的 Docker Compose 支持时，服务连接将建立到容器映射的端口。

Docker Compose 通常以将容器内部端口映射到计算机上的临时端口的方式使用。例如，一个 Postgres 服务器可以在容器内使用端口 5432 运行，但映射到本地完全不同的端口。服务连接将始终发现并使用本地映射的端口。

服务连接是通过使用容器的镜像名称建立的。目前支持以下服务连接

连接详细信息 匹配项

ActiveMQConnectionDetails

名为“symptoma/activemq”或“apache/activemq-classic”的容器

ArtemisConnectionDetails

名为“apache/activemq-artemis”的容器

CassandraConnectionDetails

名为“cassandra”或“bitnami/cassandra”的容器

ElasticsearchConnectionDetails

名为“elasticsearch”或“bitnami/elasticsearch”的容器

JdbcConnectionDetails

名为“gvenzl/oracle-free”、“gvenzl/oracle-xe”、“mariadb”、“bitnami/mariadb”、“mssql/server”、“mysql”、“bitnami/mysql”、“postgres”或“bitnami/postgresql”的容器

LdapConnectionDetails

名为“osixia/openldap”的容器

MongoConnectionDetails

名为“mongo”或“bitnami/mongodb”的容器

Neo4jConnectionDetails

名为“neo4j”或“bitnami/neo4j”的容器

OtlpMetricsConnectionDetails

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

OtlpTracingConnectionDetails

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

PulsarConnectionDetails

名为“apachepulsar/pulsar”的容器

R2dbcConnectionDetails

名为“gvenzl/oracle-free”、“gvenzl/oracle-xe”、“mariadb”、“bitnami/mariadb”、“mssql/server”、“mysql”、“bitnami/mysql”、“postgres”或“bitnami/postgresql”的容器

RabbitConnectionDetails

名为“rabbitmq”或“bitnami/rabbitmq”的容器

RedisConnectionDetails

名为“redis”或“bitnami/redis”的容器

ZipkinConnectionDetails

名为“openzipkin/zipkin”的容器。

自定义镜像

有时您可能需要使用您自己的镜像版本来提供服务。您可以使用任何自定义镜像，只要它与标准镜像的行为方式相同。具体来说，标准镜像支持的任何环境变量也必须在您的自定义镜像中使用。

如果您的镜像使用不同的名称，您可以在您的 compose.yml 文件中使用标签，以便 Spring Boot 可以提供服务连接。使用名为 org.springframework.boot.service-connection 的标签来提供服务名称。

例如

services:
  redis:
    image: 'mycompany/mycustomredis:7.0'
    ports:
      - '6379'
    labels:
      org.springframework.boot.service-connection: redis

跳过特定容器

如果您在 compose.yml 中定义了一个容器镜像，而您不想将其连接到您的应用程序，您可以使用标签来忽略它。任何标记为 org.springframework.boot.ignore 的容器将被 Spring Boot 忽略。

例如

services:
  redis:
    image: 'redis:7.0'
    ports:
      - '6379'
    labels:
      org.springframework.boot.ignore: true

使用特定 Compose 文件

如果您的 Compose 文件不在与您的应用程序相同的目录中，或者它的名称不同，您可以在您的 application.properties 或 application.yaml 中使用 spring.docker.compose.file 来指向不同的文件。属性可以定义为确切的路径或相对于您的应用程序的路径。

例如

  • 属性

  • YAML

spring.docker.compose.file=../my-compose.yml
spring:
  docker:
    compose:
      file: "../my-compose.yml"

等待容器就绪

由 Docker Compose 启动的容器可能需要一些时间才能完全就绪。检查就绪状态的推荐方法是在您的 compose.yml 文件中服务定义下添加 healthcheck 部分。

由于 compose.yml 文件中通常会省略 healthcheck 配置，因此 Spring Boot 也会直接检查服务就绪状态。默认情况下，当可以建立到其映射端口的 TCP/IP 连接时，容器被认为是就绪的。

您可以在您的 compose.yml 文件中添加 org.springframework.boot.readiness-check.tcp.disable 标签，在每个容器的基础上禁用此功能。

例如

services:
  redis:
    image: 'redis:7.0'
    ports:
      - '6379'
    labels:
      org.springframework.boot.readiness-check.tcp.disable: true

您也可以在您的 application.properties 或 application.yaml 文件中更改超时值

  • 属性

  • YAML

spring.docker.compose.readiness.tcp.connect-timeout=10s
spring.docker.compose.readiness.tcp.read-timeout=5s
spring:
  docker:
    compose:
      readiness:
        tcp:
          connect-timeout: 10s
          read-timeout: 5s

可以使用 spring.docker.compose.readiness.timeout 配置总超时时间。

控制 Docker Compose 生命周期

默认情况下，Spring Boot 在您的应用程序启动时调用 docker compose up，并在应用程序关闭时调用 docker compose stop。如果您希望使用不同的生命周期管理，可以使用 spring.docker.compose.lifecycle-management 属性。

支持以下值

  • none - 不启动或停止 Docker Compose

  • start-only - 在应用程序启动时启动 Docker Compose 并保持运行

  • start-and-stop - 在应用程序启动时启动 Docker Compose，并在 JVM 退出时停止它

此外，您可以使用 spring.docker.compose.start.command 属性更改是否使用 docker compose up 或 docker compose start。spring.docker.compose.stop.command 允许您配置是否使用 docker compose down 或 docker compose stop。

以下示例展示了如何配置生命周期管理

  • 属性

  • YAML

spring.docker.compose.lifecycle-management=start-and-stop
spring.docker.compose.start.command=start
spring.docker.compose.stop.command=down
spring.docker.compose.stop.timeout=1m
spring:
  docker:
    compose:
      lifecycle-management: start-and-stop
      start:
        command: start
      stop:
        command: down
        timeout: 1m

激活 Docker Compose 配置文件

Docker Compose 配置文件类似于 Spring 配置文件，它们允许您为特定环境调整 Docker Compose 配置。如果您想激活特定的 Docker Compose 配置文件，可以在您的 application.properties 或 application.yaml 文件中使用 spring.docker.compose.profiles.active 属性

  • 属性

  • YAML

spring.docker.compose.profiles.active=myprofile
spring:
  docker:
    compose:
      profiles:
        active: "myprofile"

在测试中使用 Docker Compose

默认情况下，Spring Boot 的 Docker Compose 支持在运行测试时被禁用。

要在测试中启用 Docker Compose 支持，请将 spring.docker.compose.skip.in-tests 设置为 false。

使用 Gradle 时，您还需要将 spring-boot-docker-compose 依赖项的配置从 developmentOnly 更改为 testAndDevelopmentOnly

Gradle
dependencies {
	testAndDevelopmentOnly("org.springframework.boot:spring-boot-docker-compose")
}

Testcontainers 支持

除了 使用 Testcontainers 进行集成测试，您也可以在开发时使用它们。接下来的部分将提供更多关于此方面的详细信息。

在开发时使用 Testcontainers

这种方法允许开发人员快速启动应用程序依赖的服务容器，从而无需手动配置数据库服务器等内容。以这种方式使用 Testcontainers 提供类似于 Docker Compose 的功能，只是您的容器配置是在 Java 中而不是 YAML 中。

要在开发时使用 Testcontainers，您需要使用“测试”类路径而不是“主”类路径启动应用程序。这将允许您访问所有声明的测试依赖项，并为您提供一个自然的位置来编写测试配置。

要创建应用程序的测试可启动版本，您应该在 src/test 目录中创建一个“Application”类。例如，如果您的主应用程序位于 src/main/java/com/example/MyApplication.java 中，您应该创建 src/test/java/com/example/TestMyApplication.java

TestMyApplication 类可以使用 SpringApplication.from(…​) 方法启动真实应用程序

import org.springframework.boot.SpringApplication;

public class TestMyApplication {

	public static void main(String[] args) {
		SpringApplication.from(MyApplication::main).run(args);
	}

}

您还需要定义要与应用程序一起启动的 Container 实例。为此，您需要确保已将 spring-boot-testcontainers 模块添加为 test 依赖项。完成此操作后，您可以创建一个 @TestConfiguration 类，该类为要启动的容器声明 @Bean 方法。

您还可以使用 @ServiceConnection 注释您的 @Bean 方法，以创建 ConnectionDetails bean。有关支持技术的详细信息，请参阅 服务连接 部分。

典型的 Testcontainers 配置如下所示

import org.testcontainers.containers.Neo4jContainer;

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 MyContainersConfiguration {

	@Bean
	@ServiceConnection
	public Neo4jContainer<?> neo4jContainer() {
		return new Neo4jContainer<>("neo4j:5");
	}

}
Container bean 的生命周期由 Spring Boot 自动管理。容器将自动启动和停止。
您可以使用 spring.testcontainers.beans.startup 属性更改容器的启动方式。默认情况下使用 sequential 启动，但如果您希望并行启动多个容器，也可以选择 parallel。

定义好测试配置后，您可以使用 with(…​) 方法将其附加到测试启动器

import org.springframework.boot.SpringApplication;

public class TestMyApplication {

	public static void main(String[] args) {
		SpringApplication.from(MyApplication::main).with(MyContainersConfiguration.class).run(args);
	}

}

您现在可以像启动任何常规 Java main 方法应用程序一样启动 TestMyApplication，以启动应用程序及其运行所需的容器。

您可以使用 Maven 目标 `spring-boot:test-run` 或 Gradle 任务 `bootTestRun` 从命令行执行此操作。

在开发时贡献动态属性

如果您想在开发时从您的 `Container` `@Bean` 方法中贡献动态属性，您可以通过注入 `DynamicPropertyRegistry` 来实现。这与您可以在测试中使用的 `@DynamicPropertySource` 注解 类似。它允许您添加在容器启动后可用的属性。

典型的配置如下所示

import org.testcontainers.containers.MongoDBContainer;

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.context.annotation.Bean;
import org.springframework.test.context.DynamicPropertyRegistry;

@TestConfiguration(proxyBeanMethods = false)
public class MyContainersConfiguration {

	@Bean
	public MongoDBContainer mongoDbContainer(DynamicPropertyRegistry properties) {
		MongoDBContainer container = new MongoDBContainer("mongo:5.0");
		properties.add("spring.data.mongodb.host", container::getHost);
		properties.add("spring.data.mongodb.port", container::getFirstMappedPort);
		return container;
	}

}
建议尽可能使用 `@ServiceConnection`，但是，对于尚未支持 `@ServiceConnection` 的技术，动态属性可以作为一种有用的备选方案。

导入 Testcontainer 声明类

使用 Testcontainers 时，一种常见的模式是将 `Container` 实例声明为静态字段。通常，这些字段直接定义在测试类上。它们也可以声明在父类上或测试实现的接口上。

例如，以下 `MyContainers` 接口声明了 `mongo` 和 `neo4j` 容器

import org.testcontainers.containers.MongoDBContainer;
import org.testcontainers.containers.Neo4jContainer;
import org.testcontainers.junit.jupiter.Container;

import org.springframework.boot.testcontainers.service.connection.ServiceConnection;

public interface MyContainers {

	@Container
	@ServiceConnection
	MongoDBContainer mongoContainer = new MongoDBContainer("mongo:5.0");

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

}

如果您已经以这种方式定义了容器，或者您只是更喜欢这种风格，您可以导入这些声明类，而不是将容器定义为 `@Bean` 方法。为此，请将 `@ImportTestcontainers` 注解添加到您的测试配置类中

import org.springframework.boot.test.context.TestConfiguration;
import org.springframework.boot.testcontainers.context.ImportTestcontainers;

@TestConfiguration(proxyBeanMethods = false)
@ImportTestcontainers(MyContainers.class)
public class MyContainersConfiguration {

}
如果您不打算使用 服务连接功能，而是想使用 `@DynamicPropertySource`，请从 `Container` 字段中删除 `@ServiceConnection` 注解。您也可以将 `@DynamicPropertySource` 注解的方法添加到您的声明类中。

在开发时使用 DevTools 与 Testcontainers

当使用 devtools 时，您可以使用 `@RestartScope` 注解 bean 和 bean 方法。当 devtools 重启应用程序时，这些 bean 不会被重新创建。这对于 Testcontainer `Container` bean 尤其有用，因为它们在应用程序重启后会保留其状态。

import org.testcontainers.containers.MongoDBContainer;

import org.springframework.boot.devtools.restart.RestartScope;
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 MyContainersConfiguration {

	@Bean
	@RestartScope
	@ServiceConnection
	public MongoDBContainer mongoDbContainer() {
		return new MongoDBContainer("mongo:5.0");
	}

}
如果您使用的是 Gradle 并想使用此功能，您需要将 `spring-boot-devtools` 依赖项的配置从 `developmentOnly` 更改为 `testAndDevelopmentOnly`。使用默认范围 `developmentOnly`，`bootTestRun` 任务将不会拾取代码中的更改，因为 devtools 未处于活动状态。