[VS CODE] PHP除錯環境配置步驟

Wampserver32
整合部署環境，整合Apache伺服器 + MySQL + PHP一體的伺服器配置環境
Wampserver版本: 3.0.6 32bit
PHP版本: PHP 5.6.25
XDebug

Xdebug is an extension for PHP to assist with debugging and development. It contains a single step debugger to use with IDEs;

XDebug版本： v2.4.1

VSCode
微軟提供的一款文字編輯器，使用起來挺帶感。介面友好，支援語種非常全面，外掛生態鏈健全。
PS： 注意需要在首頁安裝php的支援檔案

PHPDebug
vs code plugin - VS code ide 外掛
用於適配vs code ide的偵錯程式

PHP Debug Adapter for Visual Studio Code

部署除錯環境步驟如下：

STEP1 安裝配置VS-Code-PHP

• 安裝VS-Code環境

• 安裝PHPDebug - 擴充套件選項中輸入查詢安裝，重啟環境 - 如下圖所示:

  

• 檔案->首選項->設定 ===> 配置PHP執行檔案路徑，如下圖所示:

  

配置內容如下，因為wamp存在兩個php版本，本次測試使用的是5.6版本。

“php.validate.executablePath”: “C:/wamp/bin/php/php5.6.25/php.exe”,

• 新建需要除錯的檔案，例如index.php，檔案的目錄應存在於伺服器的目錄下，目標檔案必須要能夠被webserver訪問。

STEP2 安裝配置XDebug

• 下載安裝XDebug
  安裝方法可以參考XDebug官方網站
  https://xdebug.org/download.php
  不需要安裝，下載後文件是一個dll外掛

  由於我們使用Wampserver，查詢安裝目錄下存在如下dll

  .\wamp\bin\php\php5.6.25\zend_ext\php_xdebug-2.4.1-5.6-vc11.dll

  該dll為Wampserver提前安裝好的XDebug，本次測試使用該版本的XDebug進行測試。

• 配置XDebug

  • 找到php.ini檔案，在該檔案尾部新增如下設定：
    

    [xdebug]
    zend_extension = “c:/wamp/bin/php/php5.6.25/zend_ext/php_xdebug-2.4.1-5.6-vc11.dll”
    xdebug.remote_enable = On
    xdebug.remote_autostart = On

  
  zend_extension 表示擴充套件的XDebug外掛路徑，選擇上一步安裝的路徑
  xdebug.remote_enable 使能遠端除錯
  xdebug.remote_enable 使能自動遠端除錯 - 該選項也必須選中

  • 檢視是否安裝成功，可以進入瀏覽器（Wampserver配置成功）localhost，檢視phpinfo()，如下圖所示：

    

    上述配置兩個開關必須為開啟狀態才能夠啟用除錯，否則會導致無法啟動偵錯程式，無法除錯。

PS：php.ini 路徑如下:

C:\wamp\bin\apache\apache2.4.23\bin\php.ini

重點關注
上面的路徑選用apache伺服器下的php.ini配置檔案，一定不能選擇php版本對應目錄下的php.ini修改，否則將導致無法觸發斷點。

C:\wamp\bin\php\php5.6.25\php.ini

STEP3 配置VSCode偵錯程式

• 啟用偵錯程式，按下F5或者debug按鈕，會彈出如下圖所示下拉框：

  

• 選擇後，會在工作目錄下面出現.vode資料夾，資料夾下會出現一個名為”launch.json“的配置檔案。該檔案就是該偵錯程式對應的配置檔案，勿需修改。預設內容如下：

{
    // 使用 IntelliSense 瞭解相關屬性。 
    // 懸停以檢視現有屬性的描述。
    // 欲瞭解更多資訊，請訪問: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Listen for XDebug",
            "type": "php",
            "request": "launch",
            "port": 9000
        },
        {
            "name": "Launch currently open script",
            "type": "php",
            "request": "launch",
            "program": "${file}",
            "cwd": "${fileDirname}",
            "port": 9000
        }
    ]
}

PS： 此處PHP對應的就是PHP Debug外掛，如果專案資料夾中有其他前端程式碼需要使用Debug for Chrome進行除錯，可把.vode資料夾刪除後，重啟選擇偵錯程式進行配置。

• 選擇除錯介面

  
  選擇”Listen for XDebug“一項

• 下斷點，按下F5介面進入除錯狀態

• 進入瀏覽器中進入該專案下的php檔案，觸發斷點，正常除錯完成。

擴充套件：

其中還有另外一項Launch currently open script，其主要功能是離線除錯，依賴於PHP-CLI。

值得一提的是，psysh也是依賴於php-cli。如果問cli到底是什麼，目前我能理解的就是本地的指令碼直譯器，地位等價於web伺服器中的指令碼直譯器。如果使用該方式進行除錯，可不需要架設伺服器除錯程式碼邏輯。
需要注意的關鍵點，如果在該除錯模式下，php.ini檔案不再選擇Apache伺服器下的php.ini檔案，應該選擇PHP安裝目錄下的php.ini檔案配置與STEP2相同的配置選項。同理如果修改PHP安裝目錄下的php.ini檔案，在phpinfo中是無法檢視到Xdebug進行了修改。