NetBeans+Xdebug调试php代码

本文目录：

Xdebug的工作原理
Xdebug扩展的配置
NetBeans的配置
调试实例
本文小结
参考文档

Xdebug：是PHP的调试器和分析器（Debugger and Profiler Tool for PHP）。

本章着重讲PHP的调试。

日常开发PHP，有时遇到需要频繁打印变量的情况，一直用 var_dump 会很麻烦。

又或者用了一个新的框架，或阅读一些比较大的开源项目，梳理代码流程就很重要了。

如果用上 Xdebug 的话，就很方便，你可以在程序中打断点，单步运行，运行中修改变量值等。

方便于代码问题的定位，和代码流程的梳理。

开发时常用 NetBeans IDE，那如何在IDE中加上 Xdebug 这个调试利器呢？

1、 Xdebug的工作原理

上图来自官网，左边是任何支持 Xdebug 的IDE（本文中就是Netbeans啦），当然，这个IDE 你也可以自己实现，你只要遵循和用上官方提供的 Xdebug 接口，就可以轻松实现该功能。

右边是运行着PHP的服务器，配置双边的通信IP地址、端口号（如默认9000）和一些辅助参数，如指定使用调试协议为 DBGP ，默认也是这个协议，目前应该也只支持这个协议了。

在当前调试的URL后面加上了 XDEBUG_SESSION_START 的请求参数，参数值为客户端标识(相当于用户名，用以区别不同的客户端)，如本文中的 netbeans-xdebug，然后向PHP服务器发送请求，服务器的Xdebug监测到这个参数，自动进入调试模式，双边建立了连接。结束调试时也发一个URL，打上 XDEBUG_SESSION_STOP 参数。

请求例子如：(*http://tp5/* 是我本地服务器的测试地址)

http://tp5/?XDEBUG_SESSION_START=netbeans-xdebug

2、 Xdebug扩展的配置

我们按照工作原理中的配置内容，来配置一下PHP的扩展Xdebug。

打开 php.ini，加上扩展吧：（有些集成环境已经有 Xdebug 扩展，如 Wamp，不必再折腾，配一下参数即可）

[xdebug]
zend_extension ="你的php路径/zend_ext/php_xdebug-版本号.dll"
//注意要跟php版本号对应，如果是Apache的话，选择ts版本（线程安全）

后边配置如下内容：

xdebug.remote_enable = on       /*打开远程调试开关*/
xdebug.remote_handler = dbgp    /*调试协议，默认dbgp，可不配*/
xdebug.remote_host = localhost  /*调试服务器的IP地址*/
xdebug.remote_port = 9000       /*端口号，默认9000，可不配*/

用 phpinfo() 查看确保 Xdebug 运行了。

3、 NetBeans的配置

打开 NetBeans 中如下选项，按需配置吧，本地调试的话，一般默认就好，可以参考官网进行配置。

下面的 会话ID 正是 XDEBUG_SESSION_START 等的参数。

右键项目，选择属性，配置一下服务器的地址，选择远程站点的需要多配置一些目录路径等：

4、调试实例

我这边拿个 Thinkphp 的裸工程来进行示范。

启动web服务器，确保xdebug运行了，用Netbeans打开工程，选择调试的浏览器，如果对网页进行细致的查看的话，推荐使用 嵌入式WebKit浏览器，不然IDE 每调试一次就会打开一个浏览器tab，比较多余的动作。

选择好浏览器后，单击上面的调试按钮，有如下图：

左边那个绿色的箭头表示程序运行到了这里（不包括该行），这一行其实是代码的第一行，因为上面设置中的 第一行停止 选项已经勾上了。

可以看到中间窗体正是内置浏览器，下面窗体是各种调试信息，可以看到 $_GET[XDEBUG_SESSION_START] 的值是设置中的值。

还有调用堆栈，这里就不截图了，比较直观，其实就是 debug_print_backtrace() 功能。

其他功能其实你看一下就懂的。

尝试在控制器中打一下断点，点击运行按钮，$name 的值就展现出来了，很直观方便：

修改一下 $name 的值，有：

最后点击运行按钮，网页就展示出来了，因为后面再也没有其他断点。点击 完成调试器会话 按钮，就会显示调试结束页面。

小结

Netbeans 配合 Xdebug 扩展用起来比较简单好用。

但是会有一定的性能问题，在生产环境下，在不需要调试的时候就要关闭 Xdebug 功能。

Xdebug还有profiler和trace等功能，也是分析程序性能的利器。

主要参考文档：

1、在 NetBeans IDE 中调试 PHP 源代码

2、Xdebug 配置

3、How To Configure XDebug

4、Remote Debugging

5、DBGP - A common debugger protocol for languages and debugger UI communication

-end-

版权声明：自由转载-非商用-非衍生-保持署名（创意共享3.0许可证）
发表日期：2017年5月30日