在 Sublime Text 中配置 XDebug 實現 PHP 單步除錯

在 Sublime Text 中配置 XDebug 實現 PHP 單步除錯

本文記錄在 LNMP 環境下，於 Sublime Text 3 安裝並設定 XDebug 進行 PHP 程式碼單步除錯的完整流程，包含伺服器端擴展安裝、設定檔調整、編輯器外掛安裝與常用快捷鍵操作。

1. 伺服器端安裝 XDebug

Ubuntu/Debian 系統可直接使用 apt 安裝：

sudo apt-get update
sudo apt-get install php5-xdebug

安裝完成後，系統會自動建立預設設定檔 /etc/php5/mods-available/xdebug.ini。編輯該檔案，加入以下關鍵設定以啟用遠端除錯：

zend_extension="/usr/lib/php5/20131226/xdebug.so"
xdebug.remote_enable=1
xdebug.remote_host=127.0.0.1
xdebug.remote_port=9000
xdebug.remote_handler=dbgp
xdebug.remote_mode=req
xdebug.remote_connect_back=1
xdebug.remote_autostart=0
xdebug.profiler_enable=1
xdebug.profiler_output_dir=/tmp
xdebug.trace_output_dir=/tmp

修改完成後重啟 PHP-FPM 使設定生效：

sudo /etc/init.d/php5-fpm restart

2. Sublime Text 安裝 XDebug 客戶端外掛

1. 安裝 Package Control（若尚未安裝）。
2. 按 Ctrl+Shift+P 開啟命令面板，輸入 Install Package，搜尋並安裝 XDebug Client（或 SublimeXDebug）。
3. 安裝完成後，選單會出現 Tools > XDebug 選項。

3. 開啟除錯會話與常用快捷鍵

• 啟動/停止除錯： Ctrl+Shift+F9（開啟除錯面板並開始監聽 9000 埠）
• 設定斷點： Ctrl+F8（在程式碼行切換斷點）
• 執行到下一個斷點： Ctrl+Shift+F5
• 單步執行： Ctrl+Shift+F6
• 步入函式： Ctrl+Shift+F7
• 步出函式： Ctrl+Shift+F8

4. 實測除錯流程

1. 在專案建立測試檔 test.php，寫入簡單迴圈並設定斷點。
2. 瀏覽器訪問 https://127.0.0.1/test.php，請求會觸發 XDebug 連線回 Sublime Text。
3. 編輯器自動停在斷點處，此時可檢視變數值、呼叫堆疊、超全域變數等資訊。
4. 使用上述快捷鍵逐步執行、觀察變數變化。

5. 進階效能分析

XDebug 產生的 cachegrind.out.* 檔案可用 KCachegrind (Linux) 或 WinCacheGrind (Windows) 圖形化分析，找出效能瓶頸（如過多 SQL 查詢、函式呼叫耗時）。