前言
- 如果你厌烦了
print_r
、log
、var_dump
这类一次调试一行的方式 - 如果你的业务复杂到一层又套一层,打 log 都救不了你的思路
- 如果你了解断点调试,但是还没有在
PhpStorm
中配置过 - 如果你想在
前端
页面 按菜单或按钮 调用API
时,断点调试后端代码 - 如果你想在
Postman
访问 API 时,断点调试后端代码
参考文档
如何愉快的在PhpStorm中进行Xdebug断点调试:https://blog.csdn.net/RobotYang123/article/details/80370030
如何愉快的在PhpStorm中进行Xdebug断点调试:https://segmentfault.com/a/1190000014942730
PHP xdebug 模块下载:https://xdebug.org/download.php
Xdebug helper 浏览器插件:https://www.crx4chrome.com/crx/1716/
PhpStorm 本地断点调试:https://blog.csdn.net/qq_21386275/article/details/78109498
PHP 安装 Xdebug 模块
Windows
- 这里我用的是
Wamp3.1.0_x64
,已经默认安装了php_xdebug
,其他环境的 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
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
Linux
- 参考文档
- 下载 xdebug.tgz 安装包
Ubuntu
- 参考文档
- 安装 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
- 1
- 2
- 3
- 4
- 5
- 6
- 7
PhpStorm 配置 debug connections 服务
- 在工具栏中选择 File -> setting
- 搜索关键词 debug,选择 Languages & Frameworks 下的 PHP -> Debug
- 配置默认
端口 9000
- 取消强制中断
- 配置默认
配置与调试
- 多种调试配置方式:本质都是在
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 requestPostman
只需要指定域名(如 localhost)的cookie
中添加一次XDEBUG_SESSION=PHPSTORM
即可PhpStorm
中只需开启Listening Debug Connections
(就是顶部路径栏中右边那个小电话
图标)
- 缺点:
- 需要安装 Xdebug Helper
安装 Xdebug helper 插件
- 下载
Xdebug helper
插件的crx
文件,在浏览器扩展程序中拖放安装即可 - 配置插件选项,在插件上右键菜单选择“选项”,配置
idekey
如下
启用测试断点调试
- PhpStorm
- 在 PhpStorm 中启动你的
小电话
- 设置断点
- 在 PhpStorm 中启动你的
-
浏览器 URL / 前端 URL(启动 Xdebug helper 插件的
debug 模式
)- 然后访问你的调试文件 或者 API 地址
-
Postman URL
- 在指定域名(如 localhost)的
cookie
中添加一次XDEBUG_SESSION=PHPSTORM
- 在指定域名(如 localhost)的
-
前端 node.js / express.js 等
- 按上面的逻辑,应该是在 cookie 中添加
XDEBUG_SESSION=PHPSTORM
,如response.cookie('XDEBUG_SESSION', 'PHPSTORM');
- 我这里用的是
node.js + express.js
直接在app.js
中全局注入了 XDEBUG_SESSION 的 cookie - 虽然浏览器控制台的 Application 也显示 XDEBUG_SESSION 的 cookie 被正确写入
- 然后后台 API 却没有收到该 cookie,所以 PhpStorm 的 debug 也没有生效,原因待查……
- 按上面的逻辑,应该是在 cookie 中添加
请求体 request 中通过 XDEBUG_SESSION_START 请求参数 方式
优缺介绍
- 优点:
- 无需安装 Xdebug Helper
- 无需 PhpStorm 配置 Debug Configuration 与 Servers
- 缺点:
- 需要在 request body 或 当前 URL 后追加
XDEBUG_SESSION_START=PHPSTORM
请求参数
- 需要在 request body 或 当前 URL 后追加
PhpStorm 配置 debug connections 服务
- 与前文一致
启用测试断点调试
-
PhpStorm
- 与前文一致
-
浏览器 URL / 前端 URL
- 关闭 Xdebug helper 插件,即切换到
Disable 模式
;或者直接卸载 - 在当前访问的 URL 后追加
?XDEBUG_SESSION_START=PHPSTORM
- 关闭 Xdebug helper 插件,即切换到
-
Postman URL
- 在当前访问的 URL 后追加
?XDEBUG_SESSION_START=PHPSTORM
- 在当前访问的 URL 后追加
-
前端 node.js / express.js 等
- 在 request body 中追加请求参数
XDEBUG_SESSION=PHPSTORM
,如request.body.XDEBUG_SESSION='PHPSTORM'
- 在 request body 中追加请求参数
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 服务 - 然后点击右上角的
甲壳虫
图标,获取调试用的XDEBUG_SESSION_START=session_key
- 复制这一对
XDEBUG_SESSION_START=12850
,之后就是和《请求体 request 中通过 XDEBUG_SESSION_START 请求参数 方式》介绍的操作一样啦,这里不再赘述。 - 所以网络上的这一种调试方式相对繁琐多余,目前我也不知道有何意义。
查看断点信息
调试快捷键
- F7 通过当前行,进入下一行,如果该行是方法,则进入方法体
- F8 通过当前行,进入下一行,如果该行是方法,也直接进入下一行,不进入方法体
- F9 通过整个流程,全部顺序执行
要点总结
PHP
安装Xdebug
模块,设置xdebug.remote_enable=1
或者OnPostman
在 API 域名下的cookie
中添加XDEBUG_SESSION=PHPSTORM
PhpStorm
启动小电话
,开启侦听
备份,参考:https://blog.csdn.net/RobotYang123/article/details/80370030