开发时服务

开发时服务提供运行应用程序时所需的外部依赖项。它们仅用于开发期间，在部署应用程序时会禁用。

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。

repackaged 的归档文件默认不包含 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" 的容器

HazelcastConnectionDetails

命名为 "hazelcast/hazelcast" 的容器。

JdbcConnectionDetails

命名为 "clickhouse/clickhouse-server", "bitnami/clickhouse", "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" 的容器

OtlpLoggingConnectionDetails

命名为 "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm" 的容器

OtlpMetricsConnectionDetails

命名为 "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm" 的容器

OtlpTracingConnectionDetails

命名为 "otel/opentelemetry-collector-contrib", "grafana/otel-lgtm" 的容器

PulsarConnectionDetails

命名为 "apachepulsar/pulsar" 的容器

R2dbcConnectionDetails

命名为 "clickhouse/clickhouse-server", "bitnami/clickhouse", "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", "redis/redis-stack" 或 "redis/redis-stack-server" 的容器

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 来指向不同的文件。属性可以定义为绝对路径或相对于应用程序的路径。

例如

  • Properties

  • 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 文件中更改超时值

  • Properties

  • 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。

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

  • Properties

  • 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 Profiles

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

  • Properties

  • 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 目录中创建一个“应用程序”类。例如，如果您的主应用程序位于 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 方法中贡献动态属性，则定义一个额外的 DynamicPropertyRegistrar bean。注册器应使用一个 @Bean 方法定义，该方法注入将从中获取属性的容器作为参数。这种安排确保容器在使用属性之前已启动。

一个典型的配置如下所示

import org.testcontainers.containers.MongoDBContainer;

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

@TestConfiguration(proxyBeanMethods = false)
public class MyContainersConfiguration {

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

	@Bean
	public DynamicPropertyRegistrar mongoDbProperties(MongoDBContainer container) {
		return (properties) -> {
			properties.add("spring.data.mongodb.host", container::getHost);
			properties.add("spring.data.mongodb.port", container::getFirstMappedPort);
		};
	}

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

导入 Testcontainers 声明类

使用 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 方法。这样的 bean 在 devtools 重启应用程序时不会被重新创建。这对 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 未激活。