PHP 錯誤處理
在 PHP 中,預設的錯誤處理很簡單。一條錯誤訊息會被髮送到瀏覽器,這條訊息帶有檔名、行號以及描述錯誤的訊息。
PHP 錯誤處理
在建立指令碼和 Web 應用程式時,錯誤處理是一個重要的部分。如果您的程式碼缺少錯誤檢測編碼,那麼程式看上去很不專業,也為安全風險敞開了大門。
本教程介紹了 PHP 中一些最為重要的錯誤檢測方法。
我們將為您講解不同的錯誤處理方法:
- 簡單的 "die()" 語句
- 自定義錯誤和錯誤觸發器
- 錯誤報告
基本的錯誤處理:使用 die() 函式
第一個例項展示了一個開啟文字檔案的簡單指令碼:
<?php $file=fopen("welcome.txt","r"); ?>
如果檔案不存在,您會得到類似這樣的錯誤:
Warning: fopen(welcome.txt) [function.fopen]: failed to open stream: No such file or directory in /www/itread01/test/test.php on line 2
為了避免使用者得到類似上面的錯誤訊息,我們在訪問檔案之前檢測該檔案是否存在:
<?php if(!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: 變數值必須小於等於 1 in /www/test/itread01.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() 函式,您可以向指定的檔案或遠端目的地傳送錯誤記錄。
通過電子郵件向您自己傳送錯誤訊息,是一種獲得指定錯誤的通知的好辦法。
通過 E-Mail 傳送錯誤訊息
在下面的例子中,如果特定的錯誤發生,我們將傳送帶有錯誤訊息的電子郵件,並結束指令碼:
<?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 記錄系統在伺服器上進行記錄。