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