Windows 下安装 Xdebug 受难记之（1）

这篇文章的标题原来叫《用 Xdebug 进行基准测试和代码覆盖率分析》。安装 Xdebug 只是文章开头的准备工作之一。然而。仅仅是 Xdebug 的安装，就花费大量的精力和时间，再次感受了开源软件产品的 Bug 引起的磨难和困惑！

只能在这篇文章的第二部分，主要叙述用 Xdebug 进行基准测试和代码覆盖率分析的内容了。

原文的开头写到：

作为一个 PHP 程序员，你了解自己的代码 - 函数、类，在运行时占用多少内存、耗费了多少CPU时间？哪些代码导致了整个系统的效率大大下降？你了解自己的哪些代码是经常被调用的，而哪些代码可能从来就没有被运行过？……

以上的问题，我们需要通过基准测试和代码覆盖率分析（code coverage analysis）来获得有关信息，从而为优化系统提供分析依据。Xdebug 就是解决上述问题的良好工具之一。

Xdebug 是 PHP 开发环境下一个开放源代码的程序调试器(Debug工具)，可以用来跟踪，调试和分析 PHP 程序的运行状况。截至 2010年8月份，Xdebug的最新版本是Xdebug 2.1.0，支持PHP4/PHP5。Xdebug 的官方网站是 http://www.xdebug.org，可以去那里了解 Xdebug 的详细信息和下载相关的软件。

一、下载和安装：

在 Windows 下和 Linux 下，Xdebug 的安装方法不尽相同。本文以 Windows 下的安装来描述。在 Windows 下，通过运行 PECL 命令来安装 Xdebug，会提示以下错误：

C:\Program Files\Zend\ZendServer\bin>pecl install xdebug
downloading xdebug-2.1.0.tgz ...
Starting to download xdebug-2.1.0.tgz (301,354 bytes)
.........................done: 301,354 bytes
66 source files, building
WARNING: php_bin C:\Program Files\Zend\ZendServer\bin\.\php.exe appears to have
a suffix .exe, but config variable php_suffix does not match
ERROR: The DSP xdebug.dsp does not exist.

这是在试图编译 Xdebug 时，无法找到 xdebug.dsp 文件导致的。

-- 第一次困惑：既然不能在 Windows 下安装，为什么还能下载？错误信息只提示结果，并没有提供解决的方法。也没有提示去哪里寻找解决方案。

我们可以去 Xdebug 的官网，直接下载对应的 PHP 和 Windows 版本的、已经编译好的二进制 Xdebug 扩展库文件(*.dll)。一定要注意下载和自己安装的 PHP 及 Windows 版本对应的 Xdebug 文件。

可以通过 phpinfo() 函数获取自己的 PHP 信息（本人用的是 Zend Server 5.0.1）。注意 PHP 版本？操作系统的位数(32bit/64bit)？PHP 是线程安全的还是非线程安全的？当前加载的 php.ini 文件的路径。

PHP Version 5.3.2
System：Windows NT WIN2003-1 5.2 build 3790 (Windows Server 2003 R2 Enterprise Edition Service Pack 2) i586
Compiler：MSVC9 (Visual C++ 2008)
Architecture：x86
Loaded Configuration File：C:\Program Files\Zend\ZendServer\etc\php.ini
Thread Safety：disabled

可以看到，本人的操作系统为 Windows Server 2003 企业版，32bit 版本，PHP 版本为 5.3.2，PHP 是用微软的 Visual Studio 2008 下的 VC9 编译的。

于是，下载的 Xdebug 版本为：

Windows binaries，5.3 VC9 Non-thread-safe (32 bit)，也就是 php_xdebug-2.1.0-5.3-vc9-nts.dll 文件。

-- 但是，我忽略了我使用的 PHP 环境是 Zend Server CE 5.0.1。于是，隐患就此埋下了……

二、安装配置：

在 php.ini 文件末尾加：

[Xdebug]
zend_extension="C:\Program Files\Zend\ZendServer\lib\php_xdebug-2.1.0-5.3-vc9-nts.dll"
xdebug.auto_trace=On
xdebug.collect_params=On
xdebug.collect_return=On
xdebug.trace_output_dir="C:\Program Files\Zend\ZendServer\xdebug.trace_output_dir"
xdebug.profiler_enable=On
xdebug.profiler_output_dir="C:\Program Files\Zend\ZendServer\xdebug.profiler_output_dir"

注意：

