如何将 VSCode 连接到 Docker 容器内的 xdebug 3？

Question

你好，程序员们！

我正在使用带有 wsl2 的 Win 10。尝试使用 Docker for Windows 以现代方式构建开发环境。我正在使用 nginx、php:fpm、mariadb、adminer。一切正常，除了调试器。我就是不明白为什么。我什至从我的本地机器上看到它！

PS D:\Projects\php-docker\dev> tnc host.docker.internal -p 9003

ComputerName     : host.docker.internal
RemoteAddress    : 192.168.0.5
RemotePort       : 9003
InterfaceAlias   : Ethernet
SourceAddress    : 192.168.0.5
TcpTestSucceeded : True

我加入了 php 容器，看到 XDebuger 似乎安装正确

kds@matrix:/mnt/d/Projects/php-docker/dev$ docker ps
CONTAINER ID   IMAGE            COMMAND                  CREATED          STATUS          PORTS                                       NAMES
8923a772e4d9   nginx            "/docker-entrypoint.…"   58 minutes ago   Up 34 minutes   0.0.0.0:80->80/tcp, :::80->80/tcp           dev_web_1
2aa7df39190d   dev_php          "docker-php-entrypoi…"   58 minutes ago   Up 34 minutes   9000/tcp                                    dev_php_1
efa5a9175c3b   adminer:latest   "entrypoint.sh docke…"   21 hours ago     Up 34 minutes   0.0.0.0:8080->8080/tcp, :::8080->8080/tcp   dev_adminer_1
e6c6a046712e   mariadb          "docker-entrypoint.s…"   21 hours ago     Up 34 minutes   0.0.0.0:3306->3306/tcp, :::3306->3306/tcp   dev_mysql_1
kds@matrix:/mnt/d/Projects/php-docker/dev$ docker exec -it dev_php_1 bash
root@2aa7df39190d:/var/www/html# php -v
PHP 8.0.6 (cli) (built: May  7 2021 20:37:21) ( NTS )
Copyright (c) The PHP Group
Zend Engine v4.0.6, Copyright (c) Zend Technologies
    with Xdebug v3.0.4, Copyright (c) 2002-2021, by Derick Rethans

docker-compose.yml

version: '3'
services:
    web:
        image: nginx
        restart: always
        ports:
            - "80:80"
        volumes:
            - ./nginx.conf:/etc/nginx/conf.d/nginx.conf
            - ./app:/www/app
    php:
        build:
            context: .
            dockerfile: PHP_Dockerfile
        volumes: 
            - ./app:/www/app
            - ./logs/xdebug:/logs/xdebug
        environment: 
            XDEBUG_CONFIG: "mode=debug
                            start_with_request=yes
                            client_host=host.docker.internal
                            client_port=9003"
    mysql:
        image: mariadb
        restart: always
        environment:
            MYSQL_ROOT_PASSWORD: 'secret'
            MYSQL_USER: 'db_user'
            MYSQL_PASSWORD: 'secret'
            MYSQL_DATABASE: 'test'
        volumes:
            - mysqldata:/var/lib/mysql
        ports:
            - 3306:3306
    adminer:
        image: adminer:latest
        restart: always
        environment:
            ADMINER_DESIGN: ng9
            ADMINER_DEFAULT_SERVER: mysql
        ports: 
            - 8080:8080
volumes:
    mysqldata: {}

PHP_Dockerfile

FROM php:fpm

RUN docker-php-ext-install pdo pdo_mysql \
    && pecl install xdebug \
    && docker-php-ext-enable xdebug

app\public\index.php

<?php
    xdebug_info();

VS 代码 launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for Xdebug",
            "type": "php",
            "request": "launch",
            "port": 9003,
            "stopOnEntry": true,
            "log": true,
            "pathMappings": {
                "/www/app": "${workspaceFolder}/app"
            },
        },
    ]
}

...---...

问题已解决！ Helpful instruction on Github

添加了xdebug.ini

[XDebug]
zend_extension=xdebug.so

xdebug.mode = debug
xdebug.start_with_request=yes

#Replace host.docker.internal to your computers IP address if linux
xdebug.client_host=host.docker.internal

新docker-compose.yml

version: '3'
services:
    web:
        image: nginx
        restart: always
        ports:
            - "80:80"
        volumes:
            - ./nginx.conf:/etc/nginx/conf.d/nginx.conf
            - ./app:/www/app
    php:
        build:
            context: .
            dockerfile: PHP_Dockerfile
        volumes: 
            - ./app:/www/app
            - ./xdebug.ini:/usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
        environment: 
            PHP_IDE_CONFIG: "serverName=docker-test"
    mysql:
        image: mariadb
        restart: always
        environment:
            MYSQL_ROOT_PASSWORD: 'secret'
            MYSQL_USER: 'db_user'
            MYSQL_PASSWORD: 'secret'
            MYSQL_DATABASE: 'test'
        volumes:
            - mysqldata:/var/lib/mysql
        ports:
            - 3306:3306
    adminer:
        image: adminer:latest
        restart: always
        environment:
            ADMINER_DESIGN: ng9
            ADMINER_DEFAULT_SERVER: mysql
        ports: 
            - 8080:8080
volumes:
    mysqldata: {}

Answer 1

这一切看起来不错，除了 XDEBUG_CONFIG: "mode=debug start_with_request=yes" — 您不能通过 XDEBUG_CONFIG 设置这些。

您可以使用XDEBUG_MODE=debug作为环境变量来设置模式，但是xdebug.start_with_request值只能在ini文件中设置。

如果将 xdebug_info() 的输出放入要调试的 PHP 脚本中，它的输出会显示什么？

Answer 2

对于升级到 xdebug 3 后来到这里的任何人，请注意这里有一个重要的变化。该值在 xdebug 3 中被重命名：

x 调试 2：xdebug.remote_host

x 调试 3：xdebug.client_host

https://xdebug.org/docs/upgrade_guide#changed-xdebug.remote_host

因此您需要在 php.ini

中重命名该值

如何将 VSCode 连接到 Docker 容器内的 xdebug 3？

How to connect VSCode to xdebug 3 inside Docker container?

php

xdebug

docker

docker-compose

visual-studio-code