Xdebug 的工作原理及在 phpstorm 下的配置

Xdebug 使用可以很简单，在不需要考虑过多场景的情况下只需要，简单配置三项就可以开启单步调试之旅啦。

xdebug 工作的原理图

xdebug 版本和 php 版本的对应关系

php.ini 中的配置 xdebug 3 的版本

zend_extension=debug
[Xdebug]
;开启有这个模式开启则不需要过多的配置即可调试
xdebug.mode = debug
;任意请求都开启
xdebug.start_with_request = true
;IDE中开的端口 本地默认不用配置
xdebug.client_port = 9000
;IDE所在的IP地址 本地默认不用配置
xdebug.client_host=127.0.0.1

php.ini 中的配置 xdebug 2.X 的版本

[Xdebug]
xdebug.remote_enable = On
;任意请求都开启
xdebug.remote_autostart = 1
;IDE中开的端口 本地默认不用配置
xdebug.remote_port = 9000
;IDE所在的IP地址 本地默认不用配置
xdebug.remote_host=127.0.0.1

phpstorm 中的配置

远程调试

phpstorm 建一个远程调试配置

2.服务器进行如下配置

[xdebug]
xdebug.mode = debug
;只有在 $_GET $_POST $_COOKIES 中携带 XDEBUG_SESSION 参数才开启，参数值为phpstorm中填的idekey,
xdebug.start_with_request = trigger
;IDE中开的端口 本地默认不用配置
xdebug.client_port = 9000
;IDE所在的IP地址 本地默认不用配置
xdebug.client_host=127.0.0.1
xdebug.idekey="coderzhouyu"
xdebug.log = /www/server/php/80/xdebug.log

3.用 ssh 远程对本地隧道打通网络（用其他工具也是一样的只要能实现数据包转发到本地的 BGDP，自己手搓一个也不是不可以）

# -R 意思是远程的端口链接到本地的端口 对应的有-L
# 本地端口9000 映射 到远程 127.0.0.1:9000  通过 root@xxx.xxx.xxx.xxx
# 这样服务器的xdebug访问9000端口时，访问会转发到咱们本地的9000来，也就是上面配置的BGDP端口
ssh -R 9000:127.0.0.1:9000 -p 22000 root@xxx.xxx.xxx.xxx

在 docker 中配置 xdebug

## 安装 Xdebug
RUN curl -fsSL https://xdebug.org/files/xdebug-3.1.6.tgz -o xdebug.tgz \
    && pecl install xdebug.tgz && docker-php-ext-enable xdebug
#
## 配置 Xdebug
RUN echo "xdebug.mode=debug" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
RUN echo "xdebug.client_host = host.docker.internal" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
RUN echo "xdebug.client_port = 9000" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
RUN echo "xdebug.start_with_request = true" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini

添加 PHP_IDE_CONFIG 环境变量

这个环境变量是用来告诉 xdebug 连接的 ide 的哪个服务，这个服务就是 phpstorm 的服务名，这个服务名是在 phpstorm 的配置中设置的，如下图所示：

PHP_IDE_CONFIG="serverName=phpstorm"

添加完成后，重启容器，即可在 phpstorm 中进行远程调试。如果此时没有配置远程调试，那么在 phpstorm 中会提示你配置远程调试。按照提示配置即可。

相关文章