開發時服務

開發時服務提供應用程式在開發時執行所需的外部依賴項。它們僅用於開發期間，並在部署應用程式時停用。

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 外掛時，配置任務的 classpath 以包含 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" 的容器

ElasticsearchConnectionDetails

名為 "elasticsearch" 的容器

HazelcastConnectionDetails

名為 "hazelcast/hazelcast" 的容器。

JdbcConnectionDetails

名為 "clickhouse/clickhouse-server"、"gvenzl/oracle-free"、"gvenzl/oracle-xe"、"mariadb"、"mssql/server"、"mysql" 或 "postgres" 的容器

LdapConnectionDetails

名為 "osixia/openldap"、"lldap/lldap" 的容器

MongoConnectionDetails

名為 "mongo" 的容器

Neo4jConnectionDetails

名為 "neo4j" 的容器

OpenTelemetryLoggingConnectionDetails

名為 "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"、"gvenzl/oracle-free"、"gvenzl/oracle-xe"、"mariadb"、"mssql/server"、"mysql" 或 "postgres" 的容器

RabbitConnectionDetails

名為 "rabbitmq" 的容器

RedisConnectionDetails

名為 "redis"、"redis/redis-stack" 或 "redis/redis-stack-server" 的容器

ZipkinConnectionDetails

名為 "openzipkin/zipkin" 的容器。

SSL 支援

某些映象預設啟用 SSL，或者您可能希望為容器啟用 SSL 以映象您的生產設定。Spring Boot 支援為受支援的服務連線進行 SSL 配置。請注意，您仍然需要在容器內部執行的服務上自行啟用 SSL，此功能僅在您的應用程式中配置客戶端 SSL。

以下服務連線支援 SSL

  • Cassandra

  • Couchbase

  • Elasticsearch

  • Kafka

  • MongoDB

  • RabbitMQ

  • Redis

要為服務啟用 SSL 支援，您可以使用服務標籤。

對於基於 JKS 的金鑰庫和信任庫，您可以使用以下容器標籤

  • org.springframework.boot.sslbundle.jks.key.alias

  • org.springframework.boot.sslbundle.jks.key.password

  • org.springframework.boot.sslbundle.jks.options.ciphers

  • org.springframework.boot.sslbundle.jks.options.enabled-protocols

  • org.springframework.boot.sslbundle.jks.protocol

  • org.springframework.boot.sslbundle.jks.keystore.type

  • org.springframework.boot.sslbundle.jks.keystore.provider

  • org.springframework.boot.sslbundle.jks.keystore.location

  • org.springframework.boot.sslbundle.jks.keystore.password

  • org.springframework.boot.sslbundle.jks.truststore.type

  • org.springframework.boot.sslbundle.jks.truststore.provider

  • org.springframework.boot.sslbundle.jks.truststore.location

  • org.springframework.boot.sslbundle.jks.truststore.password

這些標籤映象了 SSL 捆綁包可用的屬性。

對於基於 PEM 的金鑰庫和信任庫，您可以使用以下容器標籤

  • org.springframework.boot.sslbundle.pem.key.alias

  • org.springframework.boot.sslbundle.pem.key.password

  • org.springframework.boot.sslbundle.pem.options.ciphers

  • org.springframework.boot.sslbundle.pem.options.enabled-protocols

  • org.springframework.boot.sslbundle.pem.protocol

  • org.springframework.boot.sslbundle.pem.keystore.type

  • org.springframework.boot.sslbundle.pem.keystore.certificate

  • org.springframework.boot.sslbundle.pem.keystore.private-key

  • org.springframework.boot.sslbundle.pem.keystore.private-key-password

  • org.springframework.boot.sslbundle.pem.truststore.type

  • org.springframework.boot.sslbundle.pem.truststore.certificate

  • org.springframework.boot.sslbundle.pem.truststore.private-key

  • org.springframework.boot.sslbundle.pem.truststore.private-key-password

這些標籤映象了 SSL 捆綁包可用的屬性。

以下示例為 redis 容器啟用 SSL

