hyperf使用Xdebug调试断点

1. 前言

昨天在hyperf交流群里有道友问hyperf框架能否使用Xdebug进行断点调试，在与群友沟通了下，并将自己的配置发给对方看后，最终也没能解决。
因为之前写go的原因，个人比较喜欢使用debug对代码进行断点调试，目前写php也经常使用Xdebug进行调试，但是目前公司项目都是使用常规的PHP-FPM模式，swoole模式下应该不太一样。
所以今天我打算一探究竟，hyperf框架是否能够使用Xdebug。

2. 环境

今天讲的是两种环境下使用Xdebug进行断点调试，分别为 本地环境直接调试 和 使用docker环境调试

2.1 本地环境

os: Mac OS
php: 8.1.21
swoole: 5.0.3
xdebug: 3.2.2

2.2 docker环境

os: apline
php: 8.1.25
swoole: 5.0.3
xdebug: 3.1.5

2.3 注意事项

1. Xdebug的大版本不同，配置也相对不同，本次环境中使用的是3.x版本，如果有使用2.x版本的朋友请注意修改对应php.ini中Xdebug配置

2. swoole版本小于5.x的无法支持Xdebug 如使用低于5.x版本会报错：Fatal error: Uncaught ErrorException: Swoole\Server::start(): Using Xdebug in coroutines is extremely dangerous, please notice that it may lead to coredump!
如图：

3. 本地环境使用Xdebug

3.1 在php.ini配置Xdebug

具体的配置如下：

[Xdebug]
zend_extension="xdebug.so"
# xdebug模式
xdebug.mode=debug

# 请求开始时自动开启
xdebug.start_with_request=yes

# client_host client_port 是 xdebug v3.x 中才有的选项
xdebug.client_host=127.0.0.1 

# 此处为监听端口，配置集成开发环境时需要（重要）
xdebug.client_port=9003
xdebug.collect_return=true

# 此处搭配的 PHPSTORM，配置 PHPSTORM 时需要
xdebug.idekey=PHPSTORM 

# 下面配置项，是在 xdebug v2.x 下常用的配置项，不要在 xdebug v3.x 下使用
##   xdebug.remote_host=127.0.0.1
##   xdebug.remote_handle=dbgp
##   xdebug.remote_enable=on

3.2.1 phpstorm中增加【hyperf运行脚本】 - 与3.2.2选其中一种即可

点击【运行/调试配置】-> 左上角+号 -> PHP脚本
名称：hyperf-xdebug (可任意编写)
文件：/Users/liang/www/github.com/liangguifeng/hyperf-test/bin/hyperf.php (对应调试hyperf项目的下bin/hyperf.php文件)
实参：start (hyperf的启动参数)
解释器：/usr/local/Cellar/php@8.1/8.1.21/bin/php(8.1.21) (自己的php路径，需要提前在phpstorm中配置号)

如图：

调试【hyperf运行脚本】

3.2.2 phpstorm中配置debug监听 - 与3.2.1选其中一种即可

phpstorm开启监听debug

3.4 phpstorm中增加断点

因为hyperf框架中默认开启了AOP，所以会产生代理类文件，php会解析代理类文件，而非直接解析对应controller，如图：

正确断点，应该找到对应的代理类文件，进行debug断点，代理类文件默认存储在
项目目录/runtime/container/proxy/ 中
如图：

3.5 发起请求

终端中请求，如图：

phpstorm断点展示，如图：

4. docker环境使用Xdebug

4.1 在php.ini配置Xdebug

具体的配置如下：

[Xdebug]
# xdebug模式
xdebug.mode=debug

# 请求开始时自动开启
xdebug.start_with_request=yes

# client_host client_port 是 xdebug v3.x 中才有的选项，`host.docker.internal` 是docker内部访问宿主机的host
xdebug.client_host=host.docker.internal

# 此处为监听端口，配置集成开发环境时需要（重要）
xdebug.client_port=9003
xdebug.collect_return=true

# 此处搭配的 PHPSTORM，配置 PHPSTORM 时需要
xdebug.idekey=PHPSTORM 

# 下面配置项，是在 xdebug v2.x 下常用的配置项，不要在 xdebug v3.x 下使用
##   xdebug.remote_host=127.0.0.1
##   xdebug.remote_handle=dbgp
##   xdebug.remote_enable=on

4.2 phpstorm中配置debug监听 - 一定要先开启监听再启动hyperf，否则无法断点

phpstorm开启监听debug

4.3 docker内部启动hyperf框架 - 一定要先开启监听再启动hyperf，否则无法断点

# 如果php.ini配置了Xdebug的配置，直接运行即可
php bin/hyperf.php start

# 如果没有配置，可用-d参数临时修改当前php脚本运行的ini配置
php -dxdebug.mode=debug -dxdebug.client_port=9003 -dxdebug.client_host=host.docker.internal /Users/liang/www/github.com/liangguifeng/hyperf-test/bin/hyperf.php start

4.4 phpstorm中增加断点

因为hyperf框架中默认开启了AOP，所以会产生代理类文件，php会解析代理类文件，而非直接解析对应controller，如图：

正确断点，应该找到对应的代理类文件，进行debug断点，代理类文件默认存储在
项目目录/runtime/container/proxy/ 中
如图：

4.5 发起请求

终端中请求，如图：

phpstorm断点展示，如图：

4.6 其他方案 - 未成功，但是理论可行

点击【运行/调试配置】-> 左上角+号 -> PHP远程调试

配置如图：
服务器配置(实际就是设置一个监听端口和目录映射)：

配置好对应的Xdebug key

理论上来说，当如下图点击调试【hyperf-xdebug-remote】的时候，会监听刚刚服务器配置的端口，docker中通过host.docker.internal+端口号，应该可以访问到对应端口，所以理论上是可以成功debug的。
但是我执行php bin/hyperf.php start时，却卡主了，不会往下运行，也不纠结了，有一种方式就行，如果有知道原因的道友可以留言

5. 结语

每个人都有自己习惯调试程序的方式，之前用laravel的时候dd习惯了，后面写了几年go，开始习惯debug了，当然也有很多人喜欢用var_dump，总之不管黑猫白猫，能抓老鼠就是好猫，debug方式而已，大家根据喜好自行挑选。

个人博客：findcat.cn
github：github.com/liangguifeng

本作品采用《CC 协议》，转载必须注明作者和本文链接