php调试工具Xdebug安装与分析工具Wincachegrind

一：windows下安装Xdebug 此文以PHP5.2.3为例（其它PHP版本，其它平台请参看官网文档）： 1． 在http://www.xdebug.org/download.php 下载适合自己php版本的 xdebug.dll 文件； 2． 将下载的xdebug.dll放到 php\ext 目录里，重命名为 php_xdebug.dll； 3． 编辑php.ini，加入下面几行： ;;;;;;;;;;;;;;;;;;; ; ADD debug extends ; ;;;;;;;;;;;;;;;;;;; extension=php_xdebug.dll [Xdebug] xdebug.profiler_enable=on xdebug.trace_output_dir="C:\AppServ\xdebug_log" xdebug.profiler_output_dir="C:\AppServ\xdebug_log" xdebug.dump.GET=* xdebug.show_local_vars=1 后面的目录“C:\AppServ\xdebug_log”为你想要放置Xdebug输出的数据文件的目录，可自由设置。 4． 重启Apache； 5． 写一个test.php，内容为<?php phpinfo(); ?>，如果输出的内容中有看到xdebug，说明安装配置成功。 6。 xdebug+WinCacheGrind将能更好的分析代码。这里送上一位达人反编译成的兼容 Xdebug 2.0.0RC4+ 的 Wincachegrind 修改版～http://www.paulgao.com.cn/software/WinCacheGrind.exe 二、Linux 下安装Xdebug Xdebug 可以很轻松地从 UNIX® 类操作系统（包括 Mac OS X）中的源代码构建。如果是在 Microsoft® Windows®上使用 PHP，则可以参考上面的从 Xdebug Web 站点下载最新 PHP 版本的二进制 Xdebug 模块。 让我们来构建和安装适用于centos 和 PHP V5.2.3 的 Xdebug。在撰写本文时，Xdebug 的最新版本是 V2.0.5，发布于 2009 年 07月 03 日。要继续本文，必须拥有 phpize 和 php-config 实用程序，并且必须能够编辑系统的 php.ini 配置文件（如果没有实用程序，请访问 PHP.net 以获得如何从头构建 PHP 的源代码和说明）。请执行以下步骤： 下载 Xdebug tarball（一个用 gzip 压缩的 .tar 归档文件）。wget 命令可以帮助您轻松地完成此操作： $ wget http://xdebug.org/files/xdebug-2.0.5.tgz 解压缩该 tarball 并切换到源代码目录： $ tar xzf xdebug-2.0.5.tgz$ cd xdebug-2.0.5 运行 phpize 以准备适用于您的 PHP 版本的 Xdebug 代码： $ phpize Configuring for: PHP Api Version: 20020918 Zend Module Api No: 20020429 Zend Extension Api No: 20021010 phpize 的输出是一个脚本 —— 通常名为配置 —— 用于调整其余的构建过程。 运行配置脚本： $ ./configure checking build system type... i686-pc-linux-gnu checking host system type... i686-pc-linux-gnu checking for gcc... gcc checking for C compiler default output file name... a.out checking whether the C compiler works... yes checking whether we are cross compiling... no checking for suffix of executables... checking for suffix of object files... o ... checking whether stripping libraries is possible... yes appending configuration tag "F77" to libtool configure: creating ./config.status config.status: creating config.h 通过运行 make 构建 Xdebug 扩展： $ make /bin/sh /home/strike/tmp/xdebug-2.0.5/libtool --mode=compile gcc -I. -I/home/strike/tmp/xdebug-2.0.5 -DPHP_ATOM_INC -I/home/strike/tmp/xdebug-2.0.5/include -I/home/strike/tmp/xdebug-2.0.5/main -I/home/strike/tmp/xdebug-2.0.5 -I/usr/include/php4 -I/usr/include/php4/main -I/usr/include/php4/Zend -I/usr/include/php4/TSRM -DHAVE_CONFIG_H -g -O0 -c /home/strike/tmp/xdebug-2.0.0RC4/xdebug.c -o xdebug.lo mkdir .libs ... Build complete. (It is safe to ignore warnings about tempnam and tmpnam). 使用 make 将生成 Xdebug 扩展 xdebug.so。 安装该扩展： $ sudo make install Installing shared extensions: /usr/lib/php4/20020429/ 继续之前，使用鼠标选择并复制上一条命令显示的目录。该路径对于最后一步配置扩展至关重要。 在您喜欢的文本编辑器中打开 php.ini 文件，然后添加以下代码： zend_extension = /usr/lib/php4/20020429/xdebug.so xdebug.profiler_enable = Off xdebug.default_enable = On 第一行将装入 Xdebug 扩展；第二行将禁用 Xdebug 的分析器功能（只是为了简单起见），而第三行将启用扩展的调试功能。 要检验 Xdebug 扩展是否已经安装并启用，请重新启动 Web 服务器，然后用代码 <?php phpinfo(); ?> 如果输出的内容中有看到xdebug，说明安装配置成功。 如下图： 三：使用 Xdebug 进行调试 我们先写一个可以导致执行出错的程序，例如尝试包含一个不存在的文件。 ①： testXdebug.php <?php require_once(‘abc.php’); ?> 然后通过浏览器访问，可以看到，出错信息高亮显示： 不过除了样式改变，和我们平时打印的出错信息内容没什么不同，意义不大。好，我们继续改写程序： ②： testXdebug2.php <?php testXdebug(); function testXdebug() {        require_once('abc.php'); } ?> 输出信息： 发现了什么？　Xdebug跟踪代码的执行，找到了出错的函数testXdebug()。 我们把代码再写得复杂一些：　 ③： testXdebug3.php <?php testXdebug(); function testXdebug() {        requireFile();     } function requireFile() {        require_once('abc.php'); } ?> 输出信息： 呵呵，也就是说Xdebug具有类似于Java的Exception的 “跟踪回溯” 功能，可以肯局程序的执行一步步跟踪到出错的具体位置，哪怕程序中的调用很复杂，我们也可以通过这个功能来理清代码的关系，迅速定位，快速排错。 其实PHP函数 debug_backtrace() 函数也有类似的功能，但是要注意debug_backtrace()函数只在PHP4.3.0之后版本及PHP5中才生效。这个函数是PHP开发团队在PHP5中新增的函数，然后又反向移植到PHP4.3中。 如何利用Xdebug使调试信息更加美观？ Xdebug 扩展加载后，Xdebug会对原有的某些PHP函数进行覆写，以便好更好地进行Debug。比如var_dump()函数，我们知道通常我们需要在函数前 后加上”<pre>…</pre>”才能够让输出的变量信息比较美观、可读性好。但是加载了Xdebug后，我们不再需要这样做 了，Xdebug不但自动给我们加上了<pre>标签，还给变量加上颜色。 例： <?php $arrTest=array(        "test"=>"abc",        "test2"=>"abc2" ); var_dump($arrTest); ?> 输出： 如何利用Xdebug 测试脚本执行时间 测试某段脚本的执行时间，通常我们都需要用到microtime()函数来确定当前时间。 例如PHP手册上的例子： <?php /** * Simple function to replicate PHP 5 behaviour */ function microtime_float() {      list( $usec, $sec) = explode(" ", microtime()); return ((float)$usec + (float)$sec); } $time_start = microtime_float(); // Sleep for a while usleep(100); $time_end = microtime_float(); $time = $time_end - $time_start; echo  "Did nothing in $time seconds\n"; ?> 但是microtime()返回的值是微秒数及绝对时间戳（例如“0.03520000 1153122275”），没有可读性。所以如上程序，我们需要另外写一个函数microtime_float() ，来将两者相加。 xdebug 自带了一个函数 Xdebug_time_index()来显示时间 如何测定脚本占用的内存？ 有时候我们想知道程序执行到某个特定阶段时到底占用了多大内存，为此PHP提供了函数memory_get_usage()。这个函数只有当PHP编译时使用了--enable-memory-limit 参数时才有效。　 xdebug 同样提供了一个函数 xdebug_memory_usage() 来实现这样的功能，另外xdebug还提供了一个 xdebug_peak_memory_usage() 函数来产看内存占用的峰值。 如何检测代码中的不足？ 有时候代码没有明显的编写错误，没有显示任何错误信息（如 error、warning、notice 等）， 但是这不表明代码就是正确无误的。有时候可能某段代码执行时间过长，占用内存过多以致于影响整个系统的效率，我们没有办法直接看出来是哪部份代码出了问 题。这时候我们希望把代码的每个阶段的运行情况都监控起来，写到日志文件中去，运行一段时间后再进行分析，找到问题所在。 回忆一下，之前我们编辑 php.ini 文件加入 [Xdebug] xdebug.profiler_enable=on xdebug.trace_output_dir="C:\AppServ\xdebug_log" xdebug.profiler_output_dir="C:\AppServ\xdebug_log " 这几行，目的就在于把执行情况的分析文件写入到 ”C:\AppServ\xdebug_log” 目录中去（你可以替换成任何你想设定的目录）。如果你执行某段程序后，再打开相应的目录，可以发现生成了一堆文件，例如cachegrind.out.1169585776 这种格式命名的文件。 这些就是Xdebug 生成的分析文件。用编辑器打开你可以看到很多程序运行的相关细节信息，不过很显然这样看太累了，我们需要用图形化的软件来查看。 使用 WinCacheGrind 分析Xdebug日志文件，进行性能调试 在 Widows平台下，可以使用 WinCacheGrind 来打开这些日志文件，可以直观漂亮的显示其中的内容： 哇，非常漂亮，我们很直观地看到index.php 我们调用了 testXdebug()，testXdebug() 中又调用了requireFile() 函数。这样我们就可以非常方便地查看整个脚本的程序结构。 另外，我们还可以看到每个函数被调用的次数及执行所花费的时间！这对于测试程序性能非常有用。 从上图可以看到：整个程序的结构，每个函数被调用的次数，执行时间都一目了然。 小结： Xdebug 提供了各种自带的函数，并对已有的某些PHP函数进行覆写，可以方便地用于调试排错；Xdebug还可以跟踪程序的运行，通过对日志文件的分析，我们可以迅速找到程序运行的瓶颈所在，提高程序效率，从而提高整个系统的性能。 Xdebug 相关的设置 xdebug.default_enable = On xdebug.show_exception_trace = On xdebug.show_local_vars = 1 xdebug.max_nesting_level = 50 xdebug.var_display_max_depth = 6 xdebug.dump_once = On xdebug.dump_globals = On xdebug.dump_undefined = On xdebug.dump.REQUEST = * xdebug.dump.SERVER = REQUEST_METHOD,REQUEST_URI,HTTP_USER_AGENT xdebug.dump_once、xdebug.dump_globals、xdebug.dump_undefined 和 xdebug.dump_SUPERGLOBAL   设置(其中 SUPERGLOBAL   可以是 COOKIE、FILES、GET、POST、REQUEST、SERVER 或 SESSION) 用于控制哪些 PHP 超全局变量将被包含在所有诊断结果中. 将 xdebug.dump_globals 设为 On 以转储名为 xdebug.dump_SUPERGLOBAL 设置中的超全局变量.例如,xdebug.dump_SERVER = REQUEST_METHOD,REQUEST_URI,HTTP_USER_AGENT 将打印 PHP 超全局变量 $_SERVER['REQUEST_METHOD']、$_SERVER['REQUEST_URI'] 和 $_SERVER['HTTP_USER_AGENT'].如果需要打印超全局变量数组中的所有值,请使用星号 (*),例如 xdebug.dump_REQUEST=*.如果进一步将 xdebug.dump_undefined 设为 On 并且不设定指定的超全局变量,则仍用值 undefined 打印变量. 即使捕捉到异常,代码行 xdebug.show_exception_trace = On 仍将强制执行异常跟踪. xdebug.show_local_vars = 1 将打印每个函数调用的最外围中的所有局部变量,包括尚未初始化的变量. xdebug.var_display_max_depth = 6 表示转储复杂变量的深度. 跟踪自定义 xdebug.trace_format = 0 xdebug.auto_trace = On xdebug.trace_output_dir = /tmp/traces xdebug.trace_output_name = trace.%c.%p xdebug.collect_params = 4 xdebug.collect_includes = On xdebug.collect_return = On xdebug.show_mem_delta = On xdebug.auto_trace = 1 将在执行所有 PHP 脚本之前先启用自动跟踪.另外,可以通过代码设定 xdebug.auto_trace = 0,并分别使用 xdebug_start_trace() 和 xdebug_stop_trace() 函数启用和禁用跟踪.但是,如果 xdebug.auto_trace 为 1,则可以在包括配置好的 auto_prepend_file 之前先启动跟踪. xdebug.trace_ouput_dir 和 xdebug.trace_output_name 用于控制保存跟踪输出的位置.在这里,所有文件都被保存到 /tmp/traces 中,并且每个跟踪文件都以 trace 为开头,后接 PHP 脚本的名称(%s)以及进程 ID(%p).所有 Xdebug 跟踪文件都以 .xt 后缀结尾. 默认情况下,Xdebug 将显示时间、内存使用量、函数名和函数调用深度字段. xdebug.trace_format 设为 0 则输出将符合人类阅读习惯(将参数设为 1 则为机器可读格式). xdebug.show_mem_delta = 1 则可以查看内存使用量是在增加还是在减少, xdebug.collect_params = 4 则可以查看传入参数的类型和值.要监视每个函数返回的值,请设定 xdebug.collect_return = 1.