docker-compose.yml的depends_on:到底是干什么的？底层原理是什么？

原创已于 2025-01-02 00:43:40 修改 · 1.1k 阅读

8 ·

CC 4.0 BY-SA版权

文章标签：

#docker #容器 #运维

于 2025-01-02 00:38:53 首次发布

Docker 专栏收录该内容

165 篇文章

订阅专栏

docker-compose.yml 文件中的 depends_on 指令用于定义服务之间的依赖关系，确保某些服务在其他服务启动之后再启动。然而，需要注意的是，depends_on 并不等待依赖的服务完全“准备好”（例如数据库完成初始化），它只是简单地保证指定的服务先于当前服务被启动。

`depends_on` 的作用

启动顺序控制：通过 depends_on，你可以定义哪些服务应该在另一个服务之前启动。这对于需要依赖其他服务（如数据库、缓存等）才能正常运行的应用程序非常重要。
简化配置文件：它使得 Docker Compose 配置文件更加清晰易读，明确表达了各个服务之间的依赖关系。

使用场景

数据库和应用服务器：典型的例子是一个 Web 应用程序依赖于 MySQL 或 PostgreSQL 数据库。使用 depends_on 可以确保数据库容器在 Web 服务器容器之前启动。
微服务架构：在一个由多个微服务组成的应用中，某些服务可能依赖于其他服务提供的 API 或消息队列。通过 depends_on 可以定义这些依赖关系，确保正确的启动顺序。
测试环境：在构建自动化测试管道时，你可能希望模拟真实环境中服务的启动顺序。depends_on 帮助你创建一个更贴近生产的测试环境。
持续集成/部署 (CI/CD)：当设置 CI/CD 管道时，确保所有必要的后端服务已经启动并可用对于前端或客户端应用程序的成功构建至关重要。

底层原理

启动顺序

当你使用了 depends_on 指令后，Docker Compose 会按照以下步骤处理：

解析依赖树：Docker Compose 分析整个 docker-compose.yml 文件，确定每个服务的依赖关系，并构建一个有向无环图（DAG）来表示这些依赖。
按拓扑排序启动服务：根据 DAG，Docker Compose 会按照拓扑排序的结果依次启动服务，即先启动没有依赖的服务，然后是它们的直接依赖者，依此类推。

重要限制

尽管 depends_on 可以控制启动顺序，但它并不会等待依赖的服务真正“就绪”。这意味着如果一个服务需要一些时间来完成初始化（例如加载大量数据到内存中或执行复杂的迁移脚本），那么依赖它的服务可能会在它还没有准备好时就开始尝试连接，从而导致失败。

为了解决这个问题，通常建议采取以下措施之一：

健康检查 (healthcheck)：为依赖的服务添加健康检查指令，只有当服务被认为是健康的（通过自定义的健康检查命令验证），才会认为该服务已准备好。
初始化脚本：编写专门的初始化脚本，在启动主进程之前检查依赖服务的状态。例如，Web 应用可以有一个启动脚本，在实际启动 Web 服务器之前不断尝试连接数据库，直到成功为止。
重试逻辑：在应用代码内部实现重试机制，以便在初次连接失败的情况下自动重试，直到连接成功或者达到最大重试次数。

示例代码和详细注释

假设我们有一个简单的 PHP Web 应用程序和 MySQL 数据库的组合，并且我们想让它们通过 Docker Compose 来管理和部署。

目录结构

my_php_app/
├── docker-compose.yml
├── php/
│   └── Dockerfile
└── web/
    └── index.php

`index.php` 内容（简化版）

<?php
// 连接MySQL数据库并查询一条记录
$host = getenv('DB_HOST') ?: 'db_service'; // 注意这里使用的是环境变量或自定义的服务名称作为主机名
$username = 'user';
$password = 'password';
$database = 'mydb';

try {
    $pdo = new PDO("mysql:host=$host;dbname=$database", $username, $password);
    $stmt = $pdo->query("SELECT 'Hello from MySQL!' AS message");
    $row = $stmt->fetch(PDO::FETCH_ASSOC);
    echo $row['message'];
} catch (PDOException $e) {
    die("Could not connect to the database: " . $e->getMessage());
}
?>

`php/Dockerfile` 内容

# 使用官方 PHP 镜像作为基础镜像，包含 PHP-FPM 和 MySQL 扩展
FROM php:7.4-fpm

# 安装 MySQL 扩展
RUN docker-php-ext-install pdo pdo_mysql

# 设置工作目录
WORKDIR /var/www/html

# 将当前目录下的所有文件复制到容器中的 /var/www/html 目录
COPY ../web ./

# 暴露容器的9000端口，用于PHP-FPM通信
EXPOSE 9000

`docker-compose.yml` 内容

version: '3'
services:
  web_service:         # 自定义的服务名称，表示Web服务器
    build: ./php
    volumes:
      - ./web:/var/www/html
    ports:
      - "8080:80"
    networks:
      - my_custom_network
    depends_on:        # 定义对 db_service 的依赖
      - db_service

  db_service:          # 自定义的服务名称，表示数据库
    image: mysql:5.7
    environment:
      MYSQL_ROOT_PASSWORD: example
      MYSQL_DATABASE: mydb
      MYSQL_USER: user
      MYSQL_PASSWORD: password
    volumes:
      - db_data:/var/lib/mysql
    networks:
      - my_custom_network
    healthcheck:       # 添加健康检查以确保数据库准备好
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      timeout: 5s
      retries: 5

networks:
  my_custom_network:

volumes:
  db_data:

在这个例子中，web_service 依赖于 db_service，因此 db_service 会在 web_service 之前启动。此外，为了确保数据库在 Web 服务器尝试连接之前确实已经准备好，我们在 db_service 中添加了一个 healthcheck，这样 Docker Compose 就会等待数据库通过健康检查后再继续启动 web_service。