用 Xdebug 修正 PHP 应用程序中的错误

转自：IBM中国  author:Martin Streicher ([email]martin.streicher@gmail.com[/email]), 主编, McClatchy Interactive

使用 PHP 调试器比结合使用 echo 与 var_dump()、debug_zval_dump() 和 print_r() 的效果更佳

PHP 的 Xdebug 扩展能够帮助您在程序出错或失败时剖析应用程序以查找缘由。经过本文了解如何使用 Xdebug 跟踪调用堆栈、分析内存使用状况并查看参数和变量的内容。

虽然您可使用 PHP 为系统管理和传统数据处理之类的任务建立命令行脚本，可是编程语言对 Web 应用程序的性能有主要影响。在使用过程当中，每一个 PHP 应用程序都驻留在服务器上，而且将经过代理（例如 Apache）调用 PHP 应用程序处理到来的请求。对于每一个请求，典型的 PHP Web 应用程序在简短运行后将获得一个 Web 页面或 XML 数据结构。

假定通过简单的运行后，一个分层构造的 Web 应用程序 —— 包括客户机、网络、HTTP 服务器、应用程序代码和底层数据库 —— 将会很难隔离 PHP 代码中的错误。即便假定除了 PHP 代码之外全部层均可以正常运行，跟踪 PHP 代码中的错误也会很是难，尤为是在应用程序利用较多的类时更是如此。

PHP 语句 echo 和函数 var_dump()、debug_zval_dump() 和 print_r() 都是常见且流行的调试辅助工具，能够帮助解决多种问题。可是，这些语句 —— 甚至更健壮的工具，例如 PEAR Log package —— 都是取证工具，必须在上下文环境以外先进行推测分析才能生成证据。

在某种程度上，经过推论进行调试是一种蛮干的作法。收集并筛选数据，尝试推论出发生的问题。若是缺乏重要信息，则必须从新测试代码、重复执行步骤，而后从新开始研究。一种更加高效的方法是在 程序运行时探测应用程序。您能够对请求参数分类，筛选过程调用堆栈，并查询任何所需的变量或对象。您能够暂时中断应用程序而且能够在变量更改值时收到警报。在某些状况下，您能够经过交互式询问 “若是……会怎样？” 问题来实际影响变量。

称为调试器 的特殊应用程序支持这种 “实时的” 或交互式的检查。调试器可能启动并链接到进程上以便控制进程并监测其内存。或者，在使用解释语言的状况下，调试器能够直接解释代码。典型的现代图形化调试器能够索引并浏览代码，以符合人类阅读习惯的形式轻松地显示复杂的数据结构，并同时显示程序状态，如调用堆栈、中间输出和全部变量的值。例如，调试器一般都会把类的属性和方法分类并进行描述。

在本文和下一篇文章中，我将介绍的工具必定可以简化 PHP 调试。下一次，我将主要介绍交互式调试和 Zend Debugger —— 一个特别针对 PHP 的健壮调试器 —— 并探究它提供的许多功能。（Zend Debugger 是一款商业产品，是 Zend PHP 集成开发环境（IDE）的一部分）。我还将介绍一款开源 PHP 调试器，以避免您只愿把钱花在啤酒上，而不是花在代码上。可是，本文将主要介绍如何更好地取证。

相似《犯罪现场调查》，只是更使人讨厌

代码出错、未能生成某个所需结果或者完全崩溃时，您须要回答四个 w 问题：where、what、why 和 when：

• “where” 是应用程序最后一次正常运行时所在的文件和行号。
• “what” 是犯错的代码 —— 好比说，嫌疑犯。
• “why” 是错误的本质。可能它是一个逻辑错误和/或与操做系统进行交互所致使的错误，或二者兼具。
• 而 “when” 是出现错误时的上下文。在程序终止前发生了什么状况？像在全部犯罪行为中同样，若是您能够收集到足够的线索，那么线索就能够帮助您找到×××。

一种取证工具 Xdebug（上一篇文章中使用的工具，用于分析 PHP 应用程序性能），如名称所示，将提供几个说明程序状态的功能，而且是应当添加到指令系统中的价值颇高的研究工具（请参阅 参考资料）。安装后，Xdebug 将阻止无限次递归（表面上是这样）、修正关于堆栈跟踪和函数跟踪的错误消息以及监视内存分配，并提供其余功能。Xdebug 还包括一组函数，您能够将这组函数添加到代码中以进行运行时错误诊断。

例如，下面的代码将使用一些 xdebug_...() 步骤测试 callee() 函数，以便输出调用程序的具体位置，包括文件名、行号和调用函数的名称。

清单 1. 测试 callee() 函数的步骤

