PHP 程式員的調試技術小結

本文介紹調試 PHP 應用程式的各種方法，包括在 Apache and PHP 中開啟錯誤報表，以及通過在一個簡單的 PHP 指令碼中放置策略性的 print 語句，找到更困難的 bug 的源頭。還會介紹用於 Eclipse 的 PHPEclipse 外掛程式，這是一個靈活的開發環境，具有即時文法解析能力，還會介紹 PHPEclipse 的 DBG 調試器擴充。
簡介
有許多 PHP 調試技術可以在編碼的時候節約大量時間。一個有效卻很基本的調試技術就是開啟錯誤報表。另一個略微進階一點的技術包括使用 print 語句，通過顯示在螢幕上實際出現的內容，有助於精確地找出更難發現的 bug。PHPEclipse 是一個 Eclipse 外掛程式，能夠強調常見的語法錯誤，可以與調試器結合起來用於設定斷點。

設定
要學習本文描述的概念，需要 PHP、Web 服務器和 Eclipse。調試器擴充支援的 PHP 版本是 V5.0.3。
我們需要一個 Web 服務器來解析用 PHP 建立的頁面並把它們顯示到瀏覽器。本文中使用的是 Apache2。但是，任何 Web 服務器都可以滿足要求。
要利用本文中介紹的一些調試技術，需要安裝 Eclipse V3.1.1 和外掛程式 PHPEclipse V1.1.8。由於 Eclipse 要求 Java 技術，所以還要下載它。
還需要 PHP 的調試器擴充模組。安裝它略有些麻煩。請仔細跟隨安裝調試器擴充的操作說明。現在，先在 php.ini 檔案中注釋掉那些要求裝入和配置 PHP 擴充的行。在需要使用調試器的時候，再取消注釋。
請參閱 參考資料 獲得下載資訊。現在介紹出錯訊息。

出錯訊息
出錯訊息是作為開發人員的第一道防線。誰都不想在一台沒有配置成顯示出錯訊息的伺服器上用 PHP 開發代碼。但是，請記住，當代碼調試完成，準備啟動並執行時候，應當確保關閉了錯誤報表，因為不希望網站的訪問者看到出錯訊息，因為這會給他們提供足夠的資訊來利用網站的弱點並黑掉網站。
也可以用出錯訊息為自己服務，因為它們會顯示拋出或建置錯誤的正確程式碼。這樣，調試就變成在瀏覽器上查看產生的錯誤所顯示的行號，並在代碼中檢查這一行。稍後，將會看到 PHPEclipse 外掛程式通過即時地給語法錯誤加底線並在儲存檔案時用紅色 “x” 標註語法錯誤，可在開發和調試過程中提供極大的協助。
先來看如何在 php.ini 檔案中開啟錯誤報表並設定錯誤報表的層級。然後將學習如何在 Apache 的設定檔中覆蓋這些設定。
PHP 的錯誤報表
php.ini 檔案中有許多配置設定。您應當已經設定好自己的 php.ini 檔案並把它放在合適的目錄中，就像在 Linux 上安裝 PHP 和 Apache 2 的文檔說明中所示的那樣（請參閱 參考資料）。在調試 PHP 應用程式時，應當知道兩個組態變數。下面是這兩個變數及其預設值：

複製代碼 代碼如下:display_errors = Off
error_reporting = E_ALL

通過在 php.ini 檔案中搜尋它們，可以發現這兩個變數當前的預設值。display_errors 變數的目的很明顯 —— 它告訴 PHP 是否顯示錯誤。預設值是 Off。但是，要讓開發過程更加輕鬆，請把這個值設為 On： 複製代碼 代碼如下:display_errors = On

error_reporting 變數的預設值是 E_ALL。這個設定會顯示從不良編碼實踐到無害提示到出錯的所有資訊。E_ALL 對於開發過程來說有點太細，因為它在螢幕上為一些小事（例如變數未初始化）也顯示提示，會搞糟瀏覽器的輸出。我只想看到錯誤和不良編碼實踐，但是不想看到無害的提示。所以，請用以下值代替 error_reporting 的預設值： 複製代碼 代碼如下:error_reporting = E_ALL & ~E_NOTICE

