php调试工具——Xdebug（一）安装

旧城等待， 2022-06-01 06:05 682阅读 0赞

**Xdebug安装教程**

*下载Xdebug*

首先我们需要[下载Xdebug][Xdebug]，务必根据安装的PHP版本，选择合适的Xdebug版本，由于我是在Windows环境下安装PHP的，下载下来的Xdebug文件为php\_xdebug-x.x.x-x.x-vcx.dll，这是由于Xdebug是作为PHP模块的形式被安装配置与使用的。

*安装Xdebug*

将下载的php\_xdebug-x.x.x-x.x-vcx.dll复制到PHP安装目录下的ext目录，ext目录专门用来存放PHP扩展库DLL文件。

![SouthEast][]

注：我这里的php\_xdebug.dll 是我的PHPstudy自带的，下面的php\_xdebug-2.4.0-5.4-vc9.dll是我自己下载的，下载地址  https://xdebug.org/files/

*配置php.ini*

安装Xdebug的最后一步就是配置php.ini文件

![SouthEast 1][]

注：1.其中zend\_extension="H:\\phpstudy\\phpstudy20161103\\php\\php-5.4.45\\ext\\php\_xdebug-2.4.0-5.4-vc9.dll"才是真正的配置，请根据自己的目录改写。

2.其它的一些xdebug的属性，请根据自己的实际情况配置，上面的几项是常用的，xdebug还有许多属性。

最后重启Apache服务器，通过phpinfo()函数，可以看到

![SouthEast 2][]

**Xdebug配置提示**：PHP5.3之前版本配置Xdebug时使用zend\_extension\_ts，对于PHP5.3以上版本，使用zend\_extension。

**XDEBUG NOT LOADED AS ZEND EXTENSION信息出现的原因**

出现XDEBUG NOT LOADED AS ZEND EXTENSION的原因是在安装Xdebug时由于我们将Xdebug的DLL文件复制到了php\\ext目录下，容易以PHP扩展库的形式加载Xdebug，在php.ini文件中添加了

extension=php\_xdebug-x.x.x-x.x-vcx.dll

这是错误的Xdebug安装方式，必须以zend方式加载。

# [用xdebug 分析系统瓶颈][xdebug] #

重启之后，我们重新运行一下我们的项目，会得到两个文件

![SouthEast 3][]

留意的话可以看到这两个文件生成的位置就是我们上面配置的两个路径。

trace.xxxxxx.xt 的文件内容

![SouthEast 4][]

第一列显示的是时间，黑体的记录是话费来比较多时间的代码，这里我直截一小部分给大家看一下。

cachegrind.out.xxxxx的内容

![SouthEast 5][]

这个文件可以通过工具kcachegrind来分析，或者**PHPStorm中XDebug配置，在本文中就不说了，下次再说。**

**注：xdebug的性能测试输出文件名是可以配置的。  
默认是 xdebug.profiler\_output\_name = cachegrind.out.%p  
那个%p是服务器的pid，会输出“cachegrind.out.1408”之类的文件。  
可能这样不太方便测试很多文件的网站。另外对于单一入口的文件名都是一样的.**

**下面是我从http://blog.csdn.net/liaozhongping/article/details/46953119中复制下来的参数说明**

<table style="width:750px; margin-right:0px; margin-bottom:0px; margin-left:0px; border-width:thin; border-color:rgb(119,119,119); color:rgb(0,0,0); font-family:Arial,Verdana,Helvetica,sans-serif; font-size:13px; line-height:20px; text-align:justify; padding:0px"> 
 <tbody style="margin:0px; padding:0px"> 
  <tr style="margin:0px; padding:0px"> 
   <th style="text-align:left; padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(119,119,119); margin:0px; background-color:rgb(237,239,240)"> 符号</th> 
   <th style="text-align:left; padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(119,119,119); margin:0px; background-color:rgb(237,239,240)"> 含义</th> 
   <th style="text-align:left; padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(119,119,119); margin:0px; background-color:rgb(237,239,240)"> 配置样例</th> 
   <th style="text-align:left; padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(119,119,119); margin:0px; background-color:rgb(237,239,240)"> 样例文件名</th> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %c</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> 当前工作目录的crc32校验值</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%c</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.1258863198.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %p</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> 当前服务器进程的pid</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%p</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.5174.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %r</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> 随机数</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%r</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.072db0.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %s</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> 脚本文件名(注)</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> cachegrind.out.%s</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> cachegrind.out._home_httpd_html_test_xdebug_test_php</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %t</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> Unix时间戳(秒)</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%t</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.1179434742.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %u</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> Unix时间戳(微秒)</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%u</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.1179434749_642382.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %H</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> $_SERVER['HTTP_HOST']</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%H</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.kossu.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %R</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> $_SERVER['REQUEST_URI']</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%R</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace._test_xdebug_test_php_var=1_var2=2.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %S</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> session_id (来自$_COOKIE 如果设置了的话)</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%S</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.c70c1ec2375af58f74b390bbdd2a679d.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:center"> %%</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> %字符</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%%</td> 
   <td style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> trace.%.xt</td> 
  </tr> 
  <tr style="margin:0px; padding:0px"> 
   <td colspan="4" style="padding:3px; line-height:1.42857; vertical-align:top; border-width:thin; border-color:rgb(170,170,170); border-collapse:collapse; margin:0px; text-align:left"> 注 此项不适用于trace file的文件名</td> 
  </tr> 
 </tbody> 
</table>

从上表可以找到一些适合你的参数。

比如，我想针对每个文件生成一个输出文件。

