PhpStorm Xdebug遠程調試環境搭建原理分析及問題排查

作者：廖新喜

原文地址：PhpStorm Xdebug遠程調試環境搭建原理分析及問題排查

網上關于 phpstorm 調試的文章很多，真實實踐過的不多，都是幾篇文章轉來轉去，沒有原理分析，甚至有些文章的配置文件都是錯的，我就是按照一篇錯誤的配置一路走過來的，不過好歹把這些坑都給埋了，這篇文章不僅僅有操作，還有原理分析，更有問題排查思路。

對于簡單的工程，直接print_r();exit()已經足夠，但是對于大型項目有時就有點力不從心，如果直接將 apache 部署在本地，phpstorm 調試本地代碼這種方式也可以，我以前就是這么干的，這篇文章主要介紹遠程調試系問題排除。

一. 環境介紹

本地：windows7（192.168..）+ phpstorm8

遠程：Ubuntu14.04（192.168.3.206）+ apache2 + php5

二. 遠程環境配置

2.2 Xdebug安裝

Ubuntu下直接apt-get安裝，安裝命令如下：apt-get install php5-xdebug

2.3 配置

首先通過locate定位到 xdebug.ini，這個位置一定得對，在 Ubuntu 上位于/etc/php5/apache2/conf.d/20-xdebug.ini

zend_extension=xdebug.so
xdebug.idekey=PHPSTORM
xdebug.remote_connect_back = 1
；//如果開啟此，將忽略下面的 xdebug.remote_host 的參數

；xdebug.remote_host=192.168.x.x
; //注意這里是，客戶端的ip<即IDE的機器的ip,不是你的web server>

xdebug.remote_enable=on
xdebug.remote_port = 9001
;//注意這里是，客戶端的端口<即IDE的機器的ip,不是你的web server>

xdebug.remote_handler = dbgp
xdebug.auto_trace = 1
xdebug.remote_log = /tmp/xdebug.log

三. 本地phpstorm配置

下面的配置有執行順序要求，請一步一步來。

3.1 下載遠程代碼

phpstorm在新建項目的時候提供了選項，可以通過ftp/sftp遠程下載代碼，直接按照提示下一步下一步就可以。

3.2 添加php解釋器

通過file->settings->Languages & Frameworks找到php欄。

3.3 配置Debug

路徑還是在file->settings->Languages & Frameworks->PHP，選擇Debug，選擇要監聽的端口，這里設置為9001，如圖所示：

設置完端口還需要設置DBGp Proxy，配置如下：

在設置完Debug頁面后，在DBGp Proxy頁面的端口已經確定，添加上IDE key為剛才Xdebug配置文件設置的key:PHPSTORM,Host則為要調試的遠程主機。

3.4 配置Server

通過file->settings->Languages Frameworks->PHP找到Servers，Host對應遠程主機IP, Debugger 選用 Xdebug ，如果是遠程調試，一定得開啟路徑映射功能，否則無法調試，本地的路徑不用選，在新建遠程項目的時候就已經確定，Absolute path on the server 則是遠程主機的 Web 路徑。在途中紅框上方有一個 Validate remote environment 可以用來驗證遠程的 Xdebug 配置，如果配置明顯不對的話，會有提示信息，可按照提示信息修改遠程服務器的 Xdebug 配置。

3.5 配置調試選項

由于調試的目標是一個項目，所以這里需要設置PHP Web Application，配置中Server：遠程目標主機，Start URL設為/,設置完之后會在左側新建一個PHP Web Application

到目前為止，該配置的都已經配置完成，這里面配置的選項比較多，一步一步配置，有順序要求。配置完之后就是調試。點擊下圖右邊紅框中的小按鈕，打開 Xdebug 監聽，再選擇我們要調試的目標，這里是server，最后點擊那個調試按鈕，就能開啟調試之旅。

打開 Xdebug 監聽的時候，可以看到IDE已經在本地建立監聽服務，具體如下：

