使用 Docker Compose 和 WordPress 映像设置 Xdebug

Question

我正在尝试使用 docker-compose 设置 Xdebug。我正在使用 PhpStorm IDE，而我正在使用的 Docker 映像安装 PHP 7.2。我正在尝试在此 WordPress 图像的上下文中执行此操作。这是我当前的 docker-compose.yml 文件：

    version: '3'

    services:
   db:
     image: mysql:5.7
     ports: 
       - "3306:3306"
     volumes:
       - db_data:/var/lib/mysql
     restart: always
     environment:
       MYSQL_ROOT_PASSWORD: somewordpress
       MYSQL_DATABASE: wordpress
       MYSQL_USER: wordpress
       MYSQL_PASSWORD: wordpress

   web-build-scripts:
     build: .
     depends_on:
       - db
     ports:
       - "8028:80"
       - "8029:8029"

     volumes:
       - ./themes/XXXXX:/var/www/html/wp-content/themes/XXXX
       - ./plugins/XXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX
       - ./plugins/XXXXX:/var/www/html/wp-content/plugins/XXXXX


     restart: always
     environment:
       WORDPRESS_DB_HOST: db:3306
       WORDPRESS_DB_USER: wordpress
       WORDPRESS_DB_PASSWORD: wordpress
       VIRTUAL_HOST: leasepilot.local

volumes:
    db_data:

然后我标记为 web-build-scripts（当然是构建的）的 Dockerfile 看起来像这样：

FROM wordpress:latest

WORKDIR /var/www/html
RUN pecl install xdebug-2.6.0 \
    && docker-php-ext-enable xdebug \
    && apt-get update \
    && apt-get install nano \
    && export TERM=xterm

COPY Search-Replace-DB/ ./wp-content/Search-Replace-DB/
COPY uploads/ ./wp-content/uploads/
COPY ./docker-config/xdebug.ini ../../../usr/local/etc/php/conf.d/xdebug.ini

本地 docker-config 目录中的 xdebug.ini 文件如下所示：

zend_extension=xdebug.so
xdebug.default_enable=1
xdebug.remote_autostart=1
xdebug.remote_connect_back=0
xdebug.remote_port=9001
xdebug.remote_enable=1
xdebug.idekey=PHPSTR
xdebug.remote_host = docker.for.mac.internal

在 PHPStorm 中，我设置了调试设置，如下所示： 我已经像这样设置了服务器映射：

我还将调试端口设置为 9001，就像我在 xdebug.ini 文件中所做的那样：

当我运行命令 php -ini | grep xdebug 我的输出如下：

root@a96543427809:/var/www/html# php -ini | grep xdebug
Cannot load Xdebug - it was already loaded
/usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini,
/usr/local/etc/php/conf.d/xdebug.ini
xdebug
xdebug support => enabled
xdebug.auto_trace => Off => Off
xdebug.cli_color => 0 => 0
xdebug.collect_assignments => Off => Off
xdebug.collect_includes => On => On
xdebug.collect_params => 0 => 0
xdebug.collect_return => Off => Off
xdebug.collect_vars => Off => Off
xdebug.coverage_enable => On => On
xdebug.default_enable => On => On
xdebug.dump.COOKIE => no value => no value
xdebug.dump.ENV => no value => no value
xdebug.dump.FILES => no value => no value
xdebug.dump.GET => no value => no value
xdebug.dump.POST => no value => no value
xdebug.dump.REQUEST => no value => no value
xdebug.dump.SERVER => no value => no value
xdebug.dump.SESSION => no value => no value
xdebug.dump_globals => On => On
xdebug.dump_once => On => On
xdebug.dump_undefined => Off => Off
xdebug.extended_info => On => On
xdebug.file_link_format => no value => no value
xdebug.filename_format => no value => no value
xdebug.force_display_errors => Off => Off
xdebug.force_error_reporting => 0 => 0
xdebug.gc_stats_enable => Off => Off
xdebug.gc_stats_output_dir => /tmp => /tmp
xdebug.gc_stats_output_name => gcstats.%p => gcstats.%p
xdebug.halt_level => 0 => 0
xdebug.idekey => PHPSTR => PHPSTR
xdebug.max_nesting_level => 256 => 256
xdebug.max_stack_frames => -1 => -1
xdebug.overload_var_dump => 2 => 2
xdebug.profiler_aggregate => Off => Off
xdebug.profiler_append => Off => Off
xdebug.profiler_enable => Off => Off
xdebug.profiler_enable_trigger => Off => Off
xdebug.profiler_enable_trigger_value => no value => no value
xdebug.profiler_output_dir => /tmp => /tmp
xdebug.profiler_output_name => cachegrind.out.%p => cachegrind.out.%p
xdebug.remote_addr_header => no value => no value
xdebug.remote_autostart => On => On
xdebug.remote_connect_back => Off => Off
xdebug.remote_cookie_expire_time => 3600 => 3600
xdebug.remote_enable => On => On
xdebug.remote_handler => dbgp => dbgp
xdebug.remote_host => docker.for.mac.internal => docker.for.mac.internal
xdebug.remote_log => no value => no value
xdebug.remote_mode => req => req
xdebug.remote_port => 9001 => 9001
xdebug.remote_timeout => 200 => 200
xdebug.scream => Off => Off
xdebug.show_error_trace => Off => Off
xdebug.show_exception_trace => Off => Off
xdebug.show_local_vars => Off => Off
xdebug.show_mem_delta => Off => Off
xdebug.trace_enable_trigger => Off => Off
xdebug.trace_enable_trigger_value => no value => no value
xdebug.trace_format => 0 => 0
xdebug.trace_options => 0 => 0
xdebug.trace_output_dir => /tmp => /tmp
xdebug.trace_output_name => trace.%c => trace.%c
xdebug.var_display_max_children => 128 => 128
xdebug.var_display_max_data => 512 => 512
xdebug.var_display_max_depth => 3 => 3