重新啟動 Apache，就全部設定好了。接下來，將學習如何在 Apache 上做同樣的事。
伺服器上的錯誤報表
依賴於 Apache 正在做的工作，在 PHP 中開啟錯誤報表可能沒法工作，因為在電腦上可能有多個 PHP 版本。有時很難區分 Apache 正在使用哪個 PHP 版本，因為 Apache 只能查看一個 php.ini 檔案。不知道 Apache 正在使用哪個 php.ini 檔案配置自己是一個安全問題。但是，有一種方法可以在 Apache 中配置 PHP 變數，從而保證設定了正確的出錯層級。
而且，最好知道如何在伺服器端設定這些組態變數，以否決或搶佔 php.ini 檔案，從而提供更進階別的安全性。
在配置 Apache 時，應該已經接觸過 <apache2-install-dir>/conf/httpd.conf 中 http.conf 檔案中的基本配置。
要做在 php.ini 檔案中已經做過的事，請把下列各行添加到 httpd.conf，覆蓋任何 php.ini 檔案： 複製代碼 代碼如下:php_flag display_errors on
php_value error_reporting 2039

這會覆蓋在 php.ini 檔案中為 display_errors 已經設定的標誌，以及 error_reporting 的值。值 2039 代表 E_ALL & ~E_NOTICE。如果願意採用 E_ALL，請把值設為 2047。同樣，還是要重啟 Apache。
接下來，要在伺服器上測試錯誤報表。
測試錯誤報表
如果啟動了錯誤報表，會節約許多時間。PHP 中的錯誤會指向代碼中的錯誤。請建立一個簡單的 PHP 檔案 test.php，並像清單 1 所示一樣定義它。
清單 1. 一個建置錯誤的簡單 PHP 複製代碼 代碼如下:<?php
print("The next line generates an error.<br>");
printaline("PLEASE?");
print("This will not be displayed due to the above error.");
?>

第一個 print() 語句會向 網頁瀏覽器顯示它的內容。但是第二個語句會建置錯誤並在 Web 頁面上顯示。這造成最後一個 print() 語句不起作用， 1 所示。
圖 1. 建置錯誤

現在開啟了錯誤報表！接下來，用 print 語句協助調試應用程式。
介紹 print 語句
因為應用程式中的功能性 bug 不會產生錯誤，所以在所有調試策略中，關於如何正確地放置和使用 print 或 die 語句來調試 PHP 應用程式的知識是一種很好的資產。可以用 print 語句在代碼中縮小對問題語句的定位，這些語句在文法上沒有錯誤，也不是 bug，但是從代碼的功能上看是 bug。這些是最難發現和調試的 bug，因為它們不會拋出錯誤。惟一知道的就是在瀏覽器上顯示的內容不是想要的內容，或者想要儲存在資料庫中的內容根本沒有儲存。
假設正在處理通過 GET 請求發送過來的表單資料，想向瀏覽器顯示資訊，但是出於某種原因，資料沒有正確地提交，或者不能正確地從 GET 請求中讀出。要調試這類問題，重要的是用 print() 或 die() 語句知道變數的值是什麼。
die() 語句會中止程式執行，並在 網頁瀏覽器上顯示文本。如果不想注釋掉代碼，而且只想顯示到出錯之前的資訊和出錯資訊，不想顯示後面的資訊，那麼 die() 語句特別有用。
讓我們在 PHP 中用 print 語句來測試這個概念
使用 print 語句進行調試
在我作程式員的那些時候，當我在 Linux 上開發應用程式時，沒有方便的 GUI 可以告訴我 bug 在哪，我迅速地發現我在程式中放的 print 語句越多，我在應用程式中把 bug 的範圍縮小到一行的機會越大。請建立另一個 PHP 檔案 test2.php，並像清單 2 所示的那樣定義它。

清單 2. 顯示通過 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>

