Symfony应用连接Docker容器化数据库：主机名解析与连接策略

本文探讨Symfony应用在本地运行时，如何正确连接Docker Compose中运行的PostgreSQL数据库。核心问题在于主机名解析失败，因为本地环境无法识别Docker内部服务名称。文章提供了通过修改主机`hosts`文件或采用全容器化方案解决此问题的详细步骤和最佳实践，确保开发环境顺畅运行。

问题剖析：主机名解析失败的根源

当您在本地开发环境中运行Symfony应用，并尝试连接一个通过Docker Compose启动的数据库服务时，可能会遇到类似SQLSTATE[08006] [7] could not translate host name "my_els_db_postgres" to address: Temporary failure in name resolution的错误。这个错误明确指出，您的本地Symfony应用无法将数据库服务的主机名（例如my_els_db_postgres）解析为对应的IP地址。

其根本原因在于：

1. Docker内部网络：Docker Compose会为服务创建一个隔离的内部网络。在这个网络中，各个服务（如database服务，其container_name为my_els_db_postgres）可以通过其服务名或容器名相互通信。
2. 主机环境隔离：您的本地操作系统（运行Symfony应用的环境）位于Docker网络之外。它不了解Docker内部网络中定义的服务名称，因此无法解析my_els_db_postgres这样的主机名。它会尝试通过常规的DNS查询来解析，但由于该名称仅在Docker内部有效，查询会失败。

示例的docker-compose.yml和.env文件展示了这种配置： docker-compose.yml

services:
  database:
    container_name: my_els_db_postgres
    image: postgres:${POSTGRES_VERSION:-13}-alpine
    environment:
      POSTGRES_DB: ${POSTGRES_DB:-app_my_ELS}
      POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-ChangeMe}
      POSTGRES_USER: ${POSTGRES_USER:-symfony}
    volumes:
      - db-data:/var/lib/postgresql/data:rw

.env

DATABASE_URL="postgresql://symfony:ChangeMe@my_els_db_postgres:5432/app_my_ELS?serverVersion=13&charset=utf8"

这里，DATABASE_URL中的my_els_db_postgres正是导致问题的核心。

诊断方法：验证主机名解析

在尝试解决问题之前，您可以从本地终端执行ping命令来验证主机名解析是否失败：

ping my_els_db_postgres

如果出现“未知主机”或“临时名称解析失败”等错误，则确认是主机名解析问题。

解决方案一：通过修改主机hosts文件连接（适用于本地PHP + Docker DB）

这种方法适用于您的Symfony应用运行在本地主机上，而数据库服务运行在Docker容器中的场景。

1. 获取Docker容器的IP地址： 首先，确保您的数据库容器正在运行。然后，使用docker inspect命令获取容器的IP地址。

   docker inspect -f '{{.NetworkSettings.IPAddress}}' my_els_db_postgres

   登录后复制

   或者，如果您想查看更详细的网络信息：

   docker inspect my_els_db_postgres

   登录后复制

   在输出中查找IPAddress字段，它通常位于NetworkSettings.Networks.zuojiankuohaophpcnnetwork_name>.IPAddress路径下。例如，您可能会得到一个像172.17.0.2这样的IP地址。

2. 修改主机的hosts文件： 将获取到的IP地址和数据库容器的主机名添加到您本地操作系统的hosts文件中。

   • Linux/macOS: /etc/hosts
   • Windows: C:\Windows\System32\drivers\etc\hosts

   使用管理员权限打开该文件（例如，在Linux/macOS中使用sudo vim /etc/hosts或sudo nano /etc/hosts），然后添加一行：

   

   千帆大模型平台

   面向企业开发者的一站式大模型开发及服务运行平台

   35

   查看详情

   # 将 <容器IP地址> 替换为实际获取到的IP
   <容器IP地址> my_els_db_postgres

   登录后复制

   例如：

   172.17.0.2 my_els_db_postgres

   登录后复制

   保存并关闭文件。现在，您的本地系统就能够将my_els_db_postgres解析到正确的IP地址了。