<?php function callee( $a ) { echo sprintf("callee() called @ %s: %s from %s", xdebug_call_file(), xdebug_call_line(), xdebug_call_function() ); } $result = callee( "arg" ); ?>

这段代码将生成：

callee() called @ /var/www/catalog/xd.php: 10 from {main}

构建和安装 Xdebug

Xdebug 能够很轻松地从 UNIX® 类操做系统（包括 Mac OS X）中的源代码构建。若是是在 Microsoft® Windows® 上使用 PHP，则能够从 Xdebug Web 站点下载最新 PHP 版本的二进制 Xdebug 模块（请参阅 参考资料）。

让咱们来构建和安装适用于 Debian “Sarge” Linux® 和 PHP V4.3.10-19 的 Xdebug。在撰写本文时，Xdebug 的最新版本是 V2.0.0RC4，发布于 2007 年 5 月 17 日。要继续本文，必须拥有 phpize 和 php-config 实用程序，而且必须可以编辑系统的 php.ini 配置文件（若是没有实用程序，请访问 PHP.net 以得到如何从头构建 PHP 的源代码和说明）。请执行如下步骤：

1. 下载 Xdebug tarball（一个用 gzip 压缩的 .tar 归档文件）。wget 命令能够帮助您轻松地完成此操做： $ wget [url]http://www.xdebug.org/files/xdebug-2.0.0RC4.tgz[/url]
2. 解压缩该 tarball 并切换到源代码目录： $ tar xzf xdebug-2.0.0RC4.tgz $ cd xdebug-2.0.0RC4
3. 运行 phpize 以准备适用于您的 PHP 版本的 Xdebug 代码： $ phpize Configuring for: PHP Api Version: 20020918 Zend Module Api No: 20020429 Zend Extension Api No: 20021010

   phpize 的输出是一个脚本 —— 一般名为配置 —— 用于调整其他的构建过程。

4. 运行配置脚本： $ ./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
5. 经过运行 make 构建 Xdebug 扩展： $ make /bin/sh /home/strike/tmp/xdebug-2.0.0RC4/libtool --mode=compile gcc -I. -I/home/strike/tmp/xdebug-2.0.0RC4 -DPHP_ATOM_INC -I/home/strike/tmp/xdebug-2.0.0RC4/include -I/home/strike/tmp/xdebug-2.0.0RC4/main -I/home/strike/tmp/xdebug-2.0.0RC4 -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。

6. 安装该扩展： $ sudo make install Installing shared extensions: /usr/lib/php4/20020429/

   继续以前，使用鼠标选择并复制上一条命令显示的目录。该路径对于最后一步配置扩展相当重要。

7. 在您喜欢的文本编辑器中打开 php.ini 文件，而后添加如下代码： zend_extension = /usr/lib/php4/20020429/xdebug.so xdebug.profiler_enable = Off xdebug.default_enable = On

   第一行将装入 Xdebug 扩展；第二行将禁用 Xdebug 的分析器功能（只是为了简单起见），而第三行将启用扩展的调试功能。

要检验 Xdebug 扩展是否已经安装并启用，请从新启动 Web 服务器，而后用代码 <?php phpinfo(); ?> 建立简单的一行 PHP 应用程序。若是将浏览器指向文件 —— 如 [url]http://localhost/phpinfo.php[/url] —— 并向下滚动，您应当会看到相似图 1 所示的内容。

图 1. 检验 Xdebug 扩展是否已经安装并运行

注：若是您在 phpinfo() 的输出中没有看到 Xdebug 部分，则 Xdebug 装入失败。Apache 错误日志会列出缘由。常见错误包括 zend_extension 的路径错误或者与其余扩展发生冲突。例如，若是须要使用 XCache 和 Xdebug，必定要先装入 XCache。可是，因为 Xdebug 适于在开发时使用并假定 xdebug.so 的路径正确，所以须要禁用其余扩展并重试。而后您能够从新启用扩展以执行其余测试，如缓存的效果。Xdebug 站点还有其余一些故障检修技巧。

配置 Xdebug

指令（图 1 中大表的最左侧一列）是一些能够设定的参数，用于改变 Xdebug 扩展的行为。可在 php.ini 文件中设置全部指令。一些指令用于配置调试工具；其余指令用于调整分析器的操做。忽略后者，让咱们用一些合理设置来配置 Xdebug 以帮助调试 PHP 代码。

限制递归

若是应用程序使用递归 —— 例如，计算斐波纳契数列 —— 而且终端环境不正确，应用程序会运行很长一段时间后才用尽内存或超时。您能够设定 xdebug.max_nesting_level 参数来限定递归深度。例如，xdebug.max_nesting_level = 50 将把递归深度限定为 50 次嵌套调用，而后将强制终止应用程序。下面演示一下，在启用 Xdebug 的状态下运行下列代码：

清单 2. 限制递归

