在VS?Code?中調(diào)試遠(yuǎn)程服務(wù)器的PHP代碼詳解
對于PHP的調(diào)試,一般來說我們用 echo 和 var_dump 就夠用了。
有時會碰到要解決復(fù)雜的邏輯或需要確認(rèn)代碼的運行順序,這里用var_dump效率就比較低了,這時建議用斷點的方式進(jìn)行代碼調(diào)試。
這里通過 xdebug 配合vscode 的 php debug插件來實現(xiàn)。
配置步驟1. 安裝 php debug 插件在VS Code中安裝php debug插件
這時會在你的項目的 .vscode 目錄下生成 launch.json 文件:
文件內(nèi)容如下:
{ // Use IntelliSense to learn about possible attributes. // Hover to view descriptions of existing attributes. // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 'version': '0.2.0', 'configurations': [{ 'name': 'Launch built-in server and debug', 'type': 'php', 'request': 'launch', 'runtimeArgs': ['-S','localhost:8000','-t','.' ], 'port': 9003, 'serverReadyAction': {'action': 'openExternally' }},{ 'name': 'Debug current script in console', 'type': 'php', 'request': 'launch', 'program': '${file}', 'cwd': '${fileDirname}', 'externalConsole': false, 'port': 9003},{ 'name': 'Listen for Xdebug', 'type': 'php', 'request': 'launch', 'port': 9003} ]}這里定義了三種調(diào)度模式:
Launch built-in server and debug:適合沒有web server的環(huán)境,這種模式會用內(nèi)置的 PHP 調(diào)試器啟動一個簡單的 PHP Web 服務(wù)器,然后在瀏覽器中訪問 http://localhost:端口號 來訪問您的 PHP 網(wǎng)站。
Debug current script in console:這種是控制臺模式。
Listen for Xdebug:這種是監(jiān)聽xdebug,本文采用的就是這種模式。
這里我們可以先看看控制臺模式效果:
我們準(zhǔn)備一個簡單的PHP代碼:
<?php $url = 'https://hotaigc.cn'; if ($url == 'https://hotaigc.cn') {echo 'success'; } else {echo 'error'; }我們在if這里打個斷點,運行效果如圖:
然后打開調(diào)試面板(圖中1),選擇 Debug current script in console(圖中2),然后點運行(圖中3),就可以看到調(diào)試的效果
2. 安裝 xdebug在遠(yuǎn)程服務(wù)器上安裝 xdebug,我的是 ubuntu 20.4 環(huán)境,用 apt-get 安裝就可以了:
sudo apt-get install php8.1-xdebug
其他系統(tǒng)參考這里:https://xdebug.org/docs/install
這里需要注意的是xdebug需要跟php的版本保持一致,你可以通過 phpinfo()來確認(rèn)你的PHP版本。
還有一個易出錯的點是部分ubuntu版本會提示找不到xdebug包,這是因為一般都用這個PPA庫進(jìn)行安裝( https://launchpad.net/~ondrej/+archive/ubuntu/php ),但這個庫已經(jīng)不支持 ubuntu 20 以下的版本,具體見:https://wiki.ubuntu.com/Releases
如下圖,紅框以下的都已經(jīng)不支持了,只能自己想辦法從源碼編譯了:
找到 php.ini 的路徑,可以從 phpinfo() 中找:
然后添加如下參數(shù):
[xdebug]# 根據(jù)擴(kuò)展實際存放路徑填寫zend_extension=xdebug;xdebug3.0中用于代替之前的xdebug.remote_enable=Onxdebug.mode=debug;xdebug3.0中用于代替之前的xdebug.remote_autostart,trigger對應(yīng)之前的off,yes對應(yīng)之前的onxdebug.start_with_request=trigger;xdebug3.0中用于代替之前的xdebug.remote_hostxdebug.client_host='127.0.0.1';xdebug3.0中用于代替之前的xdebug.remote_connect_back=On,它會自動從$_SERVER['HTTP_X_FORWARDED_FOR'];或$_SERVER['REMOTE_ADDR']變量中獲取ip,當(dāng)然因為$_SERVER只有服務(wù)器模式有所以客戶端模式是用不了的(可配置其它變量);如果找不到ip它會回退(fallback)到xdebug.client_host指定的ipxdebug.discover_client_host=true;xdebug3.0中用于代替之前的xdebug.remote_portxdebug.client_port=9003;固定填dbgp(因為目前只支持這個協(xié)議,也只有這個協(xié)議)xdebug.remote_handler='dbgp';這是一個所有網(wǎng)上的文章都提到要設(shè)置但實際上卻沒啥用的參數(shù)(不信你可以注釋掉試試,一切都正常)xdebug.idekey='PHPSTORM'這里需要注意的是 xdebug 的 3.x 版本和 2.x 版本參數(shù)是不一樣的。
開始調(diào)試1. 打斷點這次我們寫一個簡單的 Controller 代碼(注,我這里用的是Laravel),還是在if這里加個斷點(在VS Code的行號左邊點擊一下即可):
class CommonController extends Controller{ public function test(Request $request) {$a = 1;if ($a == 1) { return phpinfo();}return 1; }}2. 啟動調(diào)試選擇Listen for Xdebug調(diào)試模式,然后啟動調(diào)試(第3張圖中有示例)
3. 在瀏覽器中打開頁面在瀏覽器中打開會運行該 Controller 方法的頁面(這里涉及到一些Laravel細(xì)節(jié),不展開講),正常情況這時瀏覽器頁面會停在加載中狀態(tài),等待調(diào)試。
4. 進(jìn)行調(diào)試這時打開 VS Code,會看到代碼執(zhí)行到斷點這里停住了,我們可以看到變量,調(diào)用堆棧,調(diào)試工具欄等信息,如下圖所示:
到此這篇關(guān)于在VS Code 中調(diào)試遠(yuǎn)程服務(wù)器的PHP代碼的文章就介紹到這了,更多相關(guān)VS Code 調(diào)試遠(yuǎn)程服務(wù)器內(nèi)容請搜索好吧啦網(wǎng)以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持好吧啦網(wǎng)!