可以看到調試頁面。如下所示

3.6 瀏覽器添加書簽或者Xdebug Helper

前面描述的是通過PHPStorm的 debug 按鈕，發送類似?XDEBUG_SESSION_START=17212這種請求調起瀏覽器來達到調試的目的，但是這種方式只能調起首頁，存在缺陷。下面介紹另外一種啟動調試的方式，就是通過瀏覽器中帶XDEBUG_SESSION 的cookie直接發起，可以安裝Chrome插件Xdebug Helper或者添加瀏覽器的調試插件、或書簽來達到目的。新建書簽的url：https://www.jetbrains.com/phpstorm/marklets/ , 這里就不再做示例，插件和書簽的原理都是一樣的，都是在cookie中添加XDEBUG_SESSION=PHPSTORM。

四. 數據流程

前面的配置完全是一個操作指南，如果僅僅是為了配置，上面的內容已經足夠，但是如果配置中遇到什么問題，就需要接下來的原理分析。古人說的好，我們得知其然還得知其所以然。

4.1 Xdebug工作原理

1. IDE（如PhpStorm）已經集成了一個遵循BGDP的Xdebug插件，當開啟它的時候， 會在本地開一個Xdebug調試服務，監聽在調試器中所設置的端口上，默認是9000，這個服務就會監聽所有到9000端口的鏈接。在PhpStorm中，位于：工具欄 > Run > Start / Stop Listening for PHP Xdebug Connetions。

2. 當瀏覽器發送一個帶 XDEBUG_SESSION_START 的參數的請求到服務器時，服務器接受后將其轉到后端的php處理，如果php開啟了xdebug模塊，則會將debug信息轉發到客戶端IP的IDE的調試端口上。當參數或者cookie信息中不帶 XDEBUG_SESSION_START ，則不會啟動調試。這就為后續在瀏覽器中添加開關提供了可能。Xdebug的官方給出了一個示例圖：很好的展示了相互調用關系。 這個示例圖是綁定了ip，即使用了固定ip地址，xdebug.remote_connect_back = 0 ，也是 Xdebug 的默認方式，這種情況下，Xdebug 在收到調試通知時會讀取配置 xdebug.remote_host 和 xdebug.remote_port ，默認是 localhost:9000，然后向這個端口發送通知，這種方式只適合單一客戶端開發調試。 另外一種方式則是不綁定IP，Xdebug根據請求來源（REMOTE_HOST）來發起調試。示例圖如下：

那從用戶發起請求到，到IDE的整個流程圖如下：

當用戶的請求參數或者cookie中不帶調試信息，數據流就是瀏覽器到Apache（或其他web容器）到PHP，如果加上了調試參數，則請求還會由PHP轉給Xdebug處理，Xdebug再把信息轉發給IDE，完成調試功能。

五. 問題分析

由于拷貝了錯誤的Xdebug參數，導致走了不少彎路，如果僅僅是為了配置PhpStorm及Xdebug原理，關注前面部分即可。下面主要分析排除過程。

錯誤的配置如下：

zend_extension=xdebug.so
xdebug.idekey=PHPSTORM

#xdebug.remote_connect_back = 1 //如果開啟此，將忽略下面的 xdebug.remote_host 的參數

xdebug.remote_host=192.168.x.x //注意這里是，客戶端的ip<即IDE的機器的ip,不是你的web server>

xdebug.remote_enable=on
xdebug.remote_port = 9001 //注意這里是，客戶端的端口<即IDE的機器的ip,不是你的web server>

xdebug.remote_handler = dbgp
xdebug.auto_trace = 1
xdebug.collect_includes = 1
xdebug.collect_params = 1
;xdebug.collect_return = 1

xdebug.remote_autostart = 1

xdebug.remote_log = /tmp/xdebug.log

問題現象： Apache反應奇慢無比，一個普通請求能耗時10分鐘，但是最終會有效應。

排查過程：

5.1 問題背景