<?php function deep_end( ) { deep_end(); } deep_end(); ?>

函数 deep_end() 将逐行进行到最底部。Xdebug 将在 49 次函数调用后介入并获得图 2（顺便说一句，main() 的初始调用用于启动程序计数做为第 1 次调用）。

图 2. 若是调用堆栈超出限制，Xdebug 将终止执行

若是应用程序大量使用递归隔离并解决较大的问题，则须要把深度相应地设定得 “更低”。不然，将 xdebug.max_nesting_level 设为较小的值，这样能够更快速地捕捉失控的函数调用序列。

回答四个 w 问题

出错时，您须要回答四个 w 问题。Xdebug 能够当即提供全部这些信息。下面是一些有益的初始设置；您能够随时调整这些设置。

清单 3. 错误

xdebug.dump_once = On xdebug.dump_globals = On xdebug.dump_undefined = On xdebug.dump.SERVER = REQUEST_METHOD,REQUEST_URI,HTTP_USER_AGENT xdebug.dump.REQUEST=* xdebug.show_exception_trace = On xdebug.show_local_vars = 1 xdebug.var_display_max_depth = 6

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 表示转储复杂变量的深度。

整合

清单 4 显示了 php.ini 文件的 Xdebug 的全部相关设置。

清单 4. php.ini 文件的设置

zend_extension = /usr/lib/php4/20020429/xdebug.so 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

将这些设置（或相似的内容）保存到 php.ini 文件中，而后从新启动 Web 服务器。

解释转储报告

如下示例显示了出错时发生的状况。把您的 “有待改进” 的代码修改成相似清单 5 所示的代码。

清单 5. 修改错误代码

