前提条件
- 已安装 PHP (版本 >= 7.2)
- 已安装 Composer
- 已安装 Xdebug 扩展并正确配置
- 已安装 Visual Studio Code
- 已安装 VS Code 的 PHP Debug 扩展
创建 Slim 项目
首先，使用 composer 创建一个新的 slim 项目：
composer create-project slim/slim-skeleton simpleAPI
进入项目目录：
cd simpleAPI
启动 PHP 内置的 Web 服务器：
composer start
默认情况下，服务器会在 localhost:8080 启动。
配置 Xdebug
确保 Xdebug 扩展已正确安装并配置。通常，需要在 php.ini 文件中添加如下配置：
zend_extension=xdebug.so xdebug.mode=debug xdebug.start_with_request=yes xdebug.client_host=127.0.0.1 xdebug.client_port=9003
注意: 确保 xdebug.so 的路径正确，并根据你的 Xdebug 版本调整配置。
配置 VS Code 的 launch.json
关键在于正确配置 VS Code 的 launch.json 文件，特别是 cwd 属性和 program 属性。以下是一个推荐的 launch.json 配置：
{
"version": "0.2.0",
"configurations": [
{
"name": "Launch",
"type": "php",
"request": "launch",
"runtimeArgs": [
"-dxdebug.mode=debug",
"-dxdebug.start_with_request=yes",
"-S",
"localhost:8089"
],
"program": "",
"cwd": "${workspaceRoot}/public",
"port": 9003,
"serverReadyAction": {
"pattern": "Development Server \\(http://localhost:([0-9]+)\\) started",
"uriFormat": "http://localhost:%s",
"action": "openExternally"
}
}
]
}配置说明：
- cwd: 设置为 ${workspaceRoot}/public。这非常重要，因为 Slim 应用的入口文件通常位于 public 目录下。
- program: 设置为空字符串 ""。不要指定 index.php 作为程序入口。
- port: 确保与 php.ini 中 xdebug.client_port 的值一致 (默认为 9003)。
- runtimeArgs: 指定了调试模式和端口，以及启动内置 web 服务器的参数。
- localhost:8089: 将 localhost:0 修改为具体的端口号，例如 localhost:8089。如果使用端口 0，可能会导致调试器无法正常工作。确保选择一个未被占用的端口。
调试步骤
- 在 VS Code 中打开 Slim 项目。
- 打开 launch.json 文件，并粘贴上述配置。
- 在 Slim 应用的代码中设置断点。
- 在 VS Code 中启动调试器（选择 "Launch" 配置）。
- 在浏览器中访问你的 Slim 应用 (例如 http://localhost:8089)。
- 如果配置正确，VS Code 应该会在断点处停止，允许你检查变量和逐步调试代码。
常见问题和注意事项
- 断点未命中： 确保 cwd 属性设置为 public 目录。检查 Xdebug 是否正确安装和配置。确保端口号配置一致。
- Xdebug 未连接： 检查防火墙是否阻止了 Xdebug 的连接。
- 端口冲突： 如果端口 9003 被占用，尝试修改 php.ini 和 launch.json 中的端口号。
- Xdebug 版本： 不同版本的 Xdebug 的配置可能略有不同，请参考 Xdebug 的官方文档。
总结
通过正确配置 VS Code 的 launch.json 文件，特别是 cwd 属性，可以成功地在 Slim 项目中使用 Xdebug 进行调试。确保 Xdebug 正确安装和配置，并注意端口号和防火墙设置。希望本教程能够帮助你更高效地开发和调试 Slim 框架项目。
