解决Docker中Spring Boot应用连接MySQL数据库的常见问题

本文旨在解决Spring Boot应用在Docker容器中无法连接到同Docker网络内MySQL数据库的问题。核心在于理解Docker容器网络中服务发现机制，并正确配置数据库连接URL，将`localhost`替换为MySQL服务的名称，以确保应用能够通过内部网络地址成功解析并连接数据库服务。

Docker环境下Spring Boot应用连接MySQL数据库教程

在Docker化的应用部署中，Spring Boot应用与MySQL数据库通常会部署在各自的容器中，并通过Docker网络进行通信。然而，开发者常遇到Spring Boot应用无法连接到MySQL数据库的问题。本教程将深入分析这一问题的原因，并提供详细的解决方案。

1. 问题背景分析

当Spring Boot应用和MySQL数据库都运行在Docker容器中，并且通过docker-compose进行编排时，如果Spring Boot应用的数据库连接URL中使用了localhost作为数据库主机名，便会导致连接失败。这是因为在Docker网络环境中，每个容器都有自己的localhost，它指向的是该容器自身，而非宿主机或其他容器。因此，Spring Boot容器中的localhost:3306无法解析到运行MySQL数据库的另一个容器。

从提供的日志中可以看出，MySQL容器已成功启动并监听3306端口：

2022-11-30T05:18:02.251175Z 0 [System] [MY-010931] [Server] /usr/sbin/mysqld: ready for connections. Version: '8.0.29'  socket: '/var/run/mysqld/mysqld.sock'  port: 3306  MySQL Community Server - GPL.

而Spring Boot应用的日志则会显示连接超时或无法找到主机，这进一步证实了是连接地址配置的问题。

2. Docker Compose中的服务发现机制

Docker Compose为多容器应用提供了一种内置的服务发现机制。在同一个docker-compose.yml文件中定义的服务，它们会自动加入到同一个默认网络（或用户自定义网络）中，并且可以通过服务名称互相访问。这意味着，一个服务可以通过另一个服务的名称作为主机名来解析其IP地址。

先见AI

数据为基，先见未见

95

查看详情

3. 解决方案：使用服务名称作为主机名

解决Spring Boot应用无法连接MySQL数据库问题的关键在于，将数据库连接URL中的localhost替换为MySQL服务的名称。

3.1 原始的docker-compose.yml配置

以下是最初的docker-compose.yml配置片段，其中SPRING_DATASOURCE_URL使用了localhost：

version: "3"
services:
  sample-service:
    image: v2stechit/sample-service
    ports:
        - "8080:8080"                      
    restart: always                            
    environment:
        SPRING_DATASOURCE_URL: jdbc:mysql://localhost:3306/buddyto_mstr_local?useSSL=false # 问题所在
        SPRING_DATASOURCE_USERNAME: root
        SPRING_DATASOURCE_PASSWORD: root
    networks:
      - spring-mysql
    depends_on:
      - mysqldb

  mysqldb:
    image: mysql:8.0.29
    networks:
      - spring-mysql
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=buddyto_mstr_local
      - MYSQL_USERNAME=root
      - MYSQL_PASSWORD=root
    ports:
      - 3306:3306
networks:
  spring-mysql:

3.2 修正后的docker-compose.yml配置

根据Docker Compose的服务发现规则，MySQL服务的名称在docker-compose.yml中被定义为mysqldb。因此，在Spring Boot应用的SPRING_DATASOURCE_URL中，应将localhost替换为mysqldb。

version: "3"
services:
  sample-service:
    image: v2stechit/sample-service
    ports:
        - "8080:8080"                      
    restart: always                            
    environment:
        # 修正后的数据库连接URL，使用服务名称 'mysqldb'
        SPRING_DATASOURCE_URL: jdbc:mysql://mysqldb:3306/buddyto_mstr_local?useSSL=false
        SPRING_DATASOURCE_USERNAME: root
        SPRING_DATASOURCE_PASSWORD: root
    networks:
      - spring-mysql
    depends_on:
      - mysqldb # 确保 mysqldb 服务在 sample-service 之前启动

  mysqldb:
    image: mysql:8.0.29
    networks:
      - spring-mysql
    environment:
      - MYSQL_ROOT_PASSWORD=root
      - MYSQL_DATABASE=buddyto_mstr_local
      - MYSQL_USERNAME=root
      - MYSQL_PASSWORD=root
    ports:
      - 3306:3306
networks:
  spring-mysql:

通过上述修改，当sample-service容器尝试连接mysqldb:3306时，Docker Compose的网络DNS服务会自动将mysqldb解析为mysqldb容器的内部IP地址，从而建立正确的连接。

4. 其他注意事项

• 网络配置： 确保所有需要通信的服务都位于同一个Docker网络中。在上述示例中，spring-mysql网络被正确地定义和分配给了sample-service和mysqldb。
• depends_on： depends_on指令虽然不能保证服务的完全就绪（例如数据库完全初始化并准备好接受连接），但它确保了服务启动的顺序。在大多数情况下，这足以让Spring Boot应用在MySQL容器启动后尝试连接。对于生产环境或更复杂的场景，可能需要实现更健壮的重试机制。
• 端口映射： 数据库容器的ports配置（如3306:3306）是将容器内部的3306端口映射到宿主机的3306端口。这对于容器间通信不是必需的，但允许宿主机或其他外部客户端直接访问数据库。在容器内部，服务之间直接通过内部端口通信，无需通过宿主机映射端口。
• IP地址访问（不推荐）： 虽然也可以尝试使用Docker宿主机的IP地址来连接MySQL，但这会破坏Docker Compose的隔离性和可移植性。当容器在不同宿主机上运行时，IP地址可能会发生变化，导致配置失效。因此，强烈建议使用服务名称进行容器间通信。

5. 总结

在Docker Compose环境中，Spring Boot应用连接MySQL数据库的核心原则是利用Docker内置的服务发现机制。通过将数据库连接URL中的localhost替换为MySQL服务的名称（例如mysqldb），可以确保应用能够正确解析并连接到数据库容器，从而实现稳定可靠的容器化部署。遵循这些最佳实践将有助于避免常见的连接问题，并构建健壮的微服务架构。

以上就是解决Docker中Spring Boot应用连接MySQL数据库的常见问题的详细内容，更多请关注php中文网其它相关文章！