本地環境：Windows7，遠程服務器：Ubuntu14.04，這個遠程服務器是本地環境下VMWare WorkStation下的一臺虛擬機，網絡連接方式是橋接。在調試遠程項目時，作者使用的sftp來管理服務器的資源，這里面就會涉及到權限的問題。遠程服務器只開了一個普通賬戶liaoxinxi，而/var/www 目錄以前是root權限的，由于PhpStorm調試時會在遠程服務器web目錄下創建一個文件，這必然會導致權限問題，為了解決這個問題，執行chmod liaoxinxi:liaoxinxi /var/www -R將web目錄修改為liaoxinxi用戶所有。當然為了遠程調試，我配置了xdebug.ini，這個配置參數當時也不是太清楚具體含義，比較著急，就從某篇號稱親手測試過可用的Xdebug環境拷貝而來。下午比較混沌，當時做過的操作還挺多，Xdebug這個配置我居然忘記我配過了，只記得修改了權限相關內容。重啟Apache之后，web請求響應奇慢無比。

5.2 疑問點

5.2.1 權限

當時一股腦的認為是權限的問題，就又把web目錄權限全改為777，還是奇慢無比，查看apache日志也沒有半點異常。

5.2.2 網絡

無意之中發現在遠程服務器上直接訪問，很快就能得到響應。這個遠程服務器是我VMware下的虛擬機，通過橋接模式與宿主機通信。中午與其他同事討論這個問題的時候將問題排查點轉移到網絡環境。懷疑是網絡的問題，將橋接模式改成NAT，又是重啟虛擬機，重啟宿主機，都不起作用。

5.2.3 Apache配置

于是又將矛盾轉移到Apache的配置上，Apache的配置文件被我改動了很多回，當時覺得很簡單所以沒設置備份點，一個好的備份是多么重要。只能重裝，這個在Ubuntu下還是很簡單的，一條命令搞定apt-get auto-remove --purge apache2，并且刪除了原有的配置文件。再通過apt-get重新安裝，apt-get install apache2,重啟apache后發現在本地訪問，很快得到響應，不過響應的都是原始的php文件，再安裝一下libapache2php模塊，安裝完之后，響應還是一樣的奇慢無比。難道跟這個模塊有關系，但是找不到相關資料。再翻看安裝apache2的輸出信息時發現其重啟了Xdebug模塊，回想一下，是不是這些模塊導致的問題呢？再仔細想想，那天下午好像還改了Xdebug的配置，可能有問題。

5.2.4 Xdebug配置

回到Xdebug的配置文件，其中一個配置xdebug.remote_host=192.168.*.* //這個配置是用來，感覺峰回路轉了，因為只有這個ip訪問就會奇慢無比，于是注釋掉，再重啟apache訪問，果然奇慢無比的問題解決了。

但是這又帶來一個新的問題，這個ip是我的本地環境，如果不配置的話怎么調試呢？于是將//后邊的內容用;注釋起來，前期一直以為//也是個注釋。//這種注釋方式在Xdebug中不識別，所以根本不會向IDE所在機器發送調試包，會一直等到超時，所以就會特別慢。 再去調試，在index.php下斷點，終于斷下來了。調試的過程中發現，開啟或者未開啟調試參數都會直接進入調試模式，見了鬼了，回想起調試流程圖，肯定出問題的地方在Xdebug的配置，打開配置文件，果然發現一個相關參數xdebug.remote_autostart = 1，這個參數的意思就是自動打開遠程調試，注釋掉就能接收不使用Xdebug調試的參數。

說到最后不得不佩服這位兄弟，挖了兩個大大的坑（坑的位置），好歹我全埋了，提醒大家盡量找官方文檔，如果官方文檔寫的不詳細的，還是多見識見識幾份文檔。

綜合來看，信息大爆炸的年代，干擾信息太多，各位見仁見智。

本文由 Seebug Paper 發布，如需轉載請注明來源。本文地址：http://www.bjnorthway.com/308/