PHP 程序員的調試技術

最簡單的誰都會的調試(是麼?):
本來安裝php是沒問題 也能用了 但是又從書上抄了一些代碼來發現不能用, 那就用眼睛仔細的對着書本糾正一下代碼哈 肯定是你抄錯了 要麼是印刷錯了
比如 1(yi)跟l(el) 0(ling)跟O(大寫o)等

別笑哈 真的有人抄錯過 還讓我過去幫忙調試 過去我錄入進去(他的沒保存) 就全對了

言歸正傳
Q: "爲什麼要調試?"
A: 當然是因爲程序錯啦. 你以爲我有什麼別的答案?
Q: "可是我覺得我的程序應該沒錯啊!"
A: 不能出來期望的結果 當然是錯誤發生. 有這種思想的人是根本不具備調試觀念 更沒有調試能力.
Q: 那調試有什麼用?
A: 不管是你配置的php出錯 還是你的程序寫錯 還是你寫的正確的程序跟別人配置的php(比如免費空間)犯衝, 學會調試都能找出原因來
Q: 邏輯亂了能調試好麼?
A: 或許你偶爾改來改去改好了 以爲是調試好了 其實那已經不是單純的調試, 而是反覆的用程序代碼進行思考, 並且反覆的改代碼來"實踐"某個idea是否可行.
可以說是"調試邏輯"而非"調試代碼":
邏輯沒代碼或者亂代碼--調試/修改邏輯-->正確的邏輯->體現在代碼上,出來正確的代碼.
單純的調試代碼是:
正確的邏輯--編碼-->出錯的代碼--調試-->正確的代碼
所以調試可以分爲:
1.調試邏輯, 2.調試代碼, 3.調試界面. 4. etc..
錯誤的邏輯是不可能出來正確的程序. 寫程序首先得把邏輯(流程)弄清楚, 然後纔開始編碼.
合併在一起就是:
含糊的邏輯--調試邏輯-->正確的邏輯--編碼-->出錯的代碼--調試代碼-->正確的代阿馬
其中調試邏輯你可以利用"修改代碼"來輔助 免得腦子太累, 但是腦子必須動, 不能不思考亂改來改去, 而且不能跟 "調試代碼" 混在一起.
改小錯誤 常常混在一起 就解決了, 但是要養成分開的習慣, 對於大錯誤才能一樣輕鬆解決.

別慌
很初學者 一碰到錯誤就慌了, 腦子裏只知道"不行啊 錯了 慘了 找個人問問", 要冷靜下來 根據所學的知識去研究, 到底什麼是debug, 如何debug, 出錯了到底該幹什麼

基本調試:
1. 打開調試功能: php.ini 裏 設置error_reporting = E_ALL以及 display_errors = On 重啓 web服務(apache)
2. 刷新錯誤的頁面 查看錯誤提示 行號 文件名
3. 打開該文件 定位到出錯行. 比如代碼 echo $abc[2];
4. 理解錯誤:
a. 查看手冊 理解錯誤含義 要能理解首先要理解語言 比如最簡單的 Undefined index 2 意思是數組不存在該下標 也就說明你訪問了某個數組不存在的元素
b. 如果已經知道如何改 就直接修改, 比如改成 echo $abc[0];
c. 不知道就顯示變量內容 在同樣的地方 加入 var_dump($abc); 刷新頁面 看看$abc這個東西到底包含了什麼元素
d. 認爲本該存在 $abc[2]的, 那就尋找錯誤源, 往上回朔, 或者用 var_dump(debug_backtrace());
必要的時候 var_dump($_POST, $_GET, $_COOKIE, $_SERVER....)

本人未用過單步調試 (step by step) 如果使用調試器相對簡單一點 可以暫停下來 看看變量的內容 到底是不是 中應該出現的值, 如果不是 又是哪裏產生這個值的


注意留意什麼是環境
環境:
爲什麼全世界那麼多人沒事就你的有問題? 你的問題愛上了你 還是你愛上了你的問題?
其實"一方水土養一方人", 你的"環境"養你的bug.
平時閱讀書本/手冊, 注意記錄整理什麼是"環境".
$_GET $_POST $_COOKIE $_SESSION $_SERVER 這些是程序運行的至關重要因素 當然還包括你自己搞出來的 $GLOBALS, 都可以var_dump他們 看看內容.
還有strtolower/strtoupper之類 跟setlocale()函數有關, 而默認值在linux下跟 getenv("LANG") getenv("LC_ALL") 之類有關(putenv不一定起作用)
還有其他的 比如php.ini的配置.
還有web服務器配置, 比如apache支持某些函數而在別的服務器下就不支持

