SpringBoot 3 Docker Compose Support

写不了一点代码
1,336 阅读5分钟

5.7 整合 docker-compose

SpringBoot 3 开始支持 Docker Compose。

Docker Compose 的典型工作流程是运行 docker compose up，处理您的应用程序并连接到已启动的服务，然后 docker compose down 在完成后运行。

引入依赖：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-docker-compose</artifactId>
        <optional>true</optional>
    </dependency>
</dependencies>

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

  • 在应用程序目录中搜索 compose.yml 和其他常用 compose 的文件名

    • compose.yaml
    • compose.yml

  • 当应用程序启动时，使用命令 docker compose up 启动 compose 文件中定义的容器/服务。

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

  • 当应用程序关闭时调用 docker compose stop 关闭 compose 文件中定义的容器/服务。

docker compose 或 docker-compose CLI 应用程序需要在您的路径上，才能使 Spring Boot 的支持正常工作。

5.7.1 服务连接

服务连接是指连接到任何远程服务的连接。Spring Boot 的自动配置可以获取服务连接的细节，并使用它们来建立与远程服务的连接。（即，如果使用 docker compose 文件启动数据库服务，则服务连接可以读取数据库的用户名、密码和 URL，并使用这些详细信息从 SpringBoot 项目连接到数据库。即无需在应用程序属性文件中定义这些属性）。当这样做的时候，连接细节的设置优先级高于任何与连接相关的配置属性。即，如果在 application.properties 中配置了数据库连接详细信息，并且如果您使用的是 docker-compose 模块，则在 docker compose 文件中定义的环境变量（形成连接信息）优先。

当使用 Spring Boot 的 Docker Compose support 时，会与容器映射的端口建立服务连接。

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

服务连接是使用容器的 image name 建立的。当前支持以下服务连接：

Connection Details 连接详细信息Matched on 匹配于
CassandraConnectionDetails名为 cassandra 的容器
ElasticsearchConnectionDetails名为 elasticsearch 的容器
JdbcConnectionDetails名为 gvenzl/oracle-xe、mariadb、mssql/server、mysql 或 postgres 的容器
MongoConnectionDetails名为 mongo 的容器
R2dbcConnectionDetails名为 gvenzl/oracle-xe、mariadb、mssql/server、mysql 或 postgres 的容器
RabbitConnectionDetails名为 rabbitmq 的容器
RedisConnectionDetails名为 redis 的容器
ZipkinConnectionDetails名为 openzipkin/zipkin 的容器。

5.7.2 自定义镜像

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

如果您的 image 使用其他名称，则可以在 compose.yml 文件中使用标签 label，以便 SpringBoot 可以提供服务连接。使用名为 org.springframework.boot.service-connection 的标签来提供你自己 image 名称。

例如：

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

5.7.3 跳过特定容器

如果您在 compose.yml 定义了一个容器 image，但不想它连接到您的应用程序，则可以使用标签来忽略它。任何带有 org.springframework.boot.ignore 标签的容器都会被 SpringBoot 忽略。

例如：

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

5.7.4 使用特定的 Compose 文件

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

例如：

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

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

5.7.5 等待容器准备就绪

由 Docker Compose 启动的容器可能需要一些时间才能完全准备就绪。检查就绪情况的建议方法是在 compose.yml 文件中的服务定义下添加一个 healthcheck 部分。

由于 compose.yml 文件中经常省略 healthcheck 配置，因此 SpringBoot 还会直接检查服务准备情况。默认情况下，当容器可以与其映射端口建立 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 or application.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 配置总超时。

5.7.6 控制 Docker Compose 生命周期

SpringBoot 默认在应用程序启动时调用 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 命令。

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

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

5.7.7 激活 Docker Compose 配置文件

Docker Compose 的配置文件和 Spring 的配置文件类似，它们可以让您根据特定的环境调整您的 Docker Compose 配置。如果您想要激活一个特定的 Docker Compose profile，您可以在您的 application.properties 或 application.yaml 文件中使用 spring.docker.compose.profiles.active 属性：

spring.docker.compose.profiles.active=myprofile

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

5.7.8 使用时踩的坑

  1. permission denied while trying to connect to the Docker daemon socket at unix:///var/run/docker.sock: Get "%2Fvar%2Frun%2Fdocker.sock/v1.24/conta…": dial unix /var/run/docker.sock: connect: permission denied

    权限问题，解决办法：blog.csdn.net/hey_girl_/a…

  2. error getting credentials - err: exec: "docker-credential-desktop": executable file not found in $PATH, out: ``

    删除 ~/.docker/config.json 中的 credsStore 属性

  3. 在官网脚手架生成的 SpringBoot 项目会根据选择的依赖帮助生成一个 compose.yml 文件，不需要自己手动创建，在原有的基础上配置容器的环境即可。

  4. SpringBoot Docker Compose Support 在 SpringBootTest 中不会自动启动 docker 容器，测试的时候需要手动启动容器，手动关闭容器，所以还是要在 yml 中配置数据库连接相关的属性。

avatar
文章
阅读
粉丝