1，在 PHP5.3 里，zend_extension 不能写为 zend_extension_ts，这在 Xdebug 的官网里写的很清楚，虽然是洋文，我注意到了，没掉到陷阱里。也许 5.3 以后的版本，永远就是这样了。
2，xdebug.trace_output_dir 和 xdebug.profiler_output_dir 文件夹组要自己建立，用于存放 Xdebug 生成的文档。
3，xdebug.* = On/Off 等配置语句的意义，本文的第二部分会写。
4，配置好后，需要重新启动 Apache，对应的 Windows 服务的名字为“apache2.2-zend”。Zend Server 的后台管理里（地址http://localhost:10081/zendserver），也可以重启服务。
5，如果 php_xdebug-*.dll 文件选择错了，比如选择了 php_xdebug-2.1.0-5.3-vc6.dll，那么运行“php -v”命令，会报告：
C:\Program Files\Zend\ZendServer\bin>php -v
Cannot load Xdebug - it was built with configuration API220090626,NTS,VC6,
where as running engine is API220090626,NTS,VC9
6，php.ini 中开启了的 ZendExtensionManager.dll 和 zendOptimizer，可能会影响 Xdebug 的启用，如果有影响，请屏蔽它们。

Apache 可以正常重启。以为配置好了，但是在 phpinfo() 信息里，无法看到 Xdebug 的信息，说明 Xdebug 的 Zend 扩展模块没有被加载。这时，运行“php -v”命令，居然没有输出信息。

三、柳暗花明

再次浏览 Xdebug 官网，发现有一个贴心的服务，就是：提取用户的 phpinfo 信息，提交给 Xdebug 官网的一个程序，它立即分析 PHP 环境的信息，即刻给出下载 Xdebug 某个版本的建议。立等可取，有点意思！

于是提交我的 phpinfo 信息，从 http://www.xdebug.org/find-binary.php 页面提交，得到提示信息：

Warning: You seem to be using Zend Server, which is known to cause issues with Xdebug.
It might work, but you're on your own.

1.Download php_xdebug-2.1.0-5.3-vc9-nts.dll
2.Move the downloaded file to C:\Program
3.Open C:\Program Files\Zend\ZendServer\etc\cfg\debugger.ini and put a ; in front of the line that says zend_extension_manager.dir.debugger= so that it says ;zend_extension_manager.dir.debugger=
4.Edit C:\Program Files\Zend\ZendServer\etc\php.ini and add at the begining of the file the line zend_extension = C:\Program\php_xdebug-2.1.0-5.3-vc9-nts.dll
5.Restart the webserver

居然能看出来用的是 Zend Server 啊？实在是高啊！我下载的 Xdebug 版本是对的。但是前头的“Warning”让我心里很凉：
已知 Zend Server 与 Xdebug 一起使用会引起一些问题，能不能工作，你自己负责 - 自己看着办。

但有一条信息很重要，就是第3条，从 debugger.ini 里注释掉 zend_extension_manager.dir.debugger= 语句。注释掉该语句，意味着屏蔽了 zend debugger。看来 zend debugger 和 Xdebug 在 PHP5.3 里不能一起共存啊？以后能不能共存呢？

遵照官方的提示做了以后，Apache 可以正常启动。php -v 命令的提示如下：

C:\Program Files\Zend\ZendServer>php -v
PHP 5.3.2 (cli) (built: Apr 1 2010 17:14:41)
Copyright (c) 1997-2010 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2010 Zend Technologies
with Zend Extension Manager v5.1, Copyright (c) 2003-2010, by Zend Technolog
ies
- with Zend Data Cache v4.0, Copyright (c) 2004-2010, by Zend Technologies [
loaded] [licensed] [disabled]
- with Zend Utils v1.0, Copyright (c) 2004-2010, by Zend Technologies [loade
d] [licensed] [enabled]
- with Zend Optimizer+ v4.1, Copyright (c) 1999-2010, by Zend Technologies [
loaded] [licensed] [disabled]

with Xdebug v2.1.0, Copyright (c) 2002-2010, by Derick Rethans
with Zend Data Cache v4.0, Copyright (c) 2004-2010, by Zend Technologies
with Zend Utils v1.0, Copyright (c) 2004-2010, by Zend Technologies

看来，Xdebug 是被正常加载了！

但是，大问题来了！这时打开浏览器，运行 php 文件，查看 phpinfo 信息，想看看 Xdebug 的信息。但是，这个 php 文件居然被下载下来了！！！也就是说，php 文件不被解析了！

这就意味着，安装 Xdebug 已经没有任何意义了。本来就是要让 Xdebug 跟踪 php 文件运行的有关信息嘛。

于是，在 Zend Server 5.0.1 下，安装 Xdebug 失败。

我的目的是熟悉 Xdebug 的使用，Xdebug 安装失败，我不想自己看着办。

-- 这个开源的 PHP 和 Xdebug 啊，到底是谁错了？？！！

作者：张庆(网眼) 西安 PHP 教育培训中心 2010-7-7
来自“网眼视界”：http://blog.why100000.com
作者微博：http://t.qq.com/zhangking
“十万个为什么”电脑学习网：http://www.why100000.com