xdebug调试PHP程序的学习笔记

xdebug是一款常用来调试php程序的一个性能的工具,下面本文章介绍在lnmp系统安装配置xdebug与最后简单调试方法,还有在调试过程碰到一些问题解决办法.

xdebug 安装步骤

xdebug是php的一个module,需要编译安装,我用lnmp安装的php,php被默认安装到/usr/local/php,然后做一个硬链接到/usr/bin

先编译xdebug,代码如下:

1. wget http://www.xdebug.org/files/xdebug-2.2.3.tgz 
2. tar xzf xdebug-2.2.3.tgz 
3. cd xdebug-2.2.3 
4. /usr/bin/phpize 
5. ./configure --with-php-config=/usr/local/php/bin/php-config 

修改php.ini配置,把下面这些加入.

1. ;no-debug-non-zts-20090626 这个文件夹名称和php版本是一一对应的 
2. zend_extension= "/usr/local/php/lib/php/extensions/no-debug-non-zts-20090626/xdebug.so" 
3. xdebug.default_enable = On 
4. xdebug.show_exception_trace = On 
5. xdebug.show_local_vars = 1 
6. xdebug.max_nesting_level = 50 
7. xdebug.var_display_max_depth = 6 
8. xdebug.dump_once = On 
9. xdebug.dump_globals = On 
10. xdebug.dump_undefined = On 
11. xdebug.dump.REQUEST = * 
12. xdebug.cli_color = 2 

利用Xdebug使调试信息更加美观

Xdebug扩展加载后,Xdebug会对原有的某些PHP函数进行覆写,以便好更好地进行Debug.比如var_dump()函数,知道通常需要在函数前后加上”<pre>…</pre>”才能够让输出的变量信息比较美观、可读性好.

但是加载了Xdebug后,不再需要这样做了,Xdebug不但自动给加上了<pre>标签,还给变量加上颜色.

PHP实例代码如下:

1. <?php 
2. $arrTest=array( 
3.      "test"=>"abc", 
4.      "test2"=>"abc2" 
5. ); 
6. var_dump($arrTest); 
7. ?> 

利用Xdebug测试脚本执行时间,xdebug_time_index()来显示时间,代码如下:

1. echo xdebug_time_index(); 
2. sleep(3);echo "<br>"; 
3. echo xdebug_time_index(); 

测定脚本占用的内存

想知道程序执行到某个特定阶段时到底占用了多大内存,为此PHP提供了函数

memory_get_usage().

这个函数只有当PHP编译时使用了--enable-memory-limit参数时才有效,Xdebug同样提供了一个函数xdebug_memory_usage()来实现这样的功能,另外xdebug还提供了一个xdebug_peak_memory_usage()函数来查看内存占用的峰值,代码如下:

1. echo "<br>"; 
2. echo xdebug_memory_usage(); 
3. echo "<br>"; 
4. echo xdebug_peak_memory_usage(); 

检测代码中的不足

有时候代码没有明显的编写错误,没有显示任何错误信息(如error、warning、notice等),但是这不表明代码就是正确无误的.

有时候可能某段代码执行时间过长,占用内存过多以致于影响整个系统的效率,没有办法直接看出来是哪部份代码出了问题.

这时候希望把代码的每个阶段的运行情况都监控起来,写到日志文件中去,运行一段时间后再进行分析,找到问题所在.

之前编辑php.ini文件,加入如下代码:

1. [Xdebug] 
2. xdebug.profiler_enable=on 
3. xdebug.trace_output_dir="I:Projectsxdebug" 
4. xdebug.profiler_output_dir="I:Projectsxdebug" 

这几行,目的就在于把执行情况的分析文件写入到”I:Projectsxdebug”目录中去(可以替换成任何想设定的目录).

如果执行某段程序后,再打开相应的目录,可以发现生成了一堆文件,例如cachegrind.out.1169585776这种格式命名的文件.

这些就是Xdebug生成的分析文件.用编辑器打开可以看到很多程序运行的相关细节信息,不过很显然这样看太累了,需要用图形化的软件来查看.

在Windows平台下,可以用WinCacheGrind(下载地址http://sourceforge.net/projects/wincachegrind/)这个软件来打开这些文件.

可以直观漂亮地显示其中内容,代码如下:

1. testXdebug(); 
2. function testXdebug() { 
3.        requireFile(); 
4. } 
5. function requireFile() { 
6.        require_once('abc.php'); 
7. } 

很直观地看到index.php中调用了一个函数testXdebug(),testXdebug()中又调用了requireFile()函数.这样就可以非常方便地查看整个脚本的程序结构.

重启php-fpm,随便写段错误的php代码,刷新浏览器,就能看到错误提示,在使用过程碰到一个小插曲.

A:访问超慢响应.

B:访问超快响应但是是空白页.

问题A解决的方法很多,总归还有解决办法,问题B我估计是线程问题,也许可以通过调试php.ini的配置搞定,也许不是,很难讲清楚,线程的问题可能要跟xdebug的版本扯上关系.

解决方式:

PHP.ini 找到memory_limit参数,增大.

换一个浏览器,我之前一直用Google Chrome调试程序,之后就开始变慢下来,直到每个页面变成6秒才加载完毕,已经忍无可忍,换成了Firefox、IE均没有这个问题(这个方法很好用,还能立刻见效)

使用 xdebug.profiler_enable_trigger配置,有选择的运行xdebug功能探查程序.

xdebug.remote_host 的值最好跟你服务器的IP一致,比方说你是通过localhost访问,则这里写localhost,你是127.0.0.1访问,就写127.0.0.1

看看你的xdebug.profiler_output_dir目录是否已经达到几G了？(一套电商程序很可能在持续开发十几个小时后,xdebug.profiler_output_dir目录的xdebug文件达到好几G)

平时不需要的时候,最好关闭xdebug,代码如下:

1. xdebug.remote_enable = 0 
2. xdebug.profiler_enable = 0 
3. xdebug.remote_autostart = false