services:
  redis:
    image: 'redis:latest'
    ports:
      - '6379'
    secrets:
      - ssl-ca
      - ssl-key
      - ssl-cert
    command: 'redis-server --tls-port 6379 --port 0 --tls-cert-file /run/secrets/ssl-cert --tls-key-file /run/secrets/ssl-key --tls-ca-cert-file /run/secrets/ssl-ca'
    labels:
      - 'org.springframework.boot.sslbundle.pem.keystore.certificate=client.crt'
      - 'org.springframework.boot.sslbundle.pem.keystore.private-key=client.key'
      - 'org.springframework.boot.sslbundle.pem.truststore.certificate=ca.crt'
secrets:
  ssl-ca:
    file: 'ca.crt'
  ssl-key:
    file: 'server.key'
  ssl-cert:
    file: 'server.crt'

自定義映象

有時您可能需要使用自己的映象版本來提供服務。您可以使用任何自定義映象，只要它的行為與標準映象相同即可。具體來說，標準映象支援的任何環境變數也必須在您的自定義映象中使用。

如果您的映象使用不同的名稱，您可以在 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 部分。

由於 healthcheck 配置在 compose.yml 檔案中被省略的情況並不少見，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 Profiles

Docker Compose profiles 類似於 Spring profiles，它們允許您針對特定環境調整 Docker Compose 配置。如果您想啟用特定的 Docker Compose profile，可以在 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，您需要使用“測試”classpath 而不是“main”來啟動應用程式。這將允許您訪問所有宣告的測試依賴項，併為您提供一個自然的位置來編寫測試配置。

要建立應用程式的可測試啟動版本，您應該在 src/test 目錄中建立“Application”類。例如，如果您的主應用程式在 src/main/java/com/example/MyApplication.java 中，您應該建立 src/test/java/com/example/TestMyApplication.java

TestMyApplication 類可以使用 SpringApplication.from(…​) 方法啟動實際應用程式

  • Java

  • Kotlin

import org.springframework.boot.SpringApplication;

public class TestMyApplication {

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

}
import org.springframework.boot.fromApplication

fun main(args: Array<String>) {
	fromApplication<MyApplication>().run(*args)
}

您還需要定義要與應用程式一起啟動的 Container 例項。為此，您需要確保已將 spring-boot-testcontainers 模組新增為 test 依賴項。完成此操作後，您可以建立 @TestConfiguration 類，該類宣告要啟動的容器的 @Bean 方法。

您還可以使用 @ServiceConnection 註釋您的 @Bean 方法，以建立 ConnectionDetails bean。有關支援技術的詳細資訊，請參見服務連線部分。

典型的 Testcontainers 配置如下所示

  • Java

  • Kotlin

import org.testcontainers.neo4j.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");
	}

}
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.boot.testcontainers.service.connection.ServiceConnection
import org.springframework.context.annotation.Bean
import org.testcontainers.neo4j.Neo4jContainer

@TestConfiguration(proxyBeanMethods = false)
class MyContainersConfiguration {

	@Bean
	@ServiceConnection
	fun neo4jContainer(): Neo4jContainer {
		return Neo4jContainer("neo4j:5")
	}

}
Container bean 的生命週期由 Spring Boot 自動管理。容器將自動啟動和停止。
您可以使用 spring.testcontainers.beans.startup 屬性來更改容器的啟動方式。預設情況下使用 sequential 啟動，但如果您希望並行啟動多個容器，也可以選擇 parallel。

定義測試配置後，您可以使用 with(…​) 方法將其附加到測試啟動器

  • Java

  • Kotlin

import org.springframework.boot.SpringApplication;

public class TestMyApplication {

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

}
import org.springframework.boot.fromApplication
import org.springframework.boot.with

fun main(args: Array<String>) {
	fromApplication<MyApplication>().with(MyContainersConfiguration::class).run(*args)
}

您現在可以像啟動任何常規 Java main 方法應用程式一樣啟動 TestMyApplication，以啟動您的應用程式及其執行所需的容器。

您可以使用 Maven 目標 spring-boot:test-run 或 Gradle 任務 bootTestRun 從命令列執行此操作。

在開發時貢獻動態屬性