<?php function deep_end( $count ) { // add one to the frame count $count += 1; if ( $count &lt; 48 ) { deep_end( $count ); } else { trigger_error( "going off the deep end!" ); } } // main() is called to start the program, // so the call stack begins with one frame deep_end( 1 ); ?>

若是运行这段新代码，您应当会看到大量信息，以下所示：

图 3. 出错时超全局变量、堆栈和局部变量的转储

传递给 trigger_error 的消息文本显示在顶部。底部是受请求的 $_SERVER 元素列表和已经定义的 $_REQUEST 元素列表。最底部是 #48 范围中的变量列表，这是根据清单对 deep_end() 进行的调用。在调用中，$count 是整数 48。当此 Xdebug 配置就绪后，您如今有更多的线索能够跟踪犯罪者。

下面是另一个技巧：Xdebug 提供了一个加强型 var_dump() 函数，它对于 PHP 数组和类尤其有帮助。例如，清单 6 显示了简单的（PHP V4）类和实例。

清单 6. PHP V4 类和实例

<?php class Person { var $name; var $surname; var $age; var $children = array(); function Person( $name, $surname, $age, $children = null) { $this->name = $name; $this-&gt;surname = $surname; $this-&gt;age = $age; foreach ( $children as $child ) { $this-&gt;children[] = $child; } } } $boy = new Person( 'Joe', 'Smith', 4 ); $girl = new Person( 'Jane', 'Smith', 6 ); $mom = new Person( 'Mary', 'Smith', 34, array( $boy, $girl ) ); var_dump( $boy, $mom ); ?&gt;

清单 7 显示了 var_dump() 的输出。

清单 7. var_dump() 输出

object(person) var 'name' =&gt; string 'Joe' (length=3) var 'surname' =&gt; string 'Smith' (length=5) var 'age' =&gt; int 4 var 'children' =&gt; array empty object(person) var 'name' =&gt; string 'Mary' (length=4) var 'surname' =&gt; string 'Smith' (length=5) var 'age' =&gt; int 34 var 'children' =&gt; array 0 =&gt; object(person) var 'name' =&gt; string 'Joe' (length=3) var 'surname' =&gt; string 'Smith' (length=5) var 'age' =&gt; int 4 var 'children' =&gt; array empty 1 =&gt; object(person) var 'name' =&gt; string 'Jane' (length=4) var 'surname' =&gt; string 'Smith' (length=5) var 'age' =&gt; int 6 var 'children' =&gt; array empty

若是结合使用 Xdebug 与 PHP V5 类，转储包括 public、private 和 protected 之类的属性。

 

跟踪代码

解决错误 —— 如解开神秘谋杀之谜 —— 一般要求构造详细的时间线。例如，内存泄漏一般不会把自身代表为一个错误计算。相反，操做将正常进行，直至内存用尽，而后应用程序忽然终止。若是内存泄漏因为某些请求而恶化，可能会不断出现错误而且难以预测。在内存使用量与时间之间创建映射的时间线将揭示泄漏的严重程度。一条精细的时间线 —— 好比，从函数到函数 —— 将进一步指出泄漏源。

Xdebug 能够提供一条详细的时间线进行执行跟踪。当跟踪被启用后，Xdebug 将记录全部函数调用，包括每一个函数的参数和返回值。您能够将每一个日志或跟踪 的格式设为符合人类阅读习惯或者机器可读的格式。您最好使用前者，虽然您可能编写独立而特定的应用程序来分析后者。

同转储同样，Xdebug 有若干个 php.ini 选项用于自定义跟踪内容。例如，下面一批设置将生成最详细的输出。

清单 8. 跟踪自定义

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。

接下来看另一个示例。建立 /tmp/traces 目录，而后用 mkdir /tmp/traces; chmod a+rwx /tmp/traces 将其模式更改成可以被任何用户阅读的文件（world-readable）和可以被任何用户写入的文件（world-writable）（若是您不肯共享 traces 目录，请确保至少 Web 服务器用户 —— 一般为 www 或任何人 —— 能够将数据写入该目录）。将以上跟踪设置添加到 php.ini 文件中，从新启动 Web 服务器，而后把浏览器再次指向 phpinfo() 应用程序。整个跟踪应当相似清单 9 所示：

清单 9. 整个跟踪

TRACE START [2007-06-06 14:04:55] 0.0003 9440 +9440 -&gt; {main}() /var/www/catalog/t/info.php:0 0.0005 9440 +0 -&gt; phpinfo() /var/www/catalog/t/info.php:1 &gt;=-&gt; TRUE &gt;=-&gt; 1 0.2351 9208 TRACE END [2007-06-06 14:04:55]

在这里，main() 将调用 phpinfo()，后者将返回 TRUE。当 main() 退出时，它将返回 1。接下来，将浏览器指向 “最复杂的内容” 或系统中的其余某个 PHP 应用程序以生成更详细的跟踪。

清单 10 显示了在计算第四个斐波纳契数列时上一篇文章中的 PHP Fibonacci 生成器的跟踪：

清单 10. PHP Fibonacci 生成器跟踪

TRACE START [2007-06-06 14:17:17] 0.0004 16432 +16432 -&gt; {main}() /var/www/catalog/t/fibonacci.php:0 0.0006 16696 +264 -&gt; fib('4') /var/www/catalog/t/fibonacci.php:35 0.0007 16696 +0 -&gt; fib(3) /var/www/catalog/t/fibonacci.php:7 0.0007 16736 +40 -&gt; fib(2) /var/www/catalog/t/fibonacci.php:7 0.0007 16848 +112 -&gt; fib(1) /var/www/catalog/t/fibonacci.php:7 &gt;=&gt; 1 0.0008 16904 +56 -&gt; fib(0) /var/www/catalog/t/fibonacci.php:7 &gt;=&gt; 0 &gt;=&gt; 1 0.0009 16904 +0 -&gt; fib(1) /var/www/catalog/t/fibonacci.php:7 &gt;=&gt; 1 &gt;=&gt; 2 0.0009 16904 +0 -&gt; fib(2) /var/www/catalog/t/fibonacci.php:7 0.0009 16904 +0 -&gt; fib(1) /var/www/catalog/t/fibonacci.php:7 &gt;=&gt; 1 0.0010 16904 +0 -&gt; fib(0) /var/www/catalog/t/fibonacci.php:7 &gt;=&gt; 0 &gt;=&gt; 1 &gt;=&gt; 3 &gt;=&gt; 1 0.0011 12528 TRACE END [2007-06-06 14:17:17]

第一列显示时间，第二列是累计的内存使用量，第三列是增长的内存使用量，而第四列显示函数调用，包括参数。

标有 &gt;=&gt; 的行显示每一个函数的返回值（查找相应的缩进 -&gt; 将调用与其返回值匹配起来）。此外，最后的 &gt;=&gt; 1 是 main() 的返回值。

若是使用 vim，Xdebug 的创造者 Derick Rethans 提供了专门针对 Xdebug 跟踪的一组语法加亮提示。提示包含在 Xdebug 源代码包内的 xt.vim 文件中。对于最近的 Linux 发行版，只需将 xt.vim 复制到 $VIMRUNTIME/syntax/xt.vim 中，而后运行 vim tracefile.xt。图 4 显示了 vim 中加亮的 Fibonacci 跟踪。

图 4. Xdebug 跟踪的 vim 语法文件将使您能够轻松地进行分析

结束语

跟踪 PHP 代码中的错误多是一项挑战。可是若是您有开发系统而且能够安装 Xdebug，那么更正这些错误就会变得轻松得多。Xdebug 能够显示堆栈跟踪，转储甚为复杂的变量，随时间跟踪内存使用量，并容许您在出错或崩溃时（不是若是，而是发生时）进行有效的过后分析。