Docker容器中Spring应用连接MySQL数据库的教程

本文旨在解决spring boot应用在docker容器中无法连接同compose网络下mysql数据库的问题。核心在于理解docker容器间通信机制，明确在compose网络中应使用服务名称而非`localhost`作为数据库主机地址。通过修改`spring_datasource_url`配置，确保spring应用能够正确识别并连接到mysql服务。

在Docker化的应用部署中，将Spring Boot服务与MySQL数据库部署在独立的容器中是常见的实践。然而，开发者常常会遇到Spring应用无法连接到MySQL数据库的问题，尤其是在使用localhost作为数据库主机地址时。本教程将深入探讨这一问题的原因，并提供一个清晰的解决方案。

理解Docker容器间网络通信

当您在docker-compose.yml文件中定义多个服务（如sample-service和mysqldb）并将其置于同一个自定义网络（如spring-mysql）中时，Docker Compose会自动为这些服务创建一个内部DNS解析机制。在这个网络内部，每个服务都可以通过其在docker-compose.yml中定义的服务名称来相互访问。

问题根源：localhost的误用

在Spring应用的配置文件中，如果将数据库连接URL设置为jdbc:mysql://localhost:3306/...，那么当Spring应用运行在其Docker容器内部时，localhost会解析为该Spring应用容器自身的环回地址。这意味着Spring应用会尝试连接到其自身容器内部的3306端口，而不是运行MySQL数据库的另一个容器。由于Spring应用容器内部没有MySQL服务运行在3306端口，连接自然会失败，导致Communications link failure等错误。

解决方案：使用服务名称进行通信

要解决这个问题，Spring应用需要知道MySQL数据库服务在Docker网络中的“名字”。这个名字就是您在docker-compose.yml中为MySQL服务定义的服务名称。在提供的示例中，MySQL服务的名称是mysqldb。

因此，正确的数据库连接URL应该将localhost替换为MySQL服务的名称mysqldb。

AppMall应用商店

AI应用商店，提供即时交付、按需付费的人工智能应用服务

56

查看详情

示例配置与修正

以下是原始的docker-compose.yml配置片段，其中SPRING_DATASOURCE_URL配置不正确：

version: "3"
services:
  sample-service:
    image: v2stechit/sample-service
    ports:
        - "8080:8080"                      
    restart: always                            
    environment:
        # 错误：localhost指向Spring应用自身容器
        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:

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

version: "3"
services:
  sample-service:
    image: v2stechit/sample-service
    ports:
        - "8080:8080"                      
    restart: always                            
    environment:
        # 正确：使用MySQL服务的名称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:
    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:

通过将SPRING_DATASOURCE_URL中的localhost修改为mysqldb，Spring应用在启动时将能够通过Docker Compose提供的内部DNS解析，找到并连接到运行MySQL数据库的容器。

注意事项与最佳实践

1. 服务名称的准确性： 确保SPRING_DATASOURCE_URL中使用的数据库主机名与docker-compose.yml中MySQL服务的名称完全一致（区分大小写）。
2. 网络配置： 确保所有需要相互通信的服务都位于同一个Docker网络中。在docker-compose.yml中，这通常通过在services和顶层networks部分定义和引用网络来完成。
3. depends_on： depends_on指令虽然不保证数据库完全启动并准备好接受连接，但它确保了mysqldb服务会在sample-service服务启动之前开始创建。对于生产环境，可能需要更健壮的健康检查机制。
4. 环境变量： 使用环境变量来配置数据库连接信息是最佳实践，因为它允许在不修改镜像的情况下轻松更改配置。
5. 端口映射： 尽管在docker-compose.yml中为mysqldb服务配置了ports: - "3306:3306"，这仅表示将容器内部的3306端口映射到宿主机的3306端口，以便您可以从宿主机访问MySQL。对于容器间的通信，并不依赖于这个端口映射，而是直接通过内部网络和端口进行。

总结

在Docker Compose环境中，Spring应用连接MySQL数据库的关键在于正确配置数据库连接URL。核心原则是：在同一个Docker Compose网络中，容器应通过服务的名称而非localhost来相互访问。 理解这一机制，将有助于您构建更健壮、可维护的Docker化应用。遵循上述指南，您的Spring应用将能够顺利连接到Docker容器中的MySQL数据库。

以上就是Docker容器中Spring应用连接MySQL数据库的教程的详细内容，更多请关注php中文网其它相关文章！