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

来源:www.phpres.com 作者：Angelover 出处：www.phpres.com 2007-9-21 14:46:22 进入讨论组

关键词：跟踪代码,用 Xdebug 修正 PHP 应用程序中的错误

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

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

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

                
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 所示：

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

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

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

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

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

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

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

vim 中加亮的跟踪