3. 注意事项：IP地址的动态性 Docker容器的IP地址在某些情况下可能会发生变化，例如当容器被移除并重新创建，或者Docker网络配置发生改变时。如果IP地址发生变化，您需要重新执行上述步骤来更新hosts文件。对于长期开发，可以考虑为Docker容器配置静态IP，但这会增加配置的复杂性。

解决方案二：采用完全容器化的开发环境（推荐）

对于现代应用开发，将Symfony应用本身也容器化，并与数据库服务一起通过Docker Compose进行管理，是更推荐和更健壮的方案。

1. 优势：

   • 环境一致性：开发、测试和生产环境更加一致，减少“在我机器上可以运行”的问题。
   • 主机名自动解析：当所有服务都在同一个Docker Compose网络中时，它们可以直接通过服务名相互通信，无需修改hosts文件。
   • 依赖隔离：避免本地环境与项目依赖之间的冲突。

2. docker-compose.yml示例（包含Symfony PHP服务）： 您需要在docker-compose.yml中添加一个PHP服务，它将运行您的Symfony应用。

   version: '3.8'
   
   services:
     php:
       build:
         context: .
         dockerfile: Dockerfile.php # 您的PHP Dockerfile
       container_name: my_els_php
       volumes:
         - .:/var/www/html # 将项目代码挂载到容器内
       depends_on:
         - database # 确保PHP服务在数据库服务启动后才启动
       environment:
         DATABASE_URL: "postgresql://symfony:ChangeMe@database:5432/app_my_ELS?serverVersion=13&charset=utf8" # 注意这里使用服务名 'database'
         # 其他Symfony环境变量...
   
     database:
       container_name: my_els_db_postgres
       image: postgres:${POSTGRES_VERSION:-13}-alpine
       environment:
         POSTGRES_DB: ${POSTGRES_DB:-app_my_ELS}
         POSTGRES_PASSWORD: ${POSTGRES_PASSWORD:-ChangeMe}
         POSTGRES_USER: ${POSTGRES_USER:-symfony}
       volumes:
         - db-data:/var/lib/postgresql/data:rw
   
   volumes:
     db-data:

   登录后复制

   关键点：

   • 在PHP服务的environment中，DATABASE_URL现在使用database作为主机名，这是docker-compose.yml中定义的数据库服务的名称。在同一个Docker网络中，服务名即为主机名。
   • 您需要一个Dockerfile.php来构建您的PHP环境。

替代方案：端口映射与localhost

如果您的docker-compose.yml文件将数据库端口映射到了主机上，例如：

services:
  database:
    # ...
    ports:
      - "5432:5432" # 将容器的5432端口映射到主机的5432端口

在这种情况下，您可以直接从本地Symfony应用连接到localhost:5432，而无需修改hosts文件。 您的.env文件将变为：

DATABASE_URL="postgresql://symfony:ChangeMe@127.0.0.1:5432/app_my_ELS?serverVersion=13&charset=utf8"

或

DATABASE_URL="postgresql://symfony:ChangeMe@localhost:5432/app_my_ELS?serverVersion=13&charset=utf8"

这种方法简单直接，但前提是主机上的5432端口没有被其他服务占用。

总结与最佳实践

解决Symfony应用连接Docker容器化数据库的主机名解析问题，主要有以下策略：

1. 修改主机hosts文件：适用于本地Symfony应用连接Docker容器化数据库的场景。需要手动获取容器IP并维护hosts文件，当容器IP变化时需更新。
2. 完全容器化：将Symfony应用也放入Docker容器中，与数据库容器共同通过Docker Compose管理。这是最推荐的方案，提供了环境一致性，并自动解决服务间的主机名解析问题。
3. 端口映射与localhost：如果数据库端口已映射到主机，可以直接通过localhost连接。这是最简单的本地开发连接方式，但可能存在端口冲突问题。

在选择解决方案时，请根据您的项目需求和团队协作模式进行权衡。对于复杂的项目或团队开发，完全容器化是更健壮和可维护的选择。对于简单的本地开发，端口映射结合localhost或修改hosts文件可能更为便捷。

以上就是Symfony应用连接Docker容器化数据库：主机名解析与连接策略的详细内容，更多请关注php中文网其它相关文章！