btw1: 你的調試能力跟你的編碼能力是相互相成的, 根據你的編碼經驗你覺得還有什麼該注意的 可以提出來
btw2: 有些你或許覺得很簡單很平常, 但是想想你自己是不是真的做到了



-------------------------------- 以下內容比較羅嗦
對於你一眼就看出來的問題, 當然可以立即解決, 但是如果沒頭緒那就參考:
調試的大方向:
抓!
a. 擒賊先擒王, 最大的錯誤就是邏輯錯誤, 先審查一邊邏輯, 然後纔是代碼關鍵的部位(跟錯誤可能相關的)
b. 順瓜摸根.., 有果必有因, 知道最終錯誤的"結果", 順着摸過去 就能發生錯誤的"原因", 比如
if ($logined) {
$a = 100;
}
$_SESSION['a'] = $a; 提示Undefined variable $a, 顯然要找產生$a變量的地方, 往上找到 if那塊 發現只有if true的時候纔有$a於是改成
if ($logined) {
$a = 100;
} else {
$a = 0;
}

比如mysql的函數出錯 就有好多提示
提示 密碼錯誤: 看看是參數的密碼錯了 還是mysql服務器設置的密碼錯了
提示 sql字段不存在, 打開phpmyadmin去表裏看看有哪些字段 程序寫錯了還是忘記添加了 還是搞錯表了
提示語句錯誤, 找mysql手冊 而不是php手冊

拆!
所謂萬衆一心 那個什麼什麼來着, 但是我們是一個人面對的一個"龐大"的代碼, 所以要來個"反之亦然", 把錯誤從代碼裏分開, 把多個錯誤拆開. 如此一來, 對於你來說只不過是多個小小的錯誤, 一個個消滅.

憶:
回想以前是不是碰到類似的錯誤提示, 那個時候是怎麼解決的. 如果沒有回想到, 那就應該找新的方法.
對於初學者來說, 反覆鍛鍊很重要, 回憶能加強學過的能力/方法, 直到聯會貫通, 應用自如.

對比:
跟本文開頭說的差不多, 就是找正確的代碼來對比.
有時候是沒有相應的正確代碼的, 這個時候可以在腦子裏重新構思一個正確代碼來對比, 有點難 呵呵, 不過這樣是避免又照着錯誤的思路去想
再就是看看手冊, 根據手冊說明就知道其實應該如何 不該如何.

