如何愉快的在PhpStorm中进行Xdebug断点调试？

灰太狼 2022-05-08 06:44 226阅读 0赞

转载：[https://blog.csdn.net/RobotYang123/article/details/80370030][https_blog.csdn.net_RobotYang123_article_details_80370030]

## 前言 ##

*  如果你厌烦了 `print_r` 、 `log` 、 `var_dump` 这类一次调试一行的方式
 *  如果你的业务复杂到一层又套一层，打 log 都救不了你的思路
 *  如果你了解断点调试，但是还没有在 `PhpStorm` 中配置过
 *  如果你想在 `前端` 页面 按菜单或按钮 调用 `API` 时，断点调试后端代码
 *  如果你想在 `Postman` 访问 API 时，断点调试后端代码

## 参考文档 ##

> 如何愉快的在PhpStorm中进行Xdebug断点调试：[https://blog.csdn.net/RobotYang123/article/details/80370030][https_blog.csdn.net_RobotYang123_article_details_80370030]  
> 如何愉快的在PhpStorm中进行Xdebug断点调试：[https://segmentfault.com/a/1190000014942730][https_segmentfault.com_a_1190000014942730]  
> PHP xdebug 模块下载：[https://xdebug.org/download.php][https_xdebug.org_download.php]  
> Xdebug helper 浏览器插件：[https://www.crx4chrome.com/crx/1716/][https_www.crx4chrome.com_crx_1716]  
> PhpStorm 本地断点调试：[https://blog.csdn.net/qq\_21386275/article/details/78109498][https_blog.csdn.net_qq_21386275_article_details_78109498]

--------------------

## PHP 安装 Xdebug 模块 ##

### Windows ###

*  这里我用的是 `Wamp3.1.0_x64`，已经默认安装了 `php_xdebug`，其他环境的 php\_xdebug 安装请自行百度哈  
    ![Wamp3.1.0\_x64 php\_xdebug][Wamp3.1.0_x64 php_xdebug]
 *  因此只需要将 `xdebug.remote_enable = On` 启用，如 Wamp3.1.0\_x64 中 PHP 5.6 的 `php.ini` 的 `xdebug` 配置如下

; XDEBUG Extension
    [xdebug]
    zend_extension ="C:/Users/robot/Program/Wamp/Wamp3.1.0_64/bin/php/php5.6.31/zend_ext/php_xdebug-2.5.5-5.6-vc11-x86_64.dll"
    xdebug.remote_enable = On
    xdebug.profiler_enable = off
    xdebug.profiler_enable_trigger = off
    xdebug.profiler_output_name = cachegrind.out.%t.%p
    xdebug.profiler_output_dir ="C:/Users/robot/Program/Wamp/Wamp3.1.0_64/tmp"
    xdebug.show_local_vars=0

### Linux ###

*  参考文档
    
     *  [https://blog.csdn.net/u011250882/article/details/48764915][https_blog.csdn.net_u011250882_article_details_48764915]
     *  [https://blog.csdn.net/woshihaiyong168/article/details/74276158][https_blog.csdn.net_woshihaiyong168_article_details_74276158]
 *  下载 xdebug.tgz 安装包
    
     *  下载地址：[https://xdebug.org/files/][https_xdebug.org_files]

### Ubuntu ###

*  参考文档
    
     *  [https://www.cnblogs.com/jingjingdidunhe/p/6955619.html][https_www.cnblogs.com_jingjingdidunhe_p_6955619.html]
 *  安装 xdebug 模块
    
     *  `sudo apt-get install php-xdebug`
 *  查看所有模块
    
     *  `php -m`
 *  查找 xdebug 安装后的扩展路径
    
     *  `find /usr/ -name 'xdebug.so'`
     *  `/usr/lib/php/20151012/xdebug.so`
 *  查找 php.ini 所在路径
    
     *  `php -i|grep 'php.ini'`
     *  `/etc/php/7.0/cli/php.ini`
 *  编辑 xdebug 配置

[xdebug]
    zend_extension="/usr/lib/php/20151012/xdebug.so"
    xdebug.remote_enable=1
    //xdebug.remote_handler=dbgp
    //xdebug.remote_mode=req
    //xdebug.remote_host=127.0.0.1
    //xdebug.remote_port=9000
    //xdebug.remote_autostart = 1 （如果开启，则无论什么请求都会进行调试响应）

## PhpStorm 配置 debug connections 服务 ##

*  在工具栏中选择 File -> setting
 *  搜索关键词 debug，选择 Languages & Frameworks 下的 PHP -> Debug
    
     *  配置默认 `端口 9000`
     *  取消强制中断  
        ![PhpStorm 配置 debug connections 服务][PhpStorm _ debug connections]

## 配置与调试 ##

*  多种调试配置方式：本质都是在 `cookie` 中自动添加 `XDEBUG_SESSION=PHPSTORM`
    
     *  使用 `浏览器` `Xdebug Helper` 插件设置 `idekey`，用 debug 启动访问时，然后 cookie 会自动添加 `XDEBUG_SESSION`
     *  使用 `请求体 request` 中设置 `XDEBUG_SESSION_START=PHPSTORM` 请求参数，然后 cookie 会自动添加 `XDEBUG_SESSION`
        
         *  在请求的 `URL` 后追加，如 `http://localhost:500/api/TestQ/xdebug?XDEBUG_SESSION_START=PHPSTORM`
         *  在请求的 `body` 中追加，如 `request.body.XDEBUG_SESSION_START=PHPSTORM`
     *  使用 `PhpStorm` 配置 `Debug Configuration 与 Servers` ，用 PhpStorm debug 启动访问时，URL会自动追加 `XDEBUG_SESSION_START 请求参数`，然后 cookie 会自动添加 `XDEBUG_SESSION`

--------------------

### 浏览器 Xdebug Helper 插件方式 ###

优缺介绍

*  **优点：**
    
     *  无需 PhpStorm 配置 Debug Configuration 与 Servers
     *  只要配置一致的 `idekey=PHPSTORM` 或在 cookie 中添加 `XDEBUG_SESSION=PHPSTORM`
        
         *  `Xdebug Helper` 配置 `idekey=PHPSTORM` 后，在启用 debug 模式时，会自动在当前访问 url 所在域名（如 localhost:500）下的 cookie 中添加 `XDEBUG_SESSION=PHPSTORM`
         *  `前端` 只需要任意页面启用 Xdebug Helper 的 debug 模式即可，原理如上（但要确认你的 client request 携带的 cookie 可以正确到达 server request
         *  `Postman` 只需要指定域名（如 localhost）的 `cookie` 中添加一次 `XDEBUG_SESSION=PHPSTORM` 即可
         *  `PhpStorm` 中只需开启 `Listening Debug Connections`（就是顶部路径栏中右边那个`小电话`图标）
 *  **缺点：**
    
     *  需要安装 Xdebug Helper

安装 Xdebug helper 插件

*  下载 `Xdebug helper` 插件的 `crx` 文件，在浏览器扩展程序中拖放安装即可
 *  配置插件选项，在插件上右键菜单选择“选项”，配置 `idekey` 如下  
    ![Xdebug helper 插件配置][Xdebug helper]

启用测试断点调试

*  **PhpStorm**
    
     *  在 PhpStorm 中启动你的 `小电话`
     *  设置断点  
        ![启动小电话，设置断点][70]
 *  **浏览器 URL / 前端 URL（启动 Xdebug helper 插件的 `debug 模式` ）**  
    ![启动方式一][70 1]
    
     *  然后访问你的调试文件 或者 API 地址
 *  **Postman URL**
    
     *  在指定域名（如 localhost）的 `cookie` 中添加一次 `XDEBUG_SESSION=PHPSTORM`  
        ![Postman添加cookie][Postman_cookie]  
        ![\[Postman添加XDEBUG\_SESSION=PHPSTORM][Postman_XDEBUG_SESSION_PHPSTORM]
 *  **前端 node.js / express.js 等**
    
     *  按上面的逻辑，应该是在 cookie 中添加 `XDEBUG_SESSION=PHPSTORM`，如 `response.cookie('XDEBUG_SESSION', 'PHPSTORM');`
     *  我这里用的是 `node.js + express.js` 直接在 `app.js` 中全局注入了 XDEBUG\_SESSION 的 cookie  
        ![app.js 中全局注入XDEBUG\_SESSION][app.js _XDEBUG_SESSION]
     *  虽然浏览器控制台的 Application 也显示 XDEBUG\_SESSION 的 cookie 被正确写入  
        ![控制台的 Application的XDEBUG\_SESSION][Application_XDEBUG_SESSION]
     *  然后后台 API 却没有收到该 cookie，所以 PhpStorm 的 debug 也没有生效，**原因待查……**

--------------------

### 请求体 request 中通过 XDEBUG\_SESSION\_START 请求参数 方式 ###

优缺介绍

*  **优点：**
    
     *  无需安装 Xdebug Helper
     *  无需 PhpStorm 配置 Debug Configuration 与 Servers
 *  **缺点：**
    
     *  需要在 request body 或 当前 URL 后追加 `XDEBUG_SESSION_START=PHPSTORM` 请求参数

PhpStorm 配置 debug connections 服务

*  与前文一致

启用测试断点调试

*  **PhpStorm**
    
     *  与前文一致
 *  **浏览器 URL / 前端 URL**
    
     *  关闭 Xdebug helper 插件，即切换到 `Disable 模式`；或者直接卸载
     *  在当前访问的 URL 后追加 `?XDEBUG_SESSION_START=PHPSTORM`  
        ![在当前 URL 后追加?XDEBUG\_SESSION\_START=PHPSTORM][URL _XDEBUG_SESSION_START_PHPSTORM]
 *  **Postman URL**
    
     *  在当前访问的 URL 后追加 `?XDEBUG_SESSION_START=PHPSTORM`  
        ![Postman追加?XDEBUG\_SESSION\_START][Postman_XDEBUG_SESSION_START]
 *  **前端 node.js / express.js 等**
    
     *  在 request body 中追加请求参数 `XDEBUG_SESSION=PHPSTORM`，如 `request.body.XDEBUG_SESSION_START='PHPSTORM'`

--------------------

### PhpStorm 配置 `Debug Configuration 与 Servers` 方式 ###

优缺介绍

*  **优点：**
    
     *  无需安装 Xdebug Helper
     *  无需在 request body 或 当前 URL 后追加 `XDEBUG_SESSION_START=PHPSTORM` 请求参数
 *  **缺点：**
    
     *  需要在 `PhpStorm` 中配置 Debug Configuration 与 Servers
     *  配置完 PhpStorm 后，需要点击右上角的 `甲壳虫` 图标，获取调试用的 `XDEBUG_SESSION_START=session_key`

在 `PhpStorm` 中配置 Debug Configuration 与 Servers

*  点击右上角，选择 `Edit Configurations`
 *  点击 `+ 号`，新增一个 PHP Web Page
 *  点击 Server 右边的那个 `...` ，先新建一个 Web 服务  
    ![设置PHP Web Page][PHP Web Page]
 *  然后点击右上角的 `甲壳虫` 图标，获取调试用的 `XDEBUG_SESSION_START=session_key`  
    ![点击右上角的甲壳虫图标][70 2]
 *  复制这一对 `XDEBUG_SESSION_START=12850`,之后就是和**《请求体 request 中通过 XDEBUG\_SESSION\_START 请求参数 方式》**介绍的操作一样啦，这里不再赘述。
 *  所以网络上的这一种调试方式相对繁琐多余，**目前我也不知道有何意义**。

--------------------

## 查看断点信息 ##

![查看断点信息][70 3]

### 调试快捷键 ###

*  F7 通过当前行，进入下一行，如果该行是方法，则进入方法体
 *  F8 通过当前行，进入下一行，如果该行是方法，也直接进入下一行，不进入方法体
 *  F9 通过整个流程，全部顺序执行

### 要点总结 ###

*  `PHP`安装`Xdebug`模块，设置`xdebug.remote_enable=1`或者On
 *  `Postman`在 API 域名下的`cookie`中添加`XDEBUG_SESSION=PHPSTORM`
 *  `PhpStorm`启动`小电话`，开启侦听

[https_blog.csdn.net_RobotYang123_article_details_80370030]: https://blog.csdn.net/RobotYang123/article/details/80370030
[https_segmentfault.com_a_1190000014942730]: https://segmentfault.com/a/1190000014942730
[https_xdebug.org_download.php]: https://xdebug.org/download.php
[https_www.crx4chrome.com_crx_1716]: https://www.crx4chrome.com/crx/1716/
[https_blog.csdn.net_qq_21386275_article_details_78109498]: https://blog.csdn.net/qq_21386275/article/details/78109498
[Wamp3.1.0_x64 php_xdebug]: /images/20220508/ef7a80e2c63c45b092dde43e0af5e495.png
[https_blog.csdn.net_u011250882_article_details_48764915]: https://blog.csdn.net/u011250882/article/details/48764915
[https_blog.csdn.net_woshihaiyong168_article_details_74276158]: https://blog.csdn.net/woshihaiyong168/article/details/74276158
[https_xdebug.org_files]: https://xdebug.org/files/
[https_www.cnblogs.com_jingjingdidunhe_p_6955619.html]: https://www.cnblogs.com/jingjingdidunhe/p/6955619.html
[PhpStorm _ debug connections]: /images/20220508/627cac912b9b44a796846d60cbd02dfa.png
[Xdebug helper]: /images/20220508/f20fbd1e16d34239a5dd9879309c6271.png
[70]: /images/20220508/3982c1b4ff27491496dfb83e8c61aada.png
[70 1]: /images/20220508/f77cee22de35471ab8c79028c3c0dacb.png
[Postman_cookie]: /images/20220508/0b1a3c33bab447ed878e6b98f520ca8e.png
[Postman_XDEBUG_SESSION_PHPSTORM]: /images/20220508/9dba6abca5a242888e09888348503856.png
[app.js _XDEBUG_SESSION]: /images/20220508/180fbf576b3647a7b9df6a0fd4c160fb.png
[Application_XDEBUG_SESSION]: /images/20220508/72f2472a950a40b6b0272145bd03ab79.png
[URL _XDEBUG_SESSION_START_PHPSTORM]: /images/20220508/9069d8ff0de3447ea1400163d19272b3.png
[Postman_XDEBUG_SESSION_START]: /images/20220508/d83d54b810fa47f19bd2142820d18307.png
[PHP Web Page]: /images/20220508/461140d0814941609c605bb0c79c8c26.png
[70 2]: /images/20220508/34bdbfe098c748318024459b69286c32.png
[70 3]: /images/20220508/1e6ce9dea5614abaa6cf3722634c6b40.png