Docker Compose 中 Spring Boot 应用连接 MySQL 数据库失败怎么办？

2024-07-18 19:29:37

Docker Compose 中 Spring Boot 应用连接 MySQL 数据库失败？这里有解！

在使用 Docker Compose orchestrate Spring Boot 应用和 MySQL 数据库时，你也许遇到过应用无法连接数据库的困境，错误信息通常是恼人的 "Communications link failure"。别担心，本文将带你分析这个问题的常见原因，并提供详细的解决方案和代码示例，帮你快速解决这个拦路虎。

问题根源解析

"Communications link failure" 错误信息表明 Spring Boot 应用无法与 MySQL 数据库建立连接。导致这个问题的常见原因有以下几个：

数据库服务启动慢于应用: Spring Boot 应用启动速度可能快于 MySQL 数据库，导致应用尝试连接时，数据库服务还未完全就绪。
网络配置迷宫: Docker Compose 网络配置如果存在问题，可能会导致 Spring Boot 应用无法访问数据库容器。
数据库连接信息不匹配: Spring Boot 应用中配置的数据库连接信息 (URL, 用户名, 密码) 如果与 MySQL 容器中的设置不匹配，连接尝试自然会失败。

逐个击破解决方案

1. 确保数据库服务完全启动后再启动应用

我们可以利用 docker-compose.yml 文件中的 depends_on 和 condition 指令，确保 Spring Boot 应用在数据库服务完全启动并准备好接受连接后再启动。

version: '1'
services:
  mysqldb:
    # ... (其他配置)
    healthcheck:
      test: ["CMD", "mysqladmin" ,"ping", "-h", "localhost", "-u", "$MYSQL_USER", "--password=$MYSQL_PASSWORD"]
      interval: 2s
      timeout: 2s
      retries: 10
      start_period: 40s
  springapp:
    # ... (其他配置)
    depends_on:
      mysqldb:
        condition: service_healthy

代码解读:

healthcheck 指令为数据库服务定义了健康检查机制，通过周期性执行 mysqladmin ping 命令确认数据库是否可以连接。
condition: service_healthy 确保 Spring Boot 应用 (springapp) 只有在数据库服务 (mysqldb) 通过健康检查，确认可以接受连接后才会启动。

2. 检查网络配置，确保畅通无阻

Spring Boot 应用和 MySQL 数据库必须位于同一个 Docker 网络中，并且能够使用容器名称相互访问，才能顺利建立连接。

在 docker-compose.yml 文件中，确认两个服务都在 devNetwork 网络中：

services:
  mysqldb:
    # ...
    networks:
      - devNetwork
  springapp:
    # ...
    networks:
      - devNetwork

networks:
  devNetwork:
    driver: bridge

代码解读:

mysqldb 和 springapp 服务都加入了名为 devNetwork 的 Docker bridge 网络，确保它们在同一个网络中。
在 springapp 服务的配置中，MYSQL_URL 使用了容器名称 mysqldb 来访问数据库容器，确保网络路径畅通。

3. 验证数据库连接信息，确保完全一致

仔细检查 Spring Boot 应用中配置的数据库连接信息 (URL, 用户名, 密码) 是否与 docker-compose.yml 和 database.Dockerfile 中设置的一致，任何细微的不一致都会导致连接失败。

Spring Boot 应用 (Dockerfile):

ENV MYSQL_URL=jdbc:mysql://mysqldb:3306/task_base?serverTimezone=UTC
ENV MYSQL_USER=root
ENV MYSQL_PASSWORD=mysql@sit

docker-compose.yml:

services:
  springapp:
    # ...
    environment:
      - MYSQL_URL=jdbc:mysql://mysqldb:3306/task_base?serverTimezone=UTC
      - MYSQL_USER=root
      - MYSQL_PASSWORD=mysql@sit

database.Dockerfile:

ENV  MYSQL_ROOT_PASSWORD=mysql@sit

特别注意:

MYSQL_PASSWORD 在 Spring Boot 应用和 docker-compose.yml 中必须完全一致，任何细微差别都会导致连接失败。
MYSQL_ROOT_PASSWORD 在 database.Dockerfile 中定义了 MySQL root 用户的密码，也需要与其他地方保持一致。

总结

通过以上步骤，你应该能够解决 Docker Compose 中 Spring Boot 应用无法连接 MySQL 数据库的问题，让你的应用顺利连接数据库。

常见问题解答

问: 我已经按照步骤操作了，但还是无法连接数据库，怎么办？

答: 首先，仔细检查你的 docker-compose.yml、Dockerfile 和应用配置文件，确保所有配置信息完全一致。其次，查看 Docker 容器的日志，特别是 springapp 和 mysqldb 容器的日志，寻找任何错误信息，这些信息通常能提供更详细的线索。
问: healthcheck 指令有什么作用？

答: healthcheck 指令用于定义容器的健康检查机制。在本例中，我们使用 mysqladmin ping 命令来检查 MySQL 数据库是否可以连接。这样可以确保 Spring Boot 应用只在数据库服务完全启动并准备好接受连接后才会启动。
问: 我应该如何选择 Docker 网络驱动？

答: Docker 提供了多种网络驱动，例如 bridge、overlay 和 host。bridge 网络驱动是最常用的驱动，它为每个 Docker 网络创建一个隔离的网络。如果你的应用程序需要与宿主机上的其他服务通信，可以使用 host 网络驱动。overlay 网络驱动用于跨多个宿主机创建 Docker 网络。

问: 我应该如何保护我的数据库密码？

答: 不要在 docker-compose.yml 或 Dockerfile 文件中直接存储数据库密码。可以使用 Docker Secrets 或其他密钥管理工具来安全地存储和管理敏感信息。
问: 还有其他方法可以解决 Spring Boot 应用无法连接数据库的问题吗？

答: 是的，还有其他一些方法可以尝试，例如：
- 使用 docker exec 命令进入 springapp 容器，然后尝试使用 ping 命令测试与 mysqldb 容器的网络连接。
- 使用 telnet 命令测试从 springapp 容器到 mysqldb 容器的 3306 端口是否可访问。
- 使用数据库客户端工具（如 Dbeaver 或 DataGrip）尝试从你的机器连接到 mysqldb 容器，以排除数据库配置问题。