PHP 调试 - 方式

之前学 Java 的时候，一直使用 IDE 的 console 控制台进行调试。后来搞 PHP 后，习惯在代码里面 echo 和 exit，然后在浏览器刷新看效果，把单步调试、变量值查看等常用的调试方式给忘了。其实通过 IDE 集成的控制台进行调试更高效。

下面的示例都是基于 Windows 下的 LNMP 环境，其安装方式可以 参考这里。

常用调试方式

通过浏览器打印信息进行调试

方法

在代码中添加 echo、var_dump、print_r 和 exit，在浏览器中查看输出。

优缺点

优点：

• 简单，使用方便，不用安装插件
• 对于自己写的代码，或比较熟悉的框架，可以这么用

缺点：

• 对于多分支逻辑，需要加很多代码或尝试多次
• 对于不熟悉的逻辑，无法反映出完整的执行流程。
• 有可能将调试语句遗漏在项目中
• 无法单步执行

技巧

调试时，为了格式化输出变量，往往需要在项目中实现自己的 dump() 函数。利用 Composer，可以全局安装 symfony/var-dumper 包中的 dump() 函数，使所有项目都可以使用，而无需改动项目。

• 全局安装 symfony/var-dumper 包：
  
  默认会安装到 ${HOME}/.config/composer 目录

composer global require symfony/var-dumper 

• 修改 php.ini 文件，执行 PHP 代码之前先 include 指定的文件

auto_prepend_file = ${HOME}/.config/composer/vendor/autoload.php

使用 Xdebug 进行调试

XDebug 是 C/S 结构，其中 Client 是 PHP 中安装的 Xdebug，Server 是 IDE 中安装的插件，使用 DBGP 协议通信。PHP 运行脚本时，通过 Xdebug 插件向 IDE 发送调试信息，并接收 IDE 发过来的控制信号。

需要为 PHP 安装并开启 Xdebug，然后设置 IDE 的 Xdebug 插件，使二者可以通信。

优缺点

• 支持单步调试和任意变量值的获取
• 配置复杂，需要 IDE 安装插件
• 支持跟浏览器的配合，需要请求中携带 XDEBUG_SESSION_START 参数

Web App 调试

对于 web 应用，要开启 Xdebug 调试模式，必须在浏览器发送的请求中添加额外的标志。可以在 GET/POST/Cookie 参数中添加 XDEBUG_SESSION_START=session_name，这样 Xdebug 就明白这个请求需要调试，去连接 IDE。

但每次手工设置也很麻烦，有两种方式简化操作：

• 使用 IDE 提供的方式。对于 PhpStorm，参考 Debugging PHP Web Applications with Run Debug Configurations。使用时需要配置好 IDE 中的 Web Server，然后设置一个 PHP Web Application，点击 Debug 按钮开始调试，这时 IDE会自动打开浏览器并输好网址，并添加 XDEBUG_SESSION_START=session_name。
• 使用浏览器插件，打开插件的调试开关后，插件可以自动在请求中带上对应的 Cookie。对于 Chrome 可以安装 Xdebug helper。

通过 console 终端进行调试（CLI 方式）

对于非 web 应用，例如定时任务或单元测试，可以直接在控制台进行调试。

PhpStorm 中通过 Alt+F12 快捷键打开命令行终端。但是因为 IDE 中只能显示一个终端，在开启调试后的调试终端会覆盖命令行终端，所以还是单独开一个命令行终端吧（Windows 下可以使用 DOS 窗口或 PowerShell）。

方法及原理

web 应用通过 GET/POST/Cookie 参数标志调试请求，而非 web 应用则通过在命令行终端设置环境变量来开启调试。

两步：

• 设置环境变量 XDEBUG_CONFIG="idekey=session_name"，这个 idekey 需要跟 php.ini 中 Xdebug 部分设置的 idekey 一样。
• 在命令行终端执行脚本。执行时会唤起 IDE 的 debug 终端，可以单步调试，输出结果实时显示在命令行终端。

IDE通常提供快捷操作，对于 PHPStorm 可以参考 Debugging PHP CLI scripts with PhpStorm。

通过 IDE 启动调试后，IDE 会启动 Xdebug 插件监听某个端口（PhpStorm 默认是 9000，但是这跟 PHP-FPM 冲突了，可以改为 9001），获取 PHP 服务器返回的调试信息。

D:\lnmp\php72\php.exe -dxdebug.remote_enable=1 -dxdebug.remote_mode=req -dxdebug.remote_port=9001 -dxdebug.remote_host=127.0.0.1 D:\lihongfeng\workspace\untitled\index.php

设置、查看和释放环境变量

• Linux

export XDEBUG_CONFIG="idekey=session_name" // 设置环境变量
echo $XDEBUG_CONFIG // 查看环境变量
unset XDEBUG_CONFIG // 删除环境变量

• Windows

set XDEBUG_CONFIG="idekey=session_name" // 设置环境变量
echo %XDEBUG_CONFIG% // 查看环境变量
set XDEBUG_CONFIG // 查看环境变量
set XDEBUG_CONFIG= // 删除环境变量