在PHP 中,預設的錯誤處理很簡單。一條錯誤訊息會被傳送到瀏覽器,這則訊息帶有檔案名稱、行號以及描述錯誤的訊息。
在建立腳本和Web 應用程式時,錯誤處理是一個重要的部分。如果您的程式碼缺少錯誤偵測編碼,那麼程式看起來很不專業,也為安全風險敞開了大門。
本教學介紹了PHP 中一些最重要的錯誤偵測方法。
我們將為您講解不同的錯誤處理方法:
簡單的"die()" 語句
自訂錯誤和錯誤觸發器
錯誤報告
第一個實例展示了一個打開文字檔案的簡單腳本:
<?php$file=fopen("welcome.txt","r");?>
如果文件不存在,您會得到類似這樣的錯誤:
Warning: fopen(welcome.txt) [function.fopen]: failed to open stream:No such file or directory in /www/codercto/test/test.php on line 2
為了避免用戶得到類似上面的錯誤訊息,我們在存取文件之前檢測該文件是否存在:
<?phpif(!file_exists("welcome.txt")){ die("檔案不存在");}else{ $file=fopen("welcome.txt","r");}?>
現在,如果文件不存在,您會得到類似這樣的錯誤訊息:
文件不存在
相較於之前的程式碼,上面的程式碼更有效,這是由於它採用了一個簡單的錯誤處理機制在錯誤之後終止了腳本。
然而,簡單地終止腳本並不總是恰當的方式。讓我們研究一下用於處理錯誤的備選的PHP 函數。
建立一個自訂的錯誤處理器非常簡單。我們很簡單地創建了一個專用函數,可以在PHP 中發生錯誤時呼叫該函數。
此函數必須有能力處理至少兩個參數(error level 和error message),但是可以接受最多五個參數(可選的:file, line-number 和error context):
error_function(error_level,error_message,error_file,error_line,error_context)
參數 | 描述 |
---|---|
error_level | 必需。為使用者定義的錯誤規定錯誤報告等級。必須是一個數字。請參閱下面的表格:錯誤報告層級。 |
error_message | 必需。為使用者定義的錯誤規定錯誤訊息。 |
error_file | 可選。規定錯誤發生的檔案名稱。 |
error_line | 可選。規定錯誤發生的行號。 |
error_context | 可選。規定一個數組,包含了當錯誤發生時在用的每個變數以及它們的值。 |
這些錯誤報告等級是用戶自訂的錯誤處理程序處理的不同類型的錯誤:
值 | 常量 | 描述 |
---|---|---|
2 | E_WARNING | 非致命的run-time 錯誤。不暫停腳本執行。 |
8 | E_NOTICE | run-time 通知。在腳本發現可能有錯誤時發生,但也可能在腳本正常運行時發生。 |
256 | E_USER_ERROR | 致命的用戶產生的錯誤。這類似於程式設計師使用PHP 函數trigger_error() 設定的E_ERROR。 |
512 | E_USER_WARNING | 非致命的用戶生成的警告。這類似於程式設計師使用PHP 函數trigger_error() 設定的E_WARNING。 |
1024 | E_USER_NOTICE | 用戶產生的通知。這類似於程式設計師使用PHP 函數trigger_error() 設定的E_NOTICE。 |
4096 | E_RECOVERABLE_ERROR | 可捕獲的致命錯誤。類似E_ERROR,但可被使用者定義的處理程序擷取。 (參見set_error_handler()) |
8191 | E_ALL | 所有錯誤和警告。 (在PHP 5.4 中,E_STRICT 成為E_ALL 的一部分) |
現在,讓我們建立一個處理錯誤的函數:
function customError($errno, $errstr){ echo "<b>Error:</b> [$errno] $errstr<br>"; echo "腳本結束"; die();}
上面的程式碼是一個簡單的錯誤處理函數。當它被觸發時,它會取得錯誤等級和錯誤訊息。然後它會輸出錯誤等級和訊息,並終止腳本。
現在,我們已經建立了一個錯誤處理函數,我們需要確定在何時觸發函數。
PHP 的預設錯誤處理程序是內建的錯誤處理程序。我們打算把上面的函數改造為腳本運行期間的預設錯誤處理程序。
可以修改錯誤處理程序,使其只套用到某些錯誤,這樣腳本就能以不同的方式來處理不同的錯誤。然而,在本例中,我們打算針對所有錯誤來使用我們自訂的錯誤處理程序:
set_error_handler("customError");
由於我們希望我們的自訂函數能處理所有錯誤,set_error_handler() 只需要一個參數,可以加入第二個參數來規定錯誤等級。
透過嘗試輸出不存在的變量,來測試這個錯誤處理程序:
<?php// 錯誤處理函數function customError($errno, $errstr){ echo "<b>Error:</b> [$errno] $errstr";}// 設定錯誤處理函數set_error_handler("customError") ;// 觸發錯誤echo($test);?>
以上程式碼的輸出如下所示:
Error: [8] Undefined variable: test
在腳本中使用者輸入資料的位置,當使用者的輸入無效時觸發錯誤是很有用的。在PHP 中,這個任務由trigger_error() 函數完成。
在本例中,如果"test" 變數大於"1",就會發生錯誤:
<?php$test=2;if ($test>1){ trigger_error("變數值必須小於等於1");}?>
以上程式碼的輸出如下所示:
Notice: 變數值必須小於等於1in /www/test/codercto.php on line 5
您可以在腳本中任何位置觸發錯誤,透過新增的第二個參數,您能夠規定所觸發的錯誤等級。
可能的錯誤類型:
E_USER_ERROR - 致命的使用者產生的run-time 錯誤。錯誤無法恢復。腳本執行被中斷。
E_USER_WARNING - 非致命的使用者產生的run-time 警告。腳本執行不被中斷。
E_USER_NOTICE - 預設。使用者產生的run-time 通知。在腳本發現可能有錯誤時發生,但也可能在腳本正常運行時發生。
在本例中,如果"test" 變數大於"1",則發生E_USER_WARNING 錯誤。如果發生了E_USER_WARNING,我們將使用我們自訂的錯誤處理程序並結束腳本:
<?php// 錯誤處理函數function customError($errno, $errstr){ echo "<b>Error:</b> [$errno] $errstr<br>"; echo "腳本結束"; die(); }// 設定錯誤處理函數set_error_handler("customError",E_USER_WARNING);// 觸發錯誤$test=2;if ($test>1){ trigger_error("變數值必須小於等於1",E_USER_WARNING);}?>
以上程式碼的輸出如下所示:
Error: [512] 變數值必須小於等於1腳本結束
現在,我們已經學習如何建立自己的error,以及如何觸發它們,接下來我們研究一下錯誤記錄。
在預設的情況下,根據在php.ini 中的error_log 配置,PHP 會向伺服器的記錄系統或檔案傳送錯誤記錄。透過使用error_log() 函數,您可以向指定的檔案或遠端目的地傳送錯誤記錄。
透過電子郵件向自己發送錯誤訊息,是一種獲得指定錯誤的通知的好辦法。
在下面的範例中,如果特定的錯誤發生,我們將發送帶有錯誤訊息的電子郵件,並結束腳本:
<?php// 錯誤處理函數function customError($errno, $errstr){ echo "<b>Error:</b> [$errno] $errstr<br>"; echo "已通知網站管理員"; error_log ("Error: [$errno] $errstr",1, "[email protected]","From: [email protected]");}//設定錯誤處理函數set_error_handler("customError",E_USER_WARNING);// 觸發錯誤$test=2;if ($test>1){ trigger_error("變數值必須小於等於1",E_USER_WARNING);}?>
以上程式碼的輸出如下所示:
Error: [512] 變數值必須小於等於1已通知網站管理員
接收自以上程式碼的郵件如下所示:
Error: [512] 變數值必須小於等於1
這個方法不適合所有的錯誤。常規錯誤應透過使用預設的PHP 記錄系統在伺服器上進行記錄。