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 瀏覽器顯示它的內容。但是第二個語句會生成錯誤並在 Web 頁面上顯示。這造成最後一個 print() 語句不起作用,如圖 1 所示。

圖 1. 生成錯誤
生成錯誤

  現在開啟瞭錯誤報告!接下來,用 print 語句幫助調試應用程序。

  介紹 print 語句

  因為應用程序中的功能性 bug 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 print 或 die 語句來調試 PHP 應用程序的知識是一種很好的資產。可以用 print 語句在代碼中縮小對問題語句的定位,這些語句在語法上沒有錯誤,也不是 bug,但是從代碼的功能上看是 bug。這些是最難發現和調試的 bug,因為它們不會拋出錯誤。惟一知道的就是在瀏覽器上顯示的內容不是想要的內容,或者想要保存在數據庫中的內容根本沒有保存。

  假設正在處理通過 GET 請求發送過來的表單數據,想向瀏覽器顯示信息,但是出於某種原因,數據沒有正確地提交,或者不能正確地從 GET 請求中讀出。要調試這類問題,重要的是用 print() 或 die() 語句知道變量的值是什麼。

  die() 語句會中止程序執行,並在 Web 瀏覽器上顯示文本。如果不想註釋掉代碼,而且隻想顯示到出錯之前的信息和出錯信息,不想顯示後面的信息,那麼 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 v

發佈留言