OO 思路
要求你的程序比較OO(不一定是對象, 但是結構/思路上有oo)
OO編程簡單說就是對象化, 每個類型的對象完成某個功能, 就像一隻老鼠只需要吃就能活, 一個對象/或者某部分代碼 只需要所期望的一些數據就能正常工作.
OO debug法就是首先要有個觀念: 我的某個對象(or代碼)只需要有一定的數據(環境下)就可以正常工作
如果
1. 有正常的數據也出錯 則說明是這個對象設計錯了
2. 傳入的數據不正常, 則說明使用這個對象的代碼調用錯了
高手或許覺得這條很"傻", 其實對於初學者(包括以前的我) 要形成這樣的觀念 以及一直使用這個觀念來調試, 卻是要到了很久之後 接近高手了 才懂.
有點像'拆'方法 不過區別在於調試的時候:
1. 取對象出來 可以單獨調試, 因爲好的對象(or代碼) 只需要儘量簡單的數據, 複雜的數據可能在對象內部或者外部生存, 而不會跨出/入對象(也就是不會傳進來 也不會傳出去)
2. 對於web要快速調試, 並不一定要把對象的代碼全部掏出來, 只需要再調用對象的部分 添加一些用來查看對象語句, 比如var_dump($obj) var_dump($obj->myabc);
或者類似 echo $http->download(); 這樣的調用之前 手工設置一些自己熟悉的數據 比如:
$http->setUrl("http://localhost/abc.html");
直到確保這個對象工作正常了, 就可以暫時撇開這個對象的代碼了, 看看別的東西有沒有錯誤
--------------------------------------------------------------------------------------------------------------------------

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 via a GET request:<br>");
 foreach(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 提交的所有變量
___FCKpd___5

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


圖 2. test2.php 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能

...
 foreach(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 via a GET request:<br>");
 foreach(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 提交的所有變量
___FCKpd___5

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


圖 2. test2.php 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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


<?php
print(,"Hello World!");
?>

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點

<?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() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

GET as $key => $i){ print("$key=$j<br>"); } if(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 提交的所有變量
___FCKpd___5

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


圖 2. test2.php 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

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 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

GET as $key => $i){ print("Correct data? " .

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 via a GET request:<br>");
 foreach(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 提交的所有變量
___FCKpd___5

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


圖 2. test2.php 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

GET as $key => $i){ print("$key=$j<br>"); } if(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 提交的所有變量
___FCKpd___5

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


圖 2. test2.php 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

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 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

GET[$key] . "<br>")
; print("$key=$j<br>"); } ...

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

GET as $key => $i){ print("$key=$j<br>"); } if(

使用 print 語句、錯誤報告和 PHPEclipse 插件

 
 

級別: 中級

Tyler Anderson , 自由作者

2006 年 1 月 23 日

本文介紹調試 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 不會產生錯誤,所以在所有調試策略中,關於如何正確地放置和使用 printdie 語句來調試 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 提交的所有變量
___FCKpd___5

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


圖 2. test2.php 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

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 的輸出
test2.php 的輸出

現在單擊 Send GET Request 按鈕,請注意只有 $_GET 請求的鍵顯示在瀏覽器上,而正確的值都沒顯示。可以在循環中放一個 print 語句,檢驗在 foreach 循環中每個元素中是否確實存在數據。請參閱清單 3。


清單 3. 用 print 語句驗證代碼的功能
___FCKpd___6

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


圖 3. 修改後的 test2.php 的輸出
修改後的 test2.php 的輸出

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


圖 4. 修正後的 test2.php 的輸出
修正後的 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 插件
Eclipse 的 PHPEclipse 插件

注意,只有 Windows® 的用戶可以像清單 5 所示的那樣使用 PHP 瀏覽器。通過打開獨立瀏覽器窗口並把瀏覽器指向測試腳本所在目錄,也可以使用同樣的功能。

現在來演示這個應用程序,證明它的強大能力。

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

語法解析和加下劃線

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

___FCKpd___7

注意,在清單 4 中加下劃線的兩個字符在 Eclipse 中加了下劃線,提示語法不正確。按 Ctrl+S 保存文件,會在 Eclipse 中顯示解析錯誤:在代碼中與解析錯誤對應的行上會加上紅 “x”,如圖 6 所示。


圖 6. 語法錯誤強調
語法錯誤強調

現在演示 PHP 瀏覽器。這個窗口提供了當前 PHP 腳本的預覽,如圖 6 所示。

從上面定義的 test3.php 中刪除逗號(,)。按 Ctrl+S 保存文件,然後觀察 PHP 瀏覽器窗口的更新,顯示了 Hello World(參見圖 7)。


圖 7. 在 PHPEclipse 中預覽 PHP 腳本
在 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 透視圖
Eclipse 中的 Debug 透視圖

現在可以設置斷點了。

對於本文中使用的插件和擴展的版本,斷點功能是必需的,因爲 PHP 在把輸出發送到瀏覽器之前會緩衝它。除此之外,需要做的不僅僅是設置一個斷點把當前顯示數據刷新到 Web 瀏覽器,所以要像下面和圖 8 所示那樣定義 test4.php。


清單 4. 設置和創建斷點
___FCKpd___8

breakpoint() 函數會把緩衝的輸出和其他緩衝的數據刷新到 Web 瀏覽器。對 sleep(.1) 的調用是必需的,這樣代碼中止於 debugBreak() 之前,服務器纔有足夠的時間把數據刷新到 Web 瀏覽器,這個函數是前面下載的 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 瀏覽器輸出
初始的到第一個斷點的 PHP 瀏覽器輸出

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


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

圖 10 的 Debug 窗口仍然把執行顯示爲掛起,而第二組數據顯示在 PHP 瀏覽器中。


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

注意,圖 11 的 Debug 窗口中的代碼不再掛起,整個腳本已經執行,如圖 11 中的 PHP 瀏覽器所示。

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


 


結束語

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

 

---------------------------------------------------------------------------------------------------------------------------------

 

發佈了52 篇原創文章 · 獲贊 5 · 訪問量 33萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章