那么我可以用：

xdebug.profiler\_output\_name = cachegrind.out.%s

多个域名的话，也可以组合使用

xdebug.profiler\_output\_name = cachegrind.out.%H.%u.%s

[Xdebug配置][Xdebug 1]

第一部分：安装  
预编译模块  
安装预编译模块是很容易的。只需要将它们放到一个目录中，并将下面的内容添加到php.ini中：（不要忘记更改路径和文件名为你自己的值，并确信你使用的是完整路）  
zend\_extension\_ts = “c:/php/modules/php\_xdebug.dll”

第二部分：基本特征:  
相关参数设置  
xdebug.default\_enable  
类型：布尔型 默认值：On  
如果这项设置为On，堆栈跟踪将被默认的显示在错误事件中。你可以通过在代码中使用xdebug\_disable()来禁止堆叠跟踪的显示。因为这是xdebug基本功能之一，将这项参数设置为On是比较明智的。

xdebug.max\_nesting\_level  
类型：整型 默认值：100  
The value of this setting is the maximum level of nested functions that are allowed before the script will be aborted.  
限制无限递归的访问深度。这项参数设置的值是脚本失败前所允许的嵌套程序的最大访问深度。

第三部分：堆栈跟踪:  
相关参数设置  
xdebug.dump\_globals  
类型：布尔型 默认值：1  
限制是否显示被xdebug.dump.\*设置定义的超全局变量的值  
例 如，xdebug.dump.SERVER = REQUEST\_METHOD,REQUEST\_URI,HTTP\_USER\_AGENT 将打印 PHP 超全局变量 $\_SERVER\['REQUEST\_METHOD'\]、$\_SERVER\['REQUEST\_URI'\] 和 $\_SERVER\['HTTP\_USER\_AGENT'\]。

xdebug.dump\_once  
类型：布尔型 默认值：1  
限制是否超全局变量的值应该转储在所有出错环境(设置为Off时)或仅仅在开始的地方(设置为On时)

xdebug.dump\_undefined  
类型：布尔型 默认值：0  
如果你想从超全局变量中转储未定义的值，你应该把这个参数设置成On，否则就设置成Off

xdebug.show\_exception\_trace  
类型：整型 默认值：0  
当这个参数被设置为1时，即使捕捉到异常，xdebug仍将强制执行异常跟踪当一个异常出现时。

xdebug.show\_local\_vars  
类型：整型 默认值：0  
当这个参数被设置为不等于0时，xdebug在错环境中所产生的堆栈转储还将显示所有局部变量，包括尚未初始化的变量在最上面。要注意的是这将产生大量的信息，也因此默认情况下是关闭的。

第四部分：分析PHP脚本  
相关参数设置  
xdebug.profiler\_append  
类型：整型 默认值：0  
当这个参数被设置为1时，文件将不会被追加当一个新的需求到一个相同的文件时(依靠xdebug.profiler\_output\_name的设置)。相反的设置的话，文件将被附加成一个新文件。

xdebug.profiler\_enable  
类型：整型 默认值：0  
开放xdebug文件的权限，就是在文件输出目录中创建文件。那些文件可以通过KCacheGrind来阅读来展现你的数据。这个设置不能通过在你的脚本中调用ini\_set()来设置。

xdebug.profiler\_output\_dir  
类型：字符串 默认值：/tmp  
这个文件是profiler文件输出写入的，确信PHP用户对这个目录有写入的权限。这个设置不能通过在你的脚本中调用ini\_set()来设置。

xdebug.profiler\_output\_name  
类型：字符串 默认值：cachegrind.out%p  
这个设置决定了转储跟踪写入的文件的名称。

第五部分：远程Debug  
相关参数设置  
xdebug.remote\_autostart  
类型：布尔型 默认值：0  
一般来说，你需要使用明确的HTTP GET/POST变量来开启远程debug。而当这个参数设置为On，xdebug将经常试图去开启一个远程debug session并试图去连接客户端，即使GET/POST/COOKIE变量不是当前的。

xdebug.remote\_enable  
类型：布尔型 默认值：0  
这个开关控制xdebug是否应该试着去连接一个按照xdebug.remote\_host和xdebug.remote\_port来设置监听主机和端口的debug客户端。

xdebug.remote\_host  
类型：字符串 默认值：localhost  
选择debug客户端正在运行的主机，你不仅可以使用主机名还可以使用IP地址

xdebug.remote\_port  
类型：整型 默认值：9000  
这个端口是xdebug试着去连接远程主机的。9000是一般客户端和被绑定的debug客户端默认的端口。许多客户端都使用这个端口数字，最好不要去修改这个设置。

注意：所有以上参数修改后，要重启Apache才能生效！

[Xdebug]: http://xdebug.org/download.php
[SouthEast]: /images/20220601/3662934336904b81beb4b216549b848b.png
[SouthEast 1]: /images/20220601/b9df421431514b498ca61ac07e929cab.png
[SouthEast 2]: /images/20220601/3bb27b06fe324de192670e8a89dafc52.png
[xdebug]: http://www.cnblogs.com/phpzxh/archive/2012/11/04/2754327.html
[SouthEast 3]: /images/20220601/0bb22b9cf3524e3da5b5fc320431408e.png
[SouthEast 4]: /images/20220601/55b53112ce8c4d028a713cb96a167ae5.png
[SouthEast 5]: /images/20220601/0c26bb2cd6ae44f9bd22888ce8ad224d.png
[Xdebug 1]: http://hi.baidu.com/sz_xiaofeng/blog/item/390aa858d4a71189800a18cd.html