您可能會非常容易地發現清單 2 中的 bug！您很棒！但請注意這是一個非常簡單的指令碼，只是作為使用 print 語句進行調試而展示的一個例子而已。這個指令碼只是提取 GET 請求中的所有變數，如果有，就把它們顯示在瀏覽器上。還提供了一個表單，用 GET 請求向伺服器發送變數以進行測試。請看輸出， 2 所示。
圖 2. test2.php 的輸出

現在單擊 Send GET Request 按鈕，請注意只有 $_GET 請求的鍵顯示在瀏覽器上，而正確的值都沒顯示。可以在迴圈中放一個 print 語句，檢驗在 foreach 迴圈中每個元素中是否確實存在資料。請參閱清單 3。
清單 3. 用 print 語句驗證代碼的功能

複製代碼 代碼如下:...
foreach($_GET as $key => $i){
print("Correct data? " . $_GET[$key] . "<br>");
print("$key=$j<br>");
}
...

放進去的 print 語句是粗體。注意，現在已經知道在 網頁瀏覽器上顯示的 $key 值是正確的，但是由於某些原因，值沒有正確地顯示。請看新的輸出， 3 所示。
圖 3. 修改後的 test2.php 的輸出

現在已經知道應用程式正確地從 GET 請求接收到了變數，那麼肯定是在代碼中有 bug。查看之後注意到，用來顯示值的變數 $j 是錯誤的。在 foreach 語句中指定的是 $i，所以它肯定會有正確的值，但是無意之中輸入了 $j。所以通過把 $j 替換成 $i，迅速地修正了錯誤，重新載入頁面之後，就看到了正確的輸出， 4 所示。

圖 4. 修正後的 test2.php 的輸出

現在可以刪除或注釋掉剛才添加的 print 語句了，因為已經發現了代碼中的 bug。注意，這隻是在調試應用程式時可能遇到的許多錯誤中的一個很小的子集。對於使用資料庫時可能遇到的問題，一個好的解決方案是輸出 SQL 陳述式，以確保執行的 SQL 就是想要執行的。

現在要來看看如何使用 Eclipse IDE 和 PHPEclipse 外掛程式及調試器擴充進一步在調試曆程中提供協助。

使用 PHPEclipse

您可能用過 Eclipse，但是可能不熟悉它。請參閱 參考資料 獲得 Eclipse 平台的介紹。

用於 Eclipse 的 PHPEclipse 外掛程式是用來開發 PHP 應用程式的一個流行工具。請啟動 Eclipse 並把工作區目錄指定為 Apache 的 www 目錄（在我的機器上是 c:\www）。現在單擊 File > New > Project。會彈出 New Project 嚮導。雙擊 PHP 檔案夾並選擇 PHP Project。單擊 Next，輸入項目名稱 debugArticle，並單擊 Finish。

如果把 Web 服務器設定為在連接埠 80 上偵聽，那麼不需要做任何修改。否則，請轉到 Navigator 視窗，在 PHP 項目 debugArticle 上右擊，選擇 Properties，然後單擊 PHP Project Settings。單擊 Configure Workspace Settings 然後修改合適的 localhost 或者添加 Web 服務器偵聽的連接埠（例如 http://localhost:8080）。單擊 Apply 完成設定。

Navigator 視窗應當顯示項目和一個 .project 檔案。在項目上右擊，就像前面做的那樣，只是這次選擇 New > PHP File。用想要建立的 PHP 檔案的名稱 test3.php 替換 *.php，然後單擊 Finish。在 Eclipse IDE 中應當出現一個新檔案。可能需要導航到視窗底部的 PHP 瀏覽器來查看 PHP 檔案的當前輸出（參見圖 5）。

圖 5. Eclipse 的 PHPEclipse 外掛程式

注意，只有 Windows 的使用者可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過開啟獨立瀏覽器視窗並把瀏覽器指向測試指令碼所在目錄，也可以使用同樣的功能。

現在來示範這個應用程式，證明它的強大能力。

在 “使用調試器” 一節中，將學習如何用 Eclipse、PHPEclipse 和前面下載的調試器 PHP 擴充來調試 PHP 應用程式。先從學習如何使用它的文法解析功能開始。

文法解析和加底線

