vmmac镜像_【保姆级教程】Mac+Docker+Phpstrom+Xdebug

一. 环境介绍

MacOS Moiave 10.14

PHPSTROM  2017.3.6

Docker 2.2.0.5

PHP 5.6.4.0(php安装在docker容器中)

Xdebug  2.5.5

二. 安装&配置

(一)、Xdebug安装

     网上关于安装的教程通常都是有一个命令带过&＃xff1b;无奈我的环境一个命令搞不定(个中曲折难以解释)&＃xff0c;用网上常用的方法&＃xff0c;将打印出来的phpinfo复制后粘贴到https://xdebug.org/wizard.php查&＃xff0c;得出来的结果居然是不支持&＃xff0c;正常是会出现对应支持的版本供下载的。

    既然我的匹配不到&＃xff0c;只能另谋它路了&＃xff0c;找到了这个https://xdebug.org/docs/compat#versions 可以结合自己的php版本匹配对应的区间&＃xff1a;

最后选择了2.5的版本&＃xff0c;并在这个历史库里下载  https://xdebug.org/download/historical。

  接下来就是怎么把包整到docker里面了&＃xff1a;

直接 rz 把包上传d到 /usr/src/php/ext&＃xff1b;再解压tar -xf xdebug-2.5.5.tgz&＃xff1b;最后执行安装&＃xff1a;docker-php-ext-install xdebug-2.5.5

安装完成后&＃xff0c;会在 /usr/local/etc/php/conf.d 生成对应的配置文件&＃xff0c;扩展目录也会有对应的扩展文件  xdebug.so &＃xff1a;

至此&＃xff0c;安装完毕&＃xff0c;查看phpinfo可以看到多了xdebug扩展。

PS:如果 rz、sz命令找不到&＃xff1a;执行命令&＃xff1a;apt-get update && apt-get install lrzsz (docker中很多工具都没有&＃xff0c;需要自己根据需要装进去)

(二)、Xdebug配置

我的配置&＃xff1a;zend_extension&＃61;/usr/local/lib/php/extensions/no-debug-non-zts-20131226/xdebug.soxdebug.idekey &＃61; PHPSTROMxdebug.remote_host &＃61; host.docker.internalxdebug.remote_connect_back &＃61; 0xdebug.remote_enable &＃61; 1xdebug.remote_port &＃61; 9001xdebug.remote_handler &＃61; dbgp xdebug.auto_trace &＃61; 1xdebug.remote_mode &＃61; reqxdebug.remote_autostart &＃61; 1xdebug.remote_log &＃61; /tmp/xdebug.log关键配置说明&＃xff1a;xdebug.remote_connect_back &＃61; 1&＃xff1b;//如果开启此&＃xff0c;将忽略 xdebug.remote_host 的参数&＃xff1b;xdebug.remote_host&＃61;192.168.x.x; //客户端的ip; //如果不希望固定IP经常要改&＃xff0c;可以用如下两行&＃xff0c;自动获取主机的地址; xdebug.remote_host &＃61; host.docker.internal; xdebug.remote_connect_back &＃61; 0xdebug.remote_port &＃61; 9001;//注意这里是&＃xff0c;客户端的端口xdebug.remote_log &＃61; /tmp/xdebug.log;//日志一定要写&＃xff0c;不然遇到问题一脸闷逼&＃xff01;&＃xff01;&＃xff01;

PS:其中我还遇到了一个比较坑的问题&＃xff1a;1、docker里面ping不通本地的IP&＃xff0c;容器内部网络问题&＃xff0c;后面把docker客户端重启了就可以了。2、日志文件没生成&＃xff0c;有问题也一头雾水&＃xff0c;后面改了下日志目录(也有可能是第一个网络问题造成的)&＃xff0c;重启容器就正常了。

(三)、PHPSTROM配置

1、为了让IDE也能用到xdebug&＃xff0c;这里的配置非常重要&＃xff0c;必须选用远程docker中的php版本&＃xff1a;

① Phpstrom > prefernents > Languages & Frameworks > PHP&＃xff0c;点击CLI interpreter右侧的...按钮&＃xff0c;如下&＃xff1a;

② 在弹出的CLI解析器对话框中点&＃43;号&＃xff0c;选择“From Docker, Vagrant, VM, Remote...”。

③ 接着单选框选择 Docker&＃xff0c;此时 Server应该是空的&＃xff0c;点New...创建一个Docker连接。

④ Docker名称随便填&＃xff0c;默认是Docker&＃xff0c;然后选择连接Docker的方式&＃xff0c;MAC选Docker for Mac.

⑤ 回到如下的界面&＃xff0c;从下拉列表中选择PHP镜像&＃xff0c;点OK确定。

⑥ 最后的效果如下&＃xff1a;

2、配置debug端口(需要和前面xdeubg的一致)&＃xff1a;

3、配置server&＃xff1a;

4、配置调试选项&＃xff1a;

5、开始debug&＃xff1a;

点击下图右边红框中的小按钮&＃xff0c;打开 Xdebug 监听&＃xff0c;再选择我们要调试的目标&＃xff0c;最后点击那个调试按钮&＃xff0c;就能开启调试之旅。

