0x00 描述
宿主机是 mac mini,构建的项目在 docker 中,所以需要在 PHPStorm 上配置 Xdebug 进行远程代码调试。
0x01 环境
宿主机:macOS High Sierra Docker:Docker version -ce, build e68fc7a 容器环境:CentOS Linux release (Core) + PHP + nginx/ + Xdebug PhpStorm:
0x03 下载安装 Xdebug
下载 Xdebug
首先要确定 Xdebug 的版本要和环境中的 PHP 版本相对应。
进入 docker 环境,打印 phpinfo() 的输出页面,或者在命令行输入
php -r "phpinfo();"
得到的结果,全选,复制,把结果粘贴到 https://xdebug.org/wizard.php 的文本框中,查看对应的 Xdebug 版本。
安装Xdebug
把得到的 Xdebug 版本下载到 docker 环境中,按照 https://xdebug.org/wizard.php 的说明进行安装:
Download xdebug-.tgz Unpack the downloaded file with tar -xvzf xdebug-.tgz Run: cd xdebug- Run: phpize (See the FAQ if you don't have phpize. As part of its output it should show: Configuring for: ... Zend Module Api No: Zend Extension Api No: If it does not, you are using the wrong phpize. Please follow this FAQ entry and skip the next step. Run: ./configure Run: make Run: cp modules/xdebug.so /usr/lib64/php/modules Update /etc/php.ini and change the line zend_extension = /usr/lib64/php/modules/xdebug.so
0x04 配置 PHP 与 Xdebug
在 docker 中,根据 phpinfo 的 php.ini 路径,打开 php.ini,加入(编辑)以下代码:
[xdebug] zend_extension=/usr/lib64/php/modules/xdebug.so xdebug.remote_enable= xdebug.remote_handler=dbgp xdebug.remote_mode=req xdebug.remote_host=10.203.17.92 xdebug.remote_port= xdebug.idekey=PHPSTORM xdebug.auto_trace= xdebug.auto_exception_trace= xdebug.remote_autostart= xdebug.collect_vars= xdebug.collect_return= xdebug.collect_params= xdebug.show_local_vars= xdebug.profiler_enable= xdebug.trace_enable_trigger= xdebug.remote_log="/var/log/php.xdebug.log"
有几个地方要注意一下:
1. xdebug.remote_host
这是宿主机的 ip,在 docker 外(mac 环境中),输入命令:
ifconfig
找到 en0 中的 inet:
en0: flags=<UP,BROADCAST,SMART,RUNNING,SIMPLEX,MULTICAST> mtu options=10b<RXCSUM,TXCSUM,VLAN_HWTAGGING,AV> ether :fe:f7:0a::ff inet6 fe80::4f0:bb3b:4a49:d7f9%en0 prefixlen secured scopeid 0x5 inet 10.203.17.92 netmask 0xffffff00 broadcast 10.203.17.255 nd6 options=<PERFORMNUD,DAD> media: autoselect (100baseTX <full-duplex>) status: active
xdebug.remote_host 就是上面例子中的 10.203.17.92
2. xdebug.remote_port
这里默认是 9000 端口,改一下避免和 php-fpm 的 9000 端口冲突
3. xdebug.remote_log
配置一下,方便排错
另外附上 /etc/php.d/xdebug.ini:
[xdebug] ; repeated defind at /etc/php.d/-xdebug.ini file ; zend_extension=/usr/lib64/php/modules/xdebug.so xdebug.remote_enable = on xdebug.remote_host = 10.203.17.92 xdebug.remote_port = xdebug.idekey = "PHPSTORM"
这里和 php.ini 保持一致。
0x05 配置 PHPStorm
1. 进入 preferences
2. 进入 Languages & Frameworks - PHP -Debug ,找到 Xdebug,编辑监听端口和 php.ini 保持一致。
3. 进入 DBGp Proxy,端口和 php.ini 中配置保持一致,配置如下:
4. 进入 Servers,点 “+” 添加一个测试项目,例子中是 admin,Name 随便填写,Host 写项目的域名,端口 80,Debugger 选 Xdebug,勾选下面的路径映射,在右侧填写与本地项目对应的远程目录
5. 保存。
6. 编辑配置,选择 Edit Configurations
添加一个 PHP Web Page,有的版本是 PHP Web Application,是一样的:
填写配置信息:
Server 选择上两步在 Servers 中添加的 Server,这里是 admin,另外 Start URL 选择项目的首页,即使是 https 的 URL,在上述配置端口的地方一样配置成 80:
7. 保存。
8. 调试:
在代码中设置断点(“1”处),打开“2” 处的电话图标,点击“3”处的 debug 选项,会自动跳到浏览器中之前设置的项目首页,当触发到断点时会自动跳到 PHPStorm 中,“4”处可以跳过断点,“5”处显示变量的值:
0x06 安装浏览器 Xdebug 插件
在 google 商店中找到并安装 Xdebug helper,安装之后可以在任意页面启动调试:
以下是 Xdebug helper 的设置页面:
在一些 https 的项目中,PHPStorm -> Preference -> Languages & Frameworks -> PHP -> Servers 处的端口可以配置成 443,但是这个时候通过 PHPStorm 的 Debug 按钮从 Start Url 处开始无法调试,原因是 Xdebug 会把调试的地址认为是 http://xxxx.com:443 而不是 https://xxxx.com,此时就可以用浏览器的 Xdebug helper 插件来直接 debug,选择下拉菜单中的第一个 Debug 选项就可以开始 debug 了。