如果您想在開發時從您的 Container @Bean 方法貢獻動態屬性，請定義一個額外的 DynamicPropertyRegistrar bean。註冊器應使用 @Bean 方法定義，該方法將作為屬性來源的容器作為引數注入。這種安排確保在屬性使用之前容器已啟動。

典型的配置如下所示

  • Java

  • Kotlin

import org.testcontainers.mongodb.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.mongodb.host", container::getHost);
			properties.add("spring.mongodb.port", container::getFirstMappedPort);
		};
	}

}
import org.springframework.boot.test.context.TestConfiguration
import org.springframework.context.annotation.Bean
import org.springframework.test.context.DynamicPropertyRegistrar;
import org.testcontainers.mongodb.MongoDBContainer

@TestConfiguration(proxyBeanMethods = false)
class MyContainersConfiguration {

	@Bean
	fun mongoDbContainer(): MongoDBContainer {
		return MongoDBContainer("mongo:5.0")
	}
	
	@Bean
	fun mongoDbProperties(container: MongoDBContainer): DynamicPropertyRegistrar {
		return DynamicPropertyRegistrar { properties ->
			properties.add("spring.mongodb.host") { container.host }
			properties.add("spring.mongodb.port") { container.firstMappedPort }
		}
	}

}
儘可能推薦使用 @ServiceConnection，但是，動態屬性可以作為尚未支援 @ServiceConnection 的技術的有用備用方案。

匯入 Testcontainers 宣告類

使用 Testcontainers 的常見模式是將 Container 例項宣告為靜態欄位。通常這些欄位直接在測試類上定義。它們也可以在父類或測試實現的介面上宣告。

例如，以下 MyContainers 介面聲明瞭 mongo 和 neo4j 容器

  • Java

  • Kotlin

import org.testcontainers.junit.jupiter.Container;
import org.testcontainers.mongodb.MongoDBContainer;
import org.testcontainers.neo4j.Neo4jContainer;

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");

}
import org.springframework.boot.testcontainers.service.connection.ServiceConnection
import org.testcontainers.junit.jupiter.Container
import org.testcontainers.mongodb.MongoDBContainer
import org.testcontainers.neo4j.Neo4jContainer

interface MyContainers {

	companion object {

		@Container
		@ServiceConnection
		@JvmField
		val mongoContainer = MongoDBContainer("mongo:5.0")

		@Container
		@ServiceConnection
		@JvmField
		val neo4jContainer = Neo4jContainer("neo4j:5")

	}

}

如果您已經以這種方式定義了容器，或者您只是喜歡這種風格，您可以匯入這些宣告類，而不是將您的容器定義為 @Bean 方法。為此，請將 @ImportTestcontainers 註釋新增到您的測試配置類中

  • Java

  • Kotlin

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

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

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

@TestConfiguration(proxyBeanMethods = false)
@ImportTestcontainers(MyContainers::class)
class MyContainersConfiguration
如果您不打算使用服務連線功能，而是想使用@DynamicPropertySource，請從 Container 欄位中刪除 @ServiceConnection 註解。您還可以將帶有 @DynamicPropertySource 註解的方法新增到您的宣告類中。

在開發時將 DevTools 與 Testcontainers 一起使用

使用 devtools 時，您可以使用 @RestartScope 註解 bean 和 bean 方法。當 devtools 重啟應用程式時，這些 bean 將不會被重新建立。這對於 Container bean 尤其有用，因為它們在應用程式重啟後仍保持其狀態。

  • Java

  • Kotlin

import org.testcontainers.mongodb.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");
	}

}
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
import org.testcontainers.mongodb.MongoDBContainer

@TestConfiguration(proxyBeanMethods = false)
class MyContainersConfiguration {

	@Bean
	@RestartScope
	@ServiceConnection
	fun mongoDbContainer(): MongoDBContainer {
		return MongoDBContainer("mongo:5.0")
	}

}
如果您正在使用 Gradle 並希望使用此功能，您需要將 spring-boot-devtools 依賴項的配置從 developmentOnly 更改為 testAndDevelopmentOnly。在 developmentOnly 的預設範圍內，bootTestRun 任務將不會檢測到程式碼中的更改，因為 devtools 未處於活動狀態。
© . This site is unofficial and not affiliated with VMware.