点击左下角的可以一步步调试&＃xff0c;看看都用到了什么。

三. Xdebug工作原理

1、IDE(如PhpStorm)已经集成了一个遵循BGDP的Xdebug插件&＃xff0c;当开启它的时候&＃xff0c;会在本地开一个Xdebug调试服务&＃xff0c;监听在调试器中所设置的端口上&＃xff0c;默认是9000&＃xff0c;这个服务就会监听所有到9000端口的链接。在PhpStorm中&＃xff0c;位于&＃xff1a;工具栏>Run>Start/Stop Listening for PHP Xdebug Connetions。

2、当浏览器发送一个带 XDEBUG_SESSION_START的参数的请求到服务器时&＃xff0c;服务器接受后将其转到后端的php处理&＃xff0c;如果php开启了xdebug模块&＃xff0c;则会将debug信息转发到客户端IP的IDE的调试端口上。当参数或者COOKIE信息中不带 XDEBUG_SESSION_START则不会启动调试。这就为后续在浏览器中添加开关提供了可能。

Xdebug的官方给出了一个示例图&＃xff1a;很好的展示了相互调用关系。这个示例图是绑定了ip&＃xff0c;即使用了固定ip地址&＃xff0c;xdebug.remote_connect_back &＃61; 0 &＃xff0c;也是 Xdebug 的默认方式&＃xff0c;这种情况下&＃xff0c;Xdebug 在收到调试通知时会读取配置 xdebug.remote_host 和 xdebug.remote_port&＃xff0c;默认是 localhost:9000&＃xff0c;然后向这个端口发送通知&＃xff0c;这种方式只适合单一客户端开发调试。

另外一种方式则是不绑定IP&＃xff0c;Xdebug根据请求来源(REMOTE_HOST)来发起调试。示例图如下&＃xff1a;

那从用户发起请求到&＃xff0c;到IDE的整个流程图如下&＃xff1a;

当用户的请求参数或者COOKIE中不带调试信息&＃xff0c;数据流就是浏览器到Apache(或其他web容器)到PHP&＃xff0c;如果加上了调试参数&＃xff0c;则请求还会由PHP转给Xdebug处理&＃xff0c;Xdebug再把信息转发给IDE&＃xff0c;完成调试功能。

四. 遇到了哪些坑

1、9000端口占用(这个改下配置的端口就行了)

2、Waiting for incoming connection with ide key XXX

    配置完一系列后&＃xff0c;发现不管怎么debug都是这个提示语(一开始没用docker里的php&＃xff0c;配置remote_host用了127.0.0.1)

   上网查了一堆教程&＃xff0c;有的说是xdebug版本不对&＃xff0c;有的说是防火墙问题。

   一波xdebug更换版本重装后发现还是不行&＃xff0c;又是一波百度谷歌&＃xff0c;发现phpstrom用的php需要和远程保持一致&＃xff0c;于是乎改成用docker里的&＃xff0c;这下总可以了吧。

    事实证明想太多&＃xff0c;还是不行。这个时候想起看下日志&＃xff0c;发现居然日志都没写(有配置&＃xff0c;但实际没日志)。一脸疑惑&＃xff0c;配置了为什么没写日志呢&＃xff0c;没日志怎么知道是什么问题&＃xff0c;感觉有点没救了。

    再后来看了下原理&＃xff0c;关于通信的问题&＃xff0c;发现容器居然跟本地不通。项目能直接访问&＃xff0c;网络居然不通&＃xff0c;又是一个疑惑&＃xff0c;也是一通搜索&＃xff0c;重启了docker之后&＃xff0c;网络正常了。接下来想看看日志还是没&＃xff0c;修改了下配置的路径&＃xff0c;再试了debug&＃xff0c;发现日志有了。更大的概率应该是网络解决了这个问题。

     接着开始出现访问很卡的问题&＃xff0c;然后隔一阵子就504了&＃xff0c;好在知道是nignx超时&＃xff0c;改了下&＃xff1a;fastcgi_read_timeout 超时时间&＃xff0c;之后debug就正常了。其他一些小问题已经不是很记得了&＃xff0c;都是看日志搜问题解决的。这其中我也试过关掉本地的防火墙&＃xff0c;最后调通&＃xff0c;开启防火墙&＃xff0c;发现能正常用&＃xff0c;跟防火墙没什么关系。

PS&＃xff1a;参考文献

(排名不分先后&＃xff0c;别问我为什么那么多链接&＃xff0c;因为一堆莫名其妙的问题&＃xff0c;建议大家结合自身情况多看看)

https://www.jianshu.com/p/767ffd64b339

https://www.php.cn/docker/445875.html

https://blog.csdn.net/z457181562/article/details/94719817

https://paper.seebug.org/308/

https://segmentfault.com/a/1190000017482138

https://www.jianshu.com/p/c99867e8e49c

Waiting for incoming connection with ide key 的各种答案&＃xff0c;仅供参考&＃xff0c;重点还是看日志

https://segmentfault.com/q/1010000004027601

https://blog.csdn.net/zhenglu008/article/details/77493660

远程使用docker环境的教程参考

https://www.awaimai.com/2733.html#comment-36462