问题：Docker Compose v2 YML 语法中如何正确声明服务依赖？

Question

在使用 Docker Compose v2 的 YML 配置文件时，如何正确声明服务之间的依赖关系，以确保服务按预期顺序启动？例如，当 Web 服务依赖于数据库服务时，应如何配置 `depends_on` 字段？在 v2 中，`depends_on` 是否支持健康状态检测？是否可以通过条件判断实现“等待服务就绪”这一行为？此外，`depends_on` 与 `links` 的区别是什么？使用时需要注意哪些常见误区？如何结合脚本或工具进一步确保服务依赖的可靠性？

Answer 1

一、Docker Compose v2 中服务依赖关系的声明与控制

在使用 Docker Compose 编排多服务应用时，确保服务按正确顺序启动至关重要。尤其是像 Web 服务依赖数据库服务的场景，若数据库尚未启动完成，Web 服务可能会因连接失败而崩溃。

在 Docker Compose v2 中，`depends_on` 是声明服务依赖关系的主要方式。它允许我们指定某个服务必须在另一个服务启动之后才能开始启动。

version: '2'
services:
  db:
    image: postgres:13
    container_name: mydb

  web:
    build: .
    container_name: myweb
    depends_on:
      - db

上述配置中，`web` 服务会在 `db` 服务容器启动后才开始启动。

二、Docker Compose v2 中的 depends_on 是否支持健康状态检测

在 Docker Compose v2 中，`depends_on` 只能确保服务容器的启动顺序，但不会等待服务真正“就绪”。也就是说，`depends_on` 并不检测服务是否通过了健康检查（healthcheck）。

例如，PostgreSQL 容器可能已经启动，但数据库服务还在初始化，此时 Web 服务尝试连接仍会失败。

要实现基于健康状态的依赖控制，必须配合使用健康检查（healthcheck）与额外脚本或工具。

三、是否可以通过条件判断实现“等待服务就绪”这一行为

虽然 Docker Compose v2 本身不支持等待服务“真正就绪”，但可以通过外部脚本实现这一行为。例如，在 Web 服务的启动脚本中加入等待数据库服务可连接的逻辑。

以下是一个简单的 Bash 脚本示例：

#!/bin/bash
set -e

# 等待数据库服务可连接
until PGPASSWORD=$DB_PASSWORD psql -h "db" -U "$DB_USER" -c '\q'; do
  echo "等待数据库服务启动中..."
  sleep 2
done

# 启动 Web 应用
exec "$@"

然后在 `docker-compose.yml` 中设置入口点指向该脚本：

web:
  build: .
  entrypoint: ["./wait-for-db.sh", "npm", "start"]

四、depends_on 与 links 的区别

`depends_on` 和 `links` 都用于服务之间的连接，但它们的用途和机制不同。

特性	depends_on	links
用途	控制服务启动顺序	创建容器间网络连接（旧版本特性）
是否影响网络	否	是
是否支持别名	否	是
是否推荐使用	是	否（推荐使用自定义网络）

在现代 Docker 环境中，`links` 已被弃用，推荐使用默认或自定义 Docker 网络实现服务间通信。

五、使用 depends_on 时的常见误区

1. 误以为 depends_on 等待服务就绪：它只控制启动顺序，不等待服务健康。
2. 忽视健康检查机制：即使服务容器启动，也不代表其内部服务已准备好。
3. 错误使用 links 替代 depends_on：两者作用不同，混用可能导致不可预料的行为。
4. 未处理服务启动失败后的重试逻辑：依赖服务启动失败可能导致整个系统无法正常运行。

六、结合脚本或工具进一步确保服务依赖的可靠性

为了增强服务依赖的可靠性，可以使用以下方法：

• 使用 wait-for-it.sh 或类似的脚本：这些脚本可以在启动服务前等待目标服务的端口开放。
• 集成健康检查与启动脚本：在服务启动脚本中主动探测依赖服务的健康状态。
• 引入服务发现与编排工具：如 Kubernetes，其提供了更高级的健康检查与依赖管理机制。

以下是一个使用 `wait-for-it.sh` 的示例：

web:
  build: .
  entrypoint: ["./wait-for-it.sh", "db:5432", "--", "npm", "start"]

这将确保 Web 服务在数据库服务的 5432 端口可用后才启动。

七、流程图：服务依赖关系控制流程

graph TD A[启动 Docker Compose] --> B[服务 A 依赖服务 B] B --> C[服务 B 启动] C --> D[服务 A 启动] D --> E[服务 A 检查服务 B 是否健康] E -->|是| F[服务 A 正常运行] E -->|否| G[服务 A 等待或退出]