先從查看 PHPEclipse 如何提供協助調試 PHP 應用程式的即時文法解析功能開始。要看這個特性的實際應用，先從在 Eclipse 中定義 test3.php 開始，如下所示。

<?phpprint(,"Hello World!");?>

注意，在清單 4 中加底線的兩個字元在 Eclipse 中加了底線，提示法不正確。按 Ctrl+S 儲存檔案，會在 Eclipse 中顯示解析錯誤：在代碼中與解析錯誤對應的行上會加上紅 “x”， 6 所示。

圖 6. 語法錯誤強調

現在示範 PHP 瀏覽器。這個視窗提供了當前 PHP 指令碼的預覽， 6 所示。

從上面定義的 test3.php 中刪除逗號（,）。按 Ctrl+S 儲存檔案，然後觀察 PHP 瀏覽器視窗的更新，顯示了 Hello World（參見圖 7）。

圖 7. 在 PHPEclipse 中預覽 PHP 指令碼

下面是用調試器在 PHP 中設定斷點。

使用調試器

使用調試器，可以設定斷點並查看 PHP 代碼到所設斷點之前的瀏覽器輸出。然後可以繼續代碼的執行並查看到下一斷點之前的瀏覽器輸出，然後再到下一個，直到 PHP 指令碼完成。

現在把 “設定” 一節中在 php.ini 中注釋掉的行取消注釋，並重新啟動 Apache。現在裝入了調試器，Eclipse 能夠和它掛上了。

現在在 Eclipse 中設計調試環境。請建立新的 test4.php 檔案，先保持為空白。現在單擊 Run > Debug。在左側面板中選擇 PHP DBG Script，並單擊 New。現在轉到 File 選項卡，輸入當前項目 debugArticle 以及想要調試的檔案 test4.php。現在轉到 Environment 選項卡，然後再到 Interpreter 子選項卡。在 PHP 的安裝目錄中找到 php.exe 檔（我的是 c:\apps\php5.0.3\php.exe）。現在單擊 Remote Debug 子選項卡，選擇 Remote Debug，如果沒有使用 Windows，請取消 “Open with DBGSession URL in internal browser box” 複選框。把 Remote Source 路徑設定成與要測試的 PHP 指令碼的絕對路徑（不是 Web 路徑）相同（我的設定是 c:\www\debugArticle\test4.php）。現在單擊 Debug。

現在應當裝入 Debug 透視圖， 8 所示。否則，請單擊 Window > Open Perspective > Other，並選擇 Debug。

圖 8. Eclipse 中的 Debug 透視圖

現在可以設定斷點了。

對於本文中使用的外掛程式和擴充的版本，斷點功能是必需的，因為 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外，需要做的不僅僅是設定一個斷點把當前顯示資料重新整理到 網頁瀏覽器，所以要像下面和圖 8 所示那樣定義 test4.php。

清單 4. 設定和建立斷點

<?phpfunction 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() 函數會把緩衝的輸出和其他緩衝的資料重新整理到 網頁瀏覽器。對 sleep(.1) 的調用是必需的，這樣代碼中止於 debugBreak() 之前，伺服器才有足夠的時間把資料重新整理到 網頁瀏覽器，這個函數是前面下載的 PHP 調試器擴充的內建函式。這樣，調用 breakpoint() 會把 HTML 塊、print() 和 echo() 語句的資料重新整理到瀏覽器，然後中止代碼執行。

在像清單 4 那樣編寫完代碼之後，可以開啟瀏覽器並指向 test4.php，或者可以查看 PHP 瀏覽器視窗（我的是 http://localhost/debugArticle/test4.php）。每次輸入和儲存檔案時，在 PHP 瀏覽器視窗中就已經啟動了調試序列。如果不使用 Windows，請通過瀏覽器查看 test4.php。在儲存了檔案之後，用 F8 或單擊 Run > Resume 繼續代碼執行。持續這麼做，直到最後一行輸出是 END! 為止（參見圖 9、10 和 11）。

圖 9. 初始的到第一個斷點的 PHP 瀏覽器輸出

請注意圖 9 中的 Debug 視窗如何把執行顯示為掛起的。

