- 相關(guān)推薦
PHP 程序員的調(diào)試技術(shù)小結(jié)
本文介紹調(diào)試 PHP 應(yīng)用程序的各種方法，包括在 Apache and PHP 中打開錯(cuò)誤報(bào)告，以及通過在一個(gè)簡單的 PHP 腳本中放置策略性的 print 語句，找到更困難的 bug 的源頭。還會(huì)介紹用于 Eclipse 的 PHPEclipse 插件，這是一個(gè)靈活的開發(fā)環(huán)境，具有實(shí)時(shí)語法解析能力，還會(huì)介紹 PHPEclipse 的 DBG 調(diào)試器擴(kuò)展，希望對(duì)大家有用，更多內(nèi)容請關(guān)注應(yīng)屆畢業(yè)生網(wǎng)!
簡介
有許多 PHP 調(diào)試技術(shù)可以在編碼的時(shí)候節(jié)約大量時(shí)間。一個(gè)有效卻很基本的調(diào)試技術(shù)就是打開錯(cuò)誤報(bào)告。另一個(gè)略微高級(jí)一點(diǎn)的技術(shù)包括使用 print 語句，通過顯示在屏幕上實(shí)際出現(xiàn)的內(nèi)容，有助于精確地找出更難發(fā)現(xiàn)的 bug。PHPEclipse 是一個(gè) Eclipse 插件，能夠強(qiáng)調(diào)常見的語法錯(cuò)誤，可以與調(diào)試器結(jié)合起來用于設(shè)置斷點(diǎn)。
設(shè)置
要學(xué)習(xí)本文描述的概念，需要 PHP、Web 服務(wù)器和 Eclipse。調(diào)試器擴(kuò)展支持的 PHP 版本是 V5.0.3。
我們需要一個(gè) Web 服務(wù)器來解析用 PHP 創(chuàng)建的頁面并把它們顯示到瀏覽器。本文中使用的是 Apache2。但是，任何 Web 服務(wù)器都可以滿足要求。
要利用本文中介紹的一些調(diào)試技術(shù)，需要安裝 Eclipse V3.1.1 和插件 PHPEclipse V1.1.8。由于 Eclipse 要求 Java™ 技術(shù)，所以還要下載它。
還需要 PHP 的調(diào)試器擴(kuò)展模塊。安裝它略有些麻煩。請仔細(xì)跟隨安裝調(diào)試器擴(kuò)展的操作說明�，F(xiàn)在，先在 php.ini 文件中注釋掉那些要求裝入和配置 PHP 擴(kuò)展的行。在需要使用調(diào)試器的時(shí)候，再取消注釋。
請參閱 參考資料 獲得下載信息�，F(xiàn)在介紹出錯(cuò)消息。
出錯(cuò)消息
出錯(cuò)消息是作為開發(fā)人員的第一道防線。誰都不想在一臺(tái)沒有配置成顯示出錯(cuò)消息的服務(wù)器上用 PHP 開發(fā)代碼。但是，請記住，當(dāng)代碼調(diào)試完成，準(zhǔn)備運(yùn)行的時(shí)候，應(yīng)當(dāng)確保關(guān)閉了錯(cuò)誤報(bào)告，因?yàn)椴幌Ｍ军c(diǎn)的訪問者看到出錯(cuò)消息，因?yàn)檫@會(huì)給他們提供足夠的信息來利用站點(diǎn)的弱點(diǎn)并黑掉站點(diǎn)。
也可以用出錯(cuò)消息為自己服務(wù)，因?yàn)樗鼈儠?huì)顯示拋出或生成錯(cuò)誤的正確代碼行。這樣，調(diào)試就變成在瀏覽器上查看生成的錯(cuò)誤所顯示的行號(hào)，并在代碼中檢查這一行。稍后，將會(huì)看到 PHPEclipse 插件通過即時(shí)地給語法錯(cuò)誤加下劃線并在保存文件時(shí)用紅色 “x” 標(biāo)注語法錯(cuò)誤，可在開發(fā)和調(diào)試過程中提供極大的幫助。
先來看如何在 php.ini 文件中開啟錯(cuò)誤報(bào)告并設(shè)置錯(cuò)誤報(bào)告的級(jí)別。然后將學(xué)習(xí)如何在 Apache 的配置文件中覆蓋這些設(shè)置。
PHP 的錯(cuò)誤報(bào)告
php.ini 文件中有許多配置設(shè)置。您應(yīng)當(dāng)已經(jīng)設(shè)置好自己的 php.ini 文件并把它放在合適的目錄中，就像在 Linux 上安裝 PHP 和 Apache 2 的文檔說明中所示的那樣(請參閱 參考資料)。在調(diào)試 PHP 應(yīng)用程序時(shí)，應(yīng)當(dāng)知道兩個(gè)配置變量。下面是這兩個(gè)變量及其默認(rèn)值：
復(fù)制代碼代碼如下:
display_errors = Off
error_reporting = E_ALL
通過在 php.ini 文件中搜索它們，可以發(fā)現(xiàn)這兩個(gè)變量當(dāng)前的默認(rèn)值。display_errors 變量的目的很明顯 —— 它告訴 PHP 是否顯示錯(cuò)誤。默認(rèn)值是 Off。但是，要讓開發(fā)過程更加輕松，請把這個(gè)值設(shè)為 On：
復(fù)制代碼代碼如下:
display_errors = On
error_reporting 變量的默認(rèn)值是 E_ALL。這個(gè)設(shè)置會(huì)顯示從不良編碼實(shí)踐到無害提示到出錯(cuò)的所有信息。E_ALL 對(duì)于開發(fā)過程來說有點(diǎn)太細(xì)，因?yàn)樗谄聊簧蠟橐恍┬∈?例如變量未初始化)也顯示提示，會(huì)搞糟瀏覽器的輸出。我只想看到錯(cuò)誤和不良編碼實(shí)踐，但是不想看到無害的提示。所以，請用以下值代替 error_reporting 的默認(rèn)值：
復(fù)制代碼代碼如下:
error_reporting = E_ALL & ~E_NOTICE
重新啟動(dòng) Apache，就全部設(shè)置好了。接下來，將學(xué)習(xí)如何在 Apache 上做同樣的事。
服務(wù)器上的錯(cuò)誤報(bào)告
依賴于 Apache 正在做的工作，在 PHP 中打開錯(cuò)誤報(bào)告可能沒法工作，因?yàn)樵谟?jì)算機(jī)上可能有多個(gè) PHP 版本。有時(shí)很難區(qū)分 Apache 正在使用哪個(gè) PHP 版本，因?yàn)?Apache 只能查看一個(gè) php.ini 文件。不知道 Apache 正在使用哪個(gè) php.ini 文件配置自己是一個(gè)安全問題。但是，有一種方法可以在 Apache 中配置 PHP 變量，從而保證設(shè)置了正確的出錯(cuò)級(jí)別。
而且，最好知道如何在服務(wù)器端設(shè)置這些配置變量，以否決或搶占 php.ini 文件，從而提供更高級(jí)別的安全性。
在配置 Apache 時(shí)，應(yīng)該已經(jīng)接觸過 /conf/httpd.conf 中 http.conf 文件中的基本配置。
要做在 php.ini 文件中已經(jīng)做過的事，請把下列各行添加到 httpd.conf，覆蓋任何 php.ini 文件：
復(fù)制代碼代碼如下:
php_flag display_errors on
php_value error_reporting 2039
這會(huì)覆蓋在 php.ini 文件中為 display_errors 已經(jīng)設(shè)置的標(biāo)志，以及 error_reporting 的值。值 2039 代表 E_ALL & ~E_NOTICE。如果愿意采用 E_ALL，請把值設(shè)為 2047。同樣，還是要重啟 Apache。
接下來，要在服務(wù)器上測試錯(cuò)誤報(bào)告。
測試錯(cuò)誤報(bào)告
如果啟動(dòng)了錯(cuò)誤報(bào)告，會(huì)節(jié)約許多時(shí)間。PHP 中的錯(cuò)誤會(huì)指向代碼中的錯(cuò)誤。請創(chuàng)建一個(gè)簡單的 PHP 文件 test.php，并像清單 1 所示一樣定義它。
清單 1. 一個(gè)生成錯(cuò)誤的簡單 PHP
復(fù)制代碼代碼如下:
print("The next line generates an error.
");
printaline("PLEASE?");
print("This will not be displayed due to the above error.");
?>
第一個(gè) print() 語句會(huì)向 Web 瀏覽器顯示它的內(nèi)容。但是第二個(gè)語句會(huì)生成錯(cuò)誤并在 Web 頁面上顯示。這造成最后一個(gè) print() 語句不起作用，如圖 1 所示。
圖 1. 生成錯(cuò)誤
生成錯(cuò)誤
現(xiàn)在開啟了錯(cuò)誤報(bào)告!接下來，用 print 語句幫助調(diào)試應(yīng)用程序。
介紹 print 語句
因?yàn)閼?yīng)用程序中的功能性 bug 不會(huì)產(chǎn)生錯(cuò)誤，所以在所有調(diào)試策略中，關(guān)于如何正確地放置和使用 print 或 die 語句來調(diào)試 PHP 應(yīng)用程序的知識(shí)是一種很好的資產(chǎn)�？梢杂� print 語句在代碼中縮小對(duì)問題語句的定位，這些語句在語法上沒有錯(cuò)誤，也不是 bug，但是從代碼的功能上看是 bug。這些是最難發(fā)現(xiàn)和調(diào)試的 bug，因?yàn)樗鼈儾粫?huì)拋出錯(cuò)誤。惟一知道的就是在瀏覽器上顯示的內(nèi)容不是想要的內(nèi)容，或者想要保存在數(shù)據(jù)庫中的內(nèi)容根本沒有保存。
假設(shè)正在處理通過 GET 請求發(fā)送過來的表單數(shù)據(jù)，想向?yàn)g覽器顯示信息，但是出于某種原因，數(shù)據(jù)沒有正確地提交，或者不能正確地從 GET 請求中讀出。要調(diào)試這類問題，重要的是用 print() 或 die() 語句知道變量的值是什么。
die() 語句會(huì)中止程序執(zhí)行，并在 Web 瀏覽器上顯示文本。如果不想注釋掉代碼，而且只想顯示到出錯(cuò)之前的信息和出錯(cuò)信息，不想顯示后面的信息，那么 die() 語句特別有用。
讓我們在 PHP 中用 print 語句來測試這個(gè)概念
使用 print 語句進(jìn)行調(diào)試
在我作程序員的那些時(shí)候，當(dāng)我在 Linux® 上開發(fā)應(yīng)用程序時(shí)，沒有方便的 GUI 可以告訴我 bug 在哪，我迅速地發(fā)現(xiàn)我在程序中放的 print 語句越多，我在應(yīng)用程序中把 bug 的范圍縮小到一行的機(jī)會(huì)越大。請創(chuàng)建另一個(gè) PHP 文件 test2.php，并像清單 2 所示的那樣定義它。
清單 2. 顯示通過 GET 提交的所有變量
復(fù)制代碼代碼如下:
$j = "";
print("Lets retrieve all the variables submitted to this ");
print("script via a GET request:
");
foreach($_GET as $key => $i){
print("$key=$j
");
}
if($_GET['Submit'] == "Send GET Request")
$j = "done!
";
?>
Name:
Email:
您可能會(huì)非常容易地發(fā)現(xiàn)清單 2 中的 bug!您很棒!但請注意這是一個(gè)非常簡單的腳本，只是作為使用 print 語句進(jìn)行調(diào)試而展示的一個(gè)例子而已。這個(gè)腳本只是提取 GET 請求中的所有變量，如果有，就把它們顯示在瀏覽器上。還提供了一個(gè)表單，用 GET 請求向服務(wù)器發(fā)送變量以進(jìn)行測試。請看輸出，如圖 2 所示。
圖 2. test2.php 的輸出
test2.php 的輸出
現(xiàn)在單擊 Send GET Request 按鈕，請注意只有 $_GET 請求的鍵顯示在瀏覽器上，而正確的值都沒顯示�？梢栽谘h(huán)中放一個(gè) print 語句，檢驗(yàn)在 foreach 循環(huán)中每個(gè)元素中是否確實(shí)存在數(shù)據(jù)。請參閱清單 3。
清單 3. 用 print 語句驗(yàn)證代碼的功能
復(fù)制代碼代碼如下:
...
foreach($_GET as $key => $i){
print("Correct data? " . $_GET[$key] . "
");
print("$key=$j
");
}
...
放進(jìn)去的 print 語句是粗體。注意，現(xiàn)在已經(jīng)知道在 Web 瀏覽器上顯示的 $key 值是正確的，但是由于某些原因，值沒有正確地顯示。請看新的輸出。
圖 3. 修改后的 test2.php 的輸出
修改后的 test2.php 的輸出
現(xiàn)在已經(jīng)知道應(yīng)用程序正確地從 GET 請求接收到了變量，那么肯定是在代碼中有 bug。查看之后注意到，用來顯示值的變量 $j 是錯(cuò)誤的。在 foreach 語句中指定的是 $i，所以它肯定會(huì)有正確的值，但是無意之中輸入了 $j。所以通過把 $j 替換成 $i，迅速地修正了錯(cuò)誤，重新載入頁面之后，就看到了正確的輸出，如圖 4 所示。
圖 4. 修正后的 test2.php 的輸出
修正后的 test2.php 的輸出
現(xiàn)在可以刪除或注釋掉剛才添加的 print 語句了，因?yàn)橐呀?jīng)發(fā)現(xiàn)了代碼中的 bug。注意，這只是在調(diào)試應(yīng)用程序時(shí)可能遇到的許多錯(cuò)誤中的一個(gè)很小的子集。對(duì)于使用數(shù)據(jù)庫時(shí)可能遇到的問題，一個(gè)好的解決方案是輸出 SQL 語句，以確保執(zhí)行的 SQL 就是想要執(zhí)行的。
現(xiàn)在要來看看如何使用 Eclipse IDE 和 PHPEclipse 插件及調(diào)試器擴(kuò)展進(jìn)一步在調(diào)試歷程中提供幫助。
使用 PHPEclipse
您可能用過 Eclipse，但是可能不熟悉它。請參閱 參考資料 獲得 Eclipse 平臺(tái)的介紹。
用于 Eclipse 的 PHPEclipse 插件是用來開發(fā) PHP 應(yīng)用程序的一個(gè)流行工具。請啟動(dòng) Eclipse 并把工作區(qū)目錄指定為 Apache 的 www 目錄(在我的機(jī)器上是 c:\www)。現(xiàn)在單擊 File > New > Project。會(huì)彈出 New Project 向?qū)Аｋp擊 PHP 文件夾并選擇 PHP Project。單擊 Next，輸入項(xiàng)目名稱 debugArticle，并單擊 Finish。
如果把 Web 服務(wù)器設(shè)置為在端口 80 上偵聽，那么不需要做任何修改。否則，請轉(zhuǎn)到 Navigator 窗口，在 PHP 項(xiàng)目 debugArticle 上右擊，選擇 Properties，然后單擊 PHP Project Settings。單擊 Configure Workspace Settings 然后修改合適的 localhost 或者添加 Web 服務(wù)器偵聽的端口(例如 http://localhost:8080)。單擊 Apply 完成設(shè)置。
Navigator 窗口應(yīng)當(dāng)顯示項(xiàng)目和一個(gè) .project 文件。在項(xiàng)目上右擊，就像前面做的那樣，只是這次選擇 New > PHP File。用想要?jiǎng)?chuàng)建的 PHP 文件的名稱 test3.php 替換 *.php，然后單擊 Finish。在 Eclipse IDE 中應(yīng)當(dāng)出現(xiàn)一個(gè)新文件。可能需要導(dǎo)航到窗口底部的 PHP 瀏覽器來查看 PHP 文件的當(dāng)前輸出(參見圖 5)。
圖 5. Eclipse 的 PHPEclipse 插件
Eclipse 的 PHPEclipse 插件
注意，只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨(dú)立瀏覽器窗口并把瀏覽器指向測試腳本所在目錄，也可以使用同樣的功能。
現(xiàn)在來演示這個(gè)應(yīng)用程序，證明它的強(qiáng)大能力。
在 “使用調(diào)試器” 一節(jié)中，將學(xué)習(xí)如何用 Eclipse、PHPEclipse 和前面下載的調(diào)試器 PHP 擴(kuò)展來調(diào)試 PHP 應(yīng)用程序。先從學(xué)習(xí)如何使用它的語法解析功能開始。
語法解析和加下劃線
先從查看 PHPEclipse 如何提供幫助調(diào)試 PHP 應(yīng)用程序的實(shí)時(shí)語法解析功能開始。要看這個(gè)特性的實(shí)際應(yīng)用，先從在 Eclipse 中定義 test3.php 開始，如下所示。
print(,"Hello World!");
?>
注意，在清單 4 中加下劃線的兩個(gè)字符在 Eclipse 中加了下劃線，提示語法不正確。按 Ctrl+S 保存文件，會(huì)在 Eclipse 中顯示解析錯(cuò)誤：在代碼中與解析錯(cuò)誤對(duì)應(yīng)的行上會(huì)加上紅 “x”，如圖 6 所示。
圖 6. 語法錯(cuò)誤強(qiáng)調(diào)
現(xiàn)在演示 PHP 瀏覽器。這個(gè)窗口提供了當(dāng)前 PHP 腳本的預(yù)覽，如圖 6 所示。
從上面定義的 test3.php 中刪除逗號(hào)(,)。按 Ctrl+S 保存文件，然后觀察 PHP 瀏覽器窗口的更新，顯示了 Hello World(參見圖 7)。
圖 7. 在 PHPEclipse 中預(yù)覽 PHP 腳本
下面是用調(diào)試器在 PHP 中設(shè)置斷點(diǎn)。
使用調(diào)試器
使用調(diào)試器，可以設(shè)置斷點(diǎn)并查看 PHP 代碼到所設(shè)斷點(diǎn)之前的瀏覽器輸出。然后可以繼續(xù)代碼的執(zhí)行并查看到下一斷點(diǎn)之前的瀏覽器輸出，然后再到下一個(gè)，直到 PHP 腳本完成。
現(xiàn)在把 “設(shè)置” 一節(jié)中在 php.ini 中注釋掉的行取消注釋，并重新啟動(dòng) Apache�，F(xiàn)在裝入了調(diào)試器，Eclipse 能夠和它掛上了。
現(xiàn)在在 Eclipse 中設(shè)計(jì)調(diào)試環(huán)境。請創(chuàng)建新的 test4.php 文件，先保持為空。現(xiàn)在單擊 Run > Debug。在左側(cè)面板中選擇 PHP DBG Script，并單擊 New�，F(xiàn)在轉(zhuǎn)到 File 選項(xiàng)卡，輸入當(dāng)前項(xiàng)目 debugArticle 以及想要調(diào)試的文件 test4.php�，F(xiàn)在轉(zhuǎn)到 Environment 選項(xiàng)卡，然后再到 Interpreter 子選項(xiàng)卡。在 PHP 的安裝目錄中找到 php.exe 文件(我的是 c:\apps\php5.0.3\php.exe)。現(xiàn)在單擊 Remote Debug 子選項(xiàng)卡，選擇 Remote Debug，如果沒有使用 Windows，請取消 “Open with DBGSession URL in internal browser box” 復(fù)選框。把 Remote Source 路徑設(shè)置成與要測試的 PHP 腳本的絕對(duì)路徑(不是 Web 路徑)相同(我的設(shè)置是 c:\www\debugArticle\test4.php)。現(xiàn)在單擊 Debug。
現(xiàn)在應(yīng)當(dāng)裝入 Debug 透視圖，如圖 8 所示。否則，請單擊 Window > Open Perspective > Other，并選擇 Debug。
圖 8. Eclipse 中的 Debug 透視圖
Eclipse 中的 Debug 透視圖
現(xiàn)在可以設(shè)置斷點(diǎn)了。
對(duì)于本文中使用的插件和擴(kuò)展的版本，斷點(diǎn)功能是必需的，因?yàn)?PHP 在把輸出發(fā)送到瀏覽器之前會(huì)緩沖它。除此之外，需要做的不僅僅是設(shè)置一個(gè)斷點(diǎn)把當(dāng)前顯示數(shù)據(jù)刷新到 Web 瀏覽器，所以要像下面和圖 8 所示那樣定義 test4.php。
清單 4. 設(shè)置和創(chuàng)建斷點(diǎn)
function break-point(){
ob_flush();
flush();
sleep(.1);
debugBreak();
}
print("This will get shown first, ");
print("as will this
");
breakpoint();
print("This won't get shown until after ");
print("continuing the break-point
");
breakpoint();
print("END!");
?
breakpoint() 函數(shù)會(huì)把緩沖的輸出和其他緩沖的數(shù)據(jù)刷新到 Web 瀏覽器。對(duì) sleep(.1) 的調(diào)用是必需的，這樣代碼中止于 debugBreak() 之前，服務(wù)器才有足夠的時(shí)間把數(shù)據(jù)刷新到 Web 瀏覽器，這個(gè)函數(shù)是前面下載的 PHP 調(diào)試器擴(kuò)展的內(nèi)部函數(shù)。這樣，調(diào)用 breakpoint() 會(huì)把 HTML 塊、print() 和 echo()語句的數(shù)據(jù)刷新到瀏覽器，然后中止代碼執(zhí)行。
在像清單 4 那樣編寫完代碼之后，可以打開瀏覽器并指向 test4.php，或者可以查看 PHP 瀏覽器窗口(我的是 http://localhost/debugArticle/test4.php)。每次輸入和保存文件時(shí)，在 PHP 瀏覽器窗口中就已經(jīng)啟動(dòng)了調(diào)試序列。如果不使用 Windows，請通過瀏覽器查看 test4.php。在保存了文件之后，用 F8 或單擊 Run > Resume 繼續(xù)代碼執(zhí)行。持續(xù)這么做，直到最后一行輸出是 END! 為止(參見圖 9、10 和 11)。
圖 9. 初始的到第一個(gè)斷點(diǎn)的 PHP 瀏覽器輸出
初始的到第一個(gè)斷點(diǎn)的 PHP 瀏覽器輸出
請注意圖 9 中的 Debug 窗口如何把執(zhí)行顯示為掛起的。
圖 10. 第一個(gè)斷點(diǎn)之后到第二個(gè)斷點(diǎn)之前的 PHP 瀏覽器輸出
第一個(gè)斷點(diǎn)之后到第二個(gè)斷點(diǎn)之前的 PHP 瀏覽器輸出
圖 10 的 Debug 窗口仍然把執(zhí)行顯示為掛起，而第二組數(shù)據(jù)顯示在 PHP 瀏覽器中。
圖 11. 完整的 PHP 瀏覽器輸出
注意，圖 11 的 Debug 窗口中的代碼不再掛起，整個(gè)腳本已經(jīng)執(zhí)行，如圖 11 中的 PHP 瀏覽器所示。
既然已經(jīng)看到了用 PHPEclipse 和調(diào)試器擴(kuò)展進(jìn)行開發(fā)的優(yōu)勢，那么很難想像沒有它會(huì)怎么樣。
結(jié)束語
現(xiàn)在已經(jīng)向 PHP 的調(diào)試技術(shù)集中添加了錯(cuò)誤報(bào)告的運(yùn)用、print 語句、PHPEclipse 和調(diào)試器擴(kuò)展，您可以通過減少每行代碼的錯(cuò)誤數(shù)量，成為更有效的 PHP 編碼人員。請參閱 參考資料 獲得一些 PHP 教程，可以在上面測試這些新技能。
【PHP 程序員的調(diào)試技術(shù)小結(jié)】相關(guān)文章：
php程序員11-01
PHP緩存技術(shù)10-08
PHP實(shí)現(xiàn)獲取域名的方法小結(jié)06-08
php緩存技術(shù)經(jīng)典總結(jié)09-09
優(yōu)秀的PHP程序員是怎樣練成的08-02
php防盜鏈的常用方法小結(jié)08-24