用PHP自定義錯誤處理器處理出錯信息,如果您是PHP老手,當然知道當PHP腳本出錯時發生了什么事情。此時PHP解析器將在屏幕上給出錯誤信息,如 Fatal error: Call to undefined function on line 19 --,因此程序在此處終止。這個信息會嚇到客戶,他可能立即打電話和你進行咨詢。
幸運的是,這里有解決辦法。PHP擁有內置工具,可以讓開發人員捕捉腳本錯誤然后將它們轉到自定義的錯誤處理器。此時則可以對處理器進行編程顯示更多關于錯誤的詳細信息。還可以將錯誤寫入文件或數據庫以采取補救措施。有時候還可以對處理器編寫程序忽略錯誤消息。
本文中,我將闡述如何使用PHP的錯誤處理API構建用戶自定義的錯誤處理器,并且說明如何以簡單而友好的方式顯示和管理腳本的錯誤信息。
錯誤類型和報告級別
我們從最基本的開始。PHP有三種最基本的錯誤類型,從低級到高級分別為:注意、警告和錯誤(或致命錯誤)。通常情況下,注意和警告不會終止程序;但是致命錯誤則是危險故障(例如,調用一個沒有定義的函數或參考一個不存在的對象),將導致程序中斷。這些錯誤有可能在啟動、解析、編譯或運行時發生。
關鍵字如E_NOTICE, E_ERROR等用于表明錯誤的不同類型和等級。在PHP手冊上可以獲得它們的詳細信息列表。
腳本階段錯誤顯示由error_reporting()函數進行控制。這一函數針對不同的錯誤等級設置不同的參數。表A給出了使用此函數報告警告和致命錯誤的腳本程序。
表A
// display warnings and errors
error_reporting(E_WARNING | E_ERROR);
// this will generate a notice, which will never be displayed
echo $undefinedVar;
// this will generate a fatal error, which will be displayed
callUndefFunc();
?>
將表B中的代碼與上面的進行比較發現,Listing B中隱藏錯誤信息甚至隱藏致命信息,使得錯誤信息不會被顯示出來。
表B
// turn off error display
// no errors will be displayed
error_reporting(0);
// this will generate a notice
echo $undefinedVar;
// this will generate a fatal error
callUndefFunc();
?>
表C中的代碼將所有錯誤信息甚至簡單的注意事項都顯示出來:
表C
// all errors will be displayed
error_reporting(E_ALL);
// this will generate a notice
echo $undefinedVar;
// this will generate a fatal error
callUndefFunc();
?>
如以上3個例子所示,error_reporting()函數在控制錯誤發生時,在屏幕上顯示內容非常重要。這里的關鍵字是displayed,其表達的意思是錯誤不被顯示而不是錯誤沒有發生。因此,發生致命錯誤時(例如不正確的函數調用),程序將被終止;但是,此時沒有任何消息顯示給用戶。
下面的例子(表 D)說明了這種情況:
表D
// no errors will be displayed
error_reporting(0);
// start a task
echo "Starting task...";
// call an undefined function
// a fatal error occurs during task processing
callMe();
// end the task
echo "Successfully completed task...";
?>
在表D中,在調用echo()函數時發生了致命錯誤,程序執行時到這點被終止,但是卻沒有任何錯誤消息給出,用戶不知道這種情況還以為程序在正確運行。下面的結論是非常明顯的:不給出錯誤報告非常危險,因為不論過程是否完成它常導致不正確的結論。
注意:調用不帶任何參數的error_reporting()將返回當前的錯誤報告等級。
自定義錯誤處理器
很明顯,隱藏錯誤報告是不正確的,你肯定想知道有什么其他辦法加以改進。自定義錯誤處理器就是一個很好的能取代PHP默認錯誤處理系統的解決方法。自定義錯誤處理器可以以任何方式設置處理錯誤信息,包括信息如何顯示。
PHP函數中,完成這一功能的是set_error_handler()函數。錯誤發生時,此函數被自動調用,然后給出4個參數:錯誤代碼、錯誤消息、發生錯誤的腳本名稱和錯誤出現的行,此函數對錯誤管理負責。
表E給出一個簡單例子:
表E
// define custom handler
set_error_handler('myHandler');
// custom handler code
function myHandler($code, $msg, $file, $line) {
echo "Just so you know, something went wrong at line $line of your script $file. The system says that the error code was $code, and the reason for the error was: $msg. Sorry about this!";
}
// generate a notice
echo $undefVar;
?>
當運行此腳本的時候,會出現下面的信息:
Just so you know, something went wrong at line 11 of your /dev/error1.php. The system says that the error code was 8, and the reason for the error was: Undefined variable: undefVar. Sorry about this!
此時,PHP的默認錯誤處理器被用戶定義的myHandler()函數所取代,$undefVar變量被激活,PHP通知未定義變量的信息,此信息在運行時引擎產生,然后傳遞給myHandler()函數,同時錯誤發生的地址也傳遞給此函數。然后myHandler()函數輸出友好信息解釋錯誤。
注意:錯誤和致命錯誤很重要,它們會繞過自定義錯誤處理器,然后以PHP默認的錯誤處理機制進行顯示。顯示這些信息可使用前面討論的標準error_reporting()函數進行控制。
例1:動態錯誤頁面和e-mail警報
表F給出了另一個范例,當發生錯誤時,將動態產生HTML錯誤頁面,并且通過e-mail向Web管理員進行報告。
表F
// define custom handler
set_error_handler('myHandler');
// custom handler code
function myHandler($code, $msg, $file, $line, $context) {
// print error page
echo "";
echo "
Error!
";
echo "";
echo "An error occurred while processing your request. Please visit our home page and try again.";
echo "";
echo "";
// email error to admin
$body = "$msg at $file ($line), timed at " . date ("d-M-Y h:i:s", mktime());
$body .= "/n/n" . print_r($context, TRUE);
mail ("webmaster@domain.dom", "Web site error", $body);
// halt execution of script
die();
}
// generate a notice
echo $undefVar;
?>
這里,自定義的錯誤處理器在遇到錯誤時動態產生HTML錯誤頁面。此錯誤信息也能被e-mail信息捕獲,然后通過PHP內置的mail()函數發送給管理員。
這里出現了myHandler()函數的一個新參數$context。這是myHandler()函數的第五個參數,是可選項。它包含了當前變量狀態的快照。包括對管理員有用的上下文信息,有利于減少調試時間。
例2:自定義錯誤日志
表G給出了另一個例子,這個例子說明自定義錯誤處理器如何將詳細的錯誤信息輸入到文件。
表G
// define custom handler
set_error_handler('myHandler');
// custom handler code
function myHandler($code, $msg, $file, $line) {
// print error page
echo "";
echo "
Error!
";
echo "";
echo "An error occurred while processing your request. Please visit our home page and try again.";
echo "";
echo "";
// log error to file, with context
$logData = date("d-M-Y h:i:s", mktime()) . ", $code, $msg, $line, $file/n";
file_put_contents("web.log", $logData, FILE_APPEND);
// halt execution of script
die();
}
// generate a warning
echo is_float();
?>
與前面的例子相似,它也產生一個錯誤頁面并且將錯誤數據輸入到文件,以利于管理員進行查看。數據以CSV格式進行存儲,并且有簡單的數據分析和報告。請注意在本例和前面實例中,錯誤處理代碼結束時調用die()函數,以確保腳本不再運行。
如上面的范例所示,自定義錯誤處理器允許以友好的方式處理PHP腳本錯誤。并且可以發揮自己的創造性,不過需要記住的是:任何靈活性的增加都伴隨著開銷和時間的增加。
新聞熱點
疑難解答