Xdebug是一个PHP扩展,可以帮助我们PHP开发人员更方便地对PHP代码进行调试;它有许多强大的功能,其中包括:
- 它包含一个用于IDE的单步调试器
- 它升级了PHP的var_dump()函数
- 它为通知,警告,错误和异常添加堆栈跟踪
- 它具有记录每个函数调用和向磁盘分配变量的功能
所以我们可以通过Xdebug结合PHP比较热门的IDE工具PHPstorm对我们的代码进行断点调试,以方便我们分析框架源码,找出bug,分析代码性能瓶颈等等。具体效果如下:
本文将为大家介绍如何在Windows上安装它,以及配置phpstorm,在上面进行断点调试。
一、Xdebug在window上的安装
1,登录官网下载与自己PHP版本相对应的xdebug扩展
注意与安装其他PHP扩展相似,必须下载跟自己PHP版本一致的扩展;所以我们可以把自己的phpinfo的全部内容Ctrl+A全选,Ctrl+C复制到xdebug分析工具(https://xdebug.org/wizard)上面,然后点击分析,就能得到与你PHP版本相对于的xdebug扩展了,直接下载。
2,把下载好的扩展移动到自己的PHP目录下的ext文件夹中
3,修改php配置文件 php.ini,添加如下配置,部分配置可按需增删
;指定Xdebug扩展文件的绝对路径
zend_extension = D:\phpstudy\Extensions\php\php7.3.4nts\ext\php_xdebug-2.9.8-7.3-vc15-nts-x86_64.dll
;启用性能检测分析
xdebug.profiler_enable=On
;启用代码自动跟踪
xdebug.auto_trace=On
;允许收集传递给函数的参数变量
xdebug.collect_params=On
;允许收集函数调用的返回值
xdebug.collect_return=On
;指定堆栈跟踪文件的存放目录
xdebug.trace_output_dir="D:\phpstudy\Extensions\tmp\xdebug"
;指定性能分析文件的存放目录
xdebug.profiler_output_dir="D:\phpstudy\Extensions\tmp\xdebug"
xdebug.profiler_output_name=cachegrind.out.%p
xdebug.remote_enable=On
xdebug.remote_port=19000
xdebug.remote_handler=dbgp
xdebug.remote_host=127.0.0.1
xdebug.var_display_max_depth=10
xdebug.idekey= PHPSTROM
4,重启WebServer(Apache或Nginx等),再次打开phpinfo,Ctrl+F搜索:xdebug,如果搜索到该扩展,则证明安装成功
二、配置phpstorm
1,在【File】->【Settings】->【Languages & Frameworks】->【PHP】的servers中配置xdebug服务,添加如下配置:
2,在【File】->【Settings】->【Languages & Frameworks】->【PHP】->【Debug】中配置 debug port 为php.ini中配置的xdebug.remote_port。
3,打开【run】--【Edit configurations】添加配置:
4,单击行号与代码之间的空白处,即可设置断点。开启debug监听,点击绿色的开始按钮或者旁边的甲壳虫即可开始调试。
5,开始调试后,下方就会展示出调试数据,可以浏览到脚本执行到当前断点时,各个变量的值,对应的代码旁边也有展示各个值,可以清楚知道当前变量的值是什么。点击右下角绿色的继续按钮,即可跳到下一个断点。
到此,Xdebug的安装使用就介绍完了,所谓工欲善其事,必先利其器。它还有其他很多功能帮助我们日常开发调试,例如很多方便的函数,我们直接调用就能得出:
- xdebug_time_index()返回自脚本开始以来的当前时间索引(以秒为单位)。
- xdebug_peak_memory_usage() 返回到目前为止脚本使用的最大内存量。
- xdebug_get_stack_depth() 返回堆栈深度级别。