Laravel Debug for artisan server

2020-05-28 本文已影响0人 M1llyn

对于 PHP 应用而言，在本地开发运行可以使用 PHP-FPM 或 Swoole 来启动一个 Server 。
而 Laravel 在 Artisan 工具里自带了一个 Serve 功能，启动一个小型的简易 PHP 服务器，节约开发环境的成本问题。

但在这个场景下，我们该如何使用 Xdebug 和 Phpstorm 来配合调试呢？
今天我们就来解决这个问题

我的环境

Mac OS 10.15.4
PHP 7.4
xDebug 3.0 Dev
PhpStorm 2019.3
Laravel 6.x LTS (理论凡是支持 artisan serve 都可以）
Chrome

安装 xDebug

可以通过 xDebug 的官网指引安装 https://xdebug.org/ 比如 Pecl 。
当然你的网络不太好的话，Pecl 老是会提示无法下载包，我也是这样，所以我列出手动安装的步骤。

git clone https://github.com/xdebug/xdebug.git
cd xdebug
phpize
./configure --enable-xdebug
make
make install

然后在 xdebug 目录下会产生一个 modules/xdebug.so 扩展文件，接下来打开 php.in 导入扩展

vim  /usr/local/etc/php/7.4/php.ini
/***/
G // 跳入最后一行

Tpis: 每个人的 php.ini 目录可能不同，请自行理解打开正确的 php.ini

在 php.ini 写入以下内容，并保存退出

[xdebug]
zend_extension="/YourPath/modules/xdebug.so"
xdebug.remote_enable = On
xdebug.remote_handler = "dbgp"
xdebug.remote_host = "localhost"
xdebug.remote_port = 9001
xdebug.idekey = PHPSTROM
/***/
:wq  // 保存并退出

配置 Debug（可跳过）

接下来打开 PhpStorm 的配置功能，搜索 Debug 打开标签页，修改 xDebug port 为 9001

Tips: 9001 是可以自由修改的，但需要和 php.ini 配置的 xdebug.remote_port 保持一致

打开配置

设置 xDebug Port

配置 PhpStorm Application Run

打开 Configuration

点击 + 号选择 PHP Built-in Web Server

键入配置

这里配置需要注意

Host 和 Port 填写 localhost 和 8000 ，同样的端口号是随你修改，但不要和其他冲突这是 PHP Web 服务器访问的端口号
DocumentRoot 选择 Laravel 项目下的 Public 文件夹
勾选 Use route Script 并选中 Laravel 项目下的 server.php 文件
最终在 InterPreter Options 输入以下配置 -dxdebug.remote_enable=1 -dxdebug.remote_mode=req -dxdebug.remote_port=9001 -dxdebug.remote_host=localhost

到这里我们发现，如果你只是想单纯的在 artisan serve 的环境下调试，文中上述的配置 Debug 和 php.ini 内容都可以去掉（php.ini 内容只需要保持 zend_extension="/YourPath/modules/xdebug.so")。
为什么文中还要提到这些的配置呢，主要是为了便于我们在使用 php-fpm 或其他运行环境以及单体 php 文件的调试时所需要的。

不难发现，在 InterPreter Options 里，我们是通过命令的方式启动了 xdebug.remote 配置 remote_mode | port | host ，所以他们会直接忽略 php.ini 里的提前配置。