Xdedubg 调试指南

网上关于 Xdebug 的安装调试教程很多，但绝大部分仅限于 Xdebug 的安装、配置以及如何使用IDE、Xdebug调试程序。其他语言（例如 Java 的 JDB、Python 的 PDB、Go 的 Delve等）都可以使用自带调试工具，并直接通过IDE进行断点调试。然而PHP自带的 phpdbg 并不方便大型框架项目的调试，最常用的调试工具是Xdebug，结合PhpStorm或 Visual Studio Code进行断点打印、单步执行、堆栈跟踪、变量监视、远程调试等操作。

1.PHP常用的几种调试工具

下面是PHP常用的几种调试工具进行对比：

调试工具	PHP版本支持	功能特性	集成支持	配置复杂度	调试方式
Xdebug	php 5.2 +	基本调试功能、代码覆盖率分析、性能分析、远程调试。	支持多种 IDE 集成，如 PhpStorm、Visual Studio Code、Eclipse 等。	相对复杂，但提供强大的调试功能。	命令行、IDE
Zend Debugger	php 4.3. ~ php 5.3.	基本调试功能、代码覆盖率分析、性能分析	通常与 Zend Studio 集成，与其他 IDE 的集成相对有限。	有一定的使用限制，适合商业用户。	IDE
phpdbg	php 5.6 +	基本调试功能	主要是命令行工具，与 IDE 的集成相对较弱。	相对简单易用，适用于简单的调试场景。	命令行

如果只需要基本调试功能，并且熟悉命令行操作，那么 phpdbg 提供的已经足够。如果您需要更强大的调试功能，并且希望使用 IDE 进行调试，那么 Xdebug 或 Zend Debugger 是一个更好的选择。Zend Debugger 早已停止维护，且通常与 Zend Studio 集成，与其他 IDE 的集成相对有限，当面对中大型项目开发调试时，使用 Xdebug 已成为主流选择和事实标准。

2、Xdebug的安装与使用

2.1 Xdebug版本选择

Xdebug 官方提供了适配各个 PHP 版本的扩展包，开发者可以自行根据需要下载对应的扩展包。如果你不清楚需要哪个版本的Xdebug，你可以这样。粘贴 phpinfo() 的完整输出（HTML版本、HTML源代码或 php -i 输出的复制和粘贴）并提交 Installation Wizard，此页面将会告知你需要下载的Xdebug版本。

2.2 在 php.ini 开启 Xdebug

下载建议安装的 Xdebug 扩展包版本，将扩展包移动到 PHP 安装目录下的 ext 文件夹下后。在 php.ini 配置 xDebug 的相关参数。值得注意的是 Xdebug3 和 Xdebug2 的参数配置差异很大，具体可参考 Xdebug 官网的配置说明 Upgrading from Xdebug 2 to 3。

这里我将给出两个版本配置示例。
Xdebug3 的 php.ini 的参数配置

[Xdebug]
zend_extension=xdebug

;作为 XDEBUG_SESSION_START 的值，是通知 PHP 开启调试的标识
xdebug.idekey=phpstorm

;xdebug3.0中用于代替之前的xdebug.remote_enable=On
xdebug.mode=debug

;xdebug3.0中用于代替之前的xdebug.remote_autostart，trigger对应之前的off，yes对应之前的on
xdebug.start_with_request=trigger

;xdebug3.0中用于代替之前的xdebug.remote_connect_back=On，它会自动从$_SERVER['HTTP_X_FORWARDED_FOR']
;或$_SERVER['REMOTE_ADDR']变量中获取ip，当然因为$_SERVER只有服务器模式有所以客户端模式是用不了的(可配置其它变量)
;如果找不到ip它会回退(fallback)到xdebug.client_host指定的ip
xdebug.discover_client_host=on

;xdebug3.0中用于代替之前的xdebug.remote_host
xdebug.client_host=localhost

;xdebug3.0中用于代替之前的xdebug.remote_port
xdebug.client_port=9003

;固定填dbgp(因为目前只支持这个协议，也只有这个协议)
xdebug.remote_handler=dbgp

;xdebug3.0中用于代替之前的xdebug.remote_autostart, 是否自动启动调试器
xdebug.start_with_request=yes

Xdebug2 的php.ini 的参数配置

zend_extension=xdebug

;作为 XDEBUG_SESSION_START 的值，是通知 PHP 开启调试的标识
xdebug.idekey=phpstorm

;开启xdebug远程调试功能，On或1都表示开启
xdebug.remote_enable=on

;指定IDE所在电脑的ip或域名(暂时指定本机，即127.0.0.1)
xdebug.remote_host=localhost

;指定IDE debug端口(xdebug需要通过该端口与IDE通讯)
xdebug.remote_port = 9001

;打开后，xdebug会忽略remote_host值并自动从$_SERVER中获取来源ip
xdebug.remote_connect_back=on

;固定填dbgp(因为目前只支持这个协议，也只有这个协议)
xdebug.remote_handler = dbgp