我已经阅读了几个教程，但无法弄清楚这一点。有人有什么见解可以帮助我吗？

Answer 1

我会做什么

• 首先你使用wordpress:latest所以你必须找到哪个php 您的 wordpress 图像正在运行的版本。
• 然后检查xdebug是否安装在容器中。很可能不会！
• 创建一个带有xdebug 安装的Dockerfile 用于开发，不要将它用于生产，它会降低您的性能。
• 从 Dockerfile 构建 your-wordpress 图像。
• 您可能需要使用您的远程主机详细信息创建xdebug.ini 文件，我正在使用phpstrom 这就是我的xdebug.ini 的样子。我将此文件保存在我的主机中并使用volumes 复制它。

zend_extension=xdebug.so
xdebug.remote_enable=1
xdebug.remote_handler=dbgp
xdebug.remote_port=10000 # dont use 9000 its usually used by the php-fpm
xdebug.remote_autostart=1
xdebug.remote_connect_back=0
xdebug.idekey=PHPSTRM
xdebug.remote_host=host-ip-here

这就是我的 docker-compose 文件的样子

version: '2'
services:
    my-service:
        build:
          context: ./dev
          dockerfile: Dockerfile
        ports:
            - "8080:80"
        restart: always
        environment:
            - RUNTIME_ENVIRONMENT=local
        working_dir: /src
        volumes:
            - ./src:/src
            - ./php-ini-overrides-dev.ini/xdebug.ini:/etc/php/7.1/mods-available/xdebug.ini

• 然后用xdebug.ini详细配置phpstorm远程调试。
• 要确保加载了 xdebug 配置，请登录到容器并运行 php -ini | grep xdebug
• 这是获得xdebug 工作的一种方式。
• 如果启用 xdebug 日志不起作用，请将 xdebug.remote_log=/log_path/xdebug.log 添加到 xdebug.ini 将有助于诊断问题。
• 如果您在设置 phpstorm 远程调试方面也需要帮助，请告诉我。其实那里有很多资源。

Answer 2

@david-jarrin，

查看您的php -ini 输出，您的XDebug 似乎已经在运行。它可以安装（和激活）一个从不版本，版本 3.x 而不是您指定的 2.x 吗？这就是我的悲痛之处。

请注意，XDebug 版本 3 引入了大量不向后兼容的配置名称更改。有一个upgrade guide 可用。您会发现各种配置键已更改，包括从 Docker 容器运行 XDebug 至关重要的配置键。

我和你一样使用官方的 Wordpress Docker 镜像，我花了一段时间才弄清楚为什么突然 xdebug.remote_host 不再工作，以及为什么我的日志没有显示。这一切都在升级指南中。

这是一个对我有用的基本配置，当使用带有felixbecker's XDebug extension 的 VS Code 时。

您可以在 Dockerfile 中包含 xdebug 安装。这实际上在 Wordpress 容器正在使用的 php 容器中运行了一个自定义函数，docker-php-ext-enable。使用 Dockerfile 构建支持 XDebug 的 Wordpress 容器版本：

FROM wordpress:latest

RUN pecl install "xdebug" \
    && docker-php-ext-enable xdebug

在相对于您的 docker-compose.yml 文件的文件夹中创建一个 xdebug.ini 文件，例如 ./conf/xdebug.ini：

xdebug.client_host=host.docker.internal
xdebug.client_port=9000
xdebug.mode=debug
xdebug.log_level=7
xdebug.log="/tmp/xdebug.log"
xdebug.idekey=sts-debug
xdebug.max_nesting_level=1500
xdebug.connect_timeout_ms=60000

在docker-compose.yml 文件中注入这样的 xdebug 配置更加灵活，这样您就不必每次更改 xdebug 配置时都​​重新构建映像。

wordpress:
    build: .
    depends_on:
      - db
    image: custom-wordpress:latest
    ports:
      - '8000:80'
    restart: unless-stopped
    volumes:
      - './:/var/www/html'
      - ./conf/xdebug.ini:/usr/local/etc/php/conf.d/xdebug.ini

旅途愉快！