圖 10. 第一個斷點之後到第二個斷點之前的 PHP 瀏覽器輸出

圖 10 的 Debug 視窗仍然把執行顯示為掛起，而第二組資料顯示在 PHP 瀏覽器中。

圖 11. 完整的 PHP 瀏覽器輸出

注意，圖 11 的 Debug 視窗中的代碼不再掛起，整個指令碼已經執行， 11 中的 PHP 瀏覽器所示。

既然已經看到了用 PHPEclipse 和調試器擴充進行開發的優勢，那麼很難想像沒有它會怎麼樣。

結束語

現在已經向 PHP 的調試技術集中添加了錯誤報表的運用、print 語句、PHPEclipse 和調試器擴充，您可以通過減少每行代碼的錯誤數量，成為更有效 PHP 編碼人員。請參閱 參考資料 獲得一些 PHP 教程，可以在上面測試這些新技能。

下載 Sample code for PHP Debugging

參考資料

學習

• 您可以參閱本文在 developerWorks 全球網站上的 英文原文。

• 學習如何在基於 Windows 和 UNIX 的系統上 安裝 Java。
• 請訪問 Eclipse.org 獲得編程和如何使用它的全面資訊。
• “Eclipse 平台入門”（developerWorks，2002 年 11 月）提供了 Eclipse 的曆史和概述，包括如何安裝 Eclipse 和外掛程式的細節。
• 請訪問 PHPEclipse 學習關於安裝 PHPEclipse 和如何使用它的更多內容。
• DBG 是一個全功能的 PHP 調試器引擎，一個互動的工具，有助於調試 PHP 指令碼。請閱讀 Installing and configuring the debugger 上的這份教程。
• 要學習關於 Eclipse 的更多內容，請訪問 developerWorks 的 Eclipse project resources。
• 要學習關於 PHP 的更多內容，請訪問 developerWorks 的 PHP project resources。
• 請參閱 PHP 手冊獲得更多關於 error reporting 的內容。
• 請閱讀安裝 PHP and Apache2 on Linux 的操作說明。
• 請閱讀安裝 PHP and Apache2 on Windows 的操作說明。
• 要獲得一系列學習 PHP 編程的 developerWorks 教程，請參閱 “學習 PHP，第 1 部分”、學習 PHP，第 2 部分 和 學習 PHP，第 3 部分。
• 請密切關注 developerWorks technical events and webcasts。
• 請訪問 developerWorks 開放源碼專區 獲得豐富的 how-to 資訊、工具和項目更新，有助於用開放源碼技術進行開發並把它們用於 IBM 的產品。

獲得產品和技術

• 請從 PHP.net 下載最新版本的 PHP。

• 請下載最新版本的 Apache 2。
• 請從 Sun 公司下載 Java 技術。
• 請從 Eclipse.org 下載最新版本的 Eclipse。
• 請從 Sourceforge 下載 PHPEclipse。把 Eclipse 解壓到 eclipse-install-dir，然後把 PHPEclipse 解壓到 eclipse-install-dir。在安裝擴充時，要按照 PHPEclipse instructions。但是，在要求在 php.ini 檔案中裝入和配置 PHP 擴充的地方注釋掉那些行。在準備使用調試器時再取消這些行的注釋。
• 訂購免費的 SEK for Linux，這套 DVD（兩張），包含了來自 DB2、Lotus、 Rational、Tivoli 和 WebSphere 的用於 Linux 的最新 IBM 試用軟體。
• 請用 IBM 試用軟體 改造您的下一個開放源碼開發項目，可以下載也可以通過 DVD 得到。

討論

• 通過參與 developerWorks blogs 加入 developerWorks 社區。

關於作者

		Tyler Anderson 2004 年從 Brigham Young 大學畢業，獲得電腦科學學位。現在是他作為電腦工程碩士生的最後一學期。過去，他作為資料庫程式員為 DPMG.com 工作，現在他是位於 Beaverton, Ore 的 Stexar 公司的工程師。

原文地址 http://www.ibm.com/developerworks/cn/opensource/os-debug/