【PHP基礎】PHP教程(錯誤處理、異常處理)
1、錯誤處理
在 PHP 中,默認的錯誤處理很簡單。一條消息會被發送到瀏覽器,這條消息帶有文件名、行號以及一條描述錯誤的消息。在創建腳本和 web 應用程序時,錯誤處理是一個重要的部分。如果您的代碼缺少錯誤檢測編碼,那麽程序看上去很不專業,也為安全風險敞開了大門。
本教程介紹了 PHP 中一些最為重要的錯誤檢測方法。
我們將為您講解不同的錯誤處理方法:
- 簡單的 "die()" 語句
- 自定義錯誤和錯誤觸發器
- 錯誤報告
1.1、基本的錯誤處理:使用 die() 函數
第一個例子展示了一個打開文本文件的簡單腳本:
<?php $file=fopen("welcome.txt","r"); ?>
如果文件不存在,您會獲得類似這樣的錯誤:
Warning: fopen(welcome.txt) [function.fopen]: failed to open stream:
No such file or directory in C:\webfolder\test.php on line 2
為了避免用戶獲得類似上面的錯誤消息,我們在訪問文件之前檢測該文件是否存在:
<?php if(!file_exists("welcome.txt")) { die("File not found"); }else { $file=fopen("welcome.txt","r"); } ?>
現在,假如文件不存在,您會得到類似這樣的錯誤消息:
File not found
比起之前的代碼,上面的代碼更有效,這是由於它采用了一個簡單的錯誤處理機制在錯誤之後終止了腳本。
不過,簡單地終止腳本並不總是恰當的方式。讓我們研究一下用於處理錯誤的備選的 PHP 函數。
1.2、創建自定義錯誤處理器
創建一個自定義的錯誤處理器非常簡單。我們很簡單地創建了一個專用函數,可以在 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 |
所有錯誤和警告,除級別 E_STRICT 以外。 (在 PHP 6.0,E_STRICT 是 E_ALL 的一部分) |
現在,讓我們創建一個處理錯誤的函數:
function customError($errno, $errstr) { echo "<b>Error:</b> [$errno] $errstr<br />"; echo "Ending Script"; die(); }
上面的代碼是一個簡單的錯誤處理函數。當它被觸發時,它會取得錯誤級別和錯誤消息。然後它會輸出錯誤級別和消息,並終止腳本。
現在,我們已經創建了一個錯誤處理函數,我們需要確定在何時觸發該函數。
1.3、Set Error Handler
PHP 的默認錯誤處理程序是內建的錯誤處理程序。我們打算把上面的函數改造為腳本運行期間的默認錯誤處理程序。
可以修改錯誤處理程序,使其僅應用到某些錯誤,這樣腳本就可以不同的方式來處理不同的錯誤。不過,在本例中,我們打算針對所有錯誤來使用我們的自定義錯誤處理程序:
set_error_handler("customError");
由於我們希望我們的自定義函數來處理所有錯誤,set_error_handler() 僅需要一個參數,可以添加第二個參數來規定錯誤級別。
通過嘗試輸出不存在的變量,來測試這個錯誤處理程序:
<?php //error handler function function customError($errno, $errstr) { echo "<b>Error:</b> [$errno] $errstr"; } //set error handler set_error_handler("customError"); //trigger error echo($test); ?>
以上代碼的輸出應該類似這樣:
Error: [8] Undefined variable: test
1.4、觸發錯誤
在腳本中用戶輸入數據的位置,當用戶的輸入無效時觸發錯誤的很有用的。在 PHP 中,這個任務由 trigger_error() 完成。
在本例中,如果 "test" 變量大於 "1",就會發生錯誤:
<?php $test=2; if ($test>1) { trigger_error("Value must be 1 or below"); } ?>
以上代碼的輸出應該類似這樣:
Notice: Value must be 1 or below
in C:\webfolder\test.php on line 6
您可以在腳本中任何位置觸發錯誤,通過添加的第二個參數,您能夠規定所觸發的錯誤級別。
可能的錯誤類型:
- E_USER_ERROR - 致命的用戶生成的 run-time 錯誤。錯誤無法恢復。腳本執行被中斷。
- E_USER_WARNING - 非致命的用戶生成的 run-time 警告。腳本執行不被中斷。
- E_USER_NOTICE - 默認。用戶生成的 run-time 通知。腳本發現了可能的錯誤,也有可能在腳本運行正常時發生。
在本例中,如果 "test" 變量大於 "1",則發生 E_USER_WARNING 錯誤。如果發生了 E_USER_WARNING,我們將使用我們的自定義錯誤處理程序並結束腳本:
<?php //error handler function function customError($errno, $errstr) { echo "<b>Error:</b> [$errno] $errstr<br />"; echo "Ending Script"; die(); } //set error handler set_error_handler("customError",E_USER_WARNING); //trigger error $test=2; if ($test>1) { trigger_error("Value must be 1 or below",E_USER_WARNING); } ?>
以上代碼的輸出應該類似這樣:
Error: [512] Value must be 1 or below
Ending Script
現在,我們已經學習了如何創建自己的 error,以及如何觸發它們,現在我們研究一下錯誤記錄。
1.5錯誤記錄
默認地,根據在 php.ini 中的 error_log 配置,PHP 向服務器的錯誤記錄系統或文件發送錯誤記錄。通過使用 error_log() 函數,您可以向指定的文件或遠程目的地發送錯誤記錄。
通過電子郵件向您自己發送錯誤消息,是一種獲得指定錯誤的通知的好辦法。
通過 E-Mail 發送錯誤消息
在下面的例子中,如果特定的錯誤發生,我們將發送帶有錯誤消息的電子郵件,並結束腳本:
<?php //error handler function function customError($errno, $errstr) { echo "<b>Error:</b> [$errno] $errstr<br />"; echo "Webmaster has been notified"; error_log("Error: [$errno] $errstr",1, "[email protected]","From: [email protected]"); } //set error handler set_error_handler("customError",E_USER_WARNING); //trigger error $test=2; if ($test>1) { trigger_error("Value must be 1 or below",E_USER_WARNING); } ?>
以上代碼的輸出應該類似這樣:
Error: [512] Value must be 1 or below
Webmaster has been notified
接收自以上代碼的郵件類似這樣:
Error: [512] Value must be 1 or below
這個方法不適合所有的錯誤。常規錯誤應當通過使用默認的 PHP 記錄系統在服務器上進行記錄。
2、異常處理
異常(Exception)用於在指定的錯誤發生時改變腳本的正常流程。
什麽是異常?
異常處理用於在指定的錯誤(異常)情況發生時改變腳本的正常流程。這種情況稱為異常。
當異常被觸發時,通常會發生:
- 當前代碼狀態被保存
- 代碼執行被切換到預定義的異常處理器函數
- 根據情況,處理器也許會從保存的代碼狀態重新開始執行代碼,終止腳本執行,或從代碼中另外的位置繼續執行腳本
我們將展示不同的錯誤處理方法:
- 異常的基本使用
- 創建自定義的異常處理器
- 多個異常
- 重新拋出異常
- 設置頂層異常處理器
2.1、異常的基本使用
當異常被拋出時,其後的代碼不會繼續執行,PHP 會嘗試查找匹配的 "catch" 代碼塊。
如果異常沒有被捕獲,而且又沒用使用 set_exception_handler() 作相應的處理的話,那麽將發生一個嚴重的錯誤(致命錯誤),並且輸出 "Uncaught Exception" (未捕獲異常)的錯誤消息。
讓我們嘗試拋出一個異常,同時不去捕獲它:
<?php //create function with an exception function checkNum($number) { if($number>1) { throw new Exception("Value must be 1 or below"); } return true; } //trigger exception checkNum(2); ?>
上面的代碼會獲得類似這樣的一個錯誤:
Fatal error: Uncaught exception ‘Exception‘
with message ‘Value must be 1 or below‘ in C:\webfolder\test.php:6
Stack trace: #0 C:\webfolder\test.php(12):
checkNum(28) #1 {main} thrown in C:\webfolder\test.php on line 6
Try, throw 和 catch
要避免上面例子出現的錯誤,我們需要創建適當的代碼來處理異常。
正確的處理程序應當包括:
- Try - 使用異常的函數應該位於 "try" 代碼塊內。如果沒有觸發異常,則代碼將照常繼續執行。但是如果異常被觸發,會拋出一個異常。
- Throw - 這裏規定如何觸發異常。每一個 "throw" 必須對應至少一個 "catch"
- Catch - "catch" 代碼塊會捕獲異常,並創建一個包含異常信息的對象
讓我們觸發一個異常:
<?php //創建可拋出一個異常的函數 function checkNum($number) { if($number>1) { throw new Exception("Value must be 1 or below"); } return true; } //在 "try" 代碼塊中觸發異常 try { checkNum(2); //If the exception is thrown, this text will not be shown echo ‘If you see this, the number is 1 or below‘; } //捕獲異常 catch(Exception $e) { echo ‘Message: ‘ .$e->getMessage(); } ?>
上面代碼將獲得類似這樣一個錯誤:
Message: Value must be 1 or below
例子解釋:
上面的代碼拋出了一個異常,並捕獲了它:
- 創建 checkNum() 函數。它檢測數字是否大於 1。如果是,則拋出一個異常。
- 在 "try" 代碼塊中調用 checkNum() 函數。
- checkNum() 函數中的異常被拋出
- "catch" 代碼塊接收到該異常,並創建一個包含異常信息的對象 ($e)。
- 通過從這個 exception 對象調用 $e->getMessage(),輸出來自該異常的錯誤消息
不過,為了遵循“每個 throw 必須對應一個 catch”的原則,可以設置一個頂層的異常處理器來處理漏掉的錯誤。
2.2、創建一個自定義的 Exception 類
創建自定義的異常處理程序非常簡單。我們簡單地創建了一個專門的類,當 PHP 中發生異常時,可調用其函數。該類必須是 exception 類的一個擴展。
這個自定義的 exception 類繼承了 PHP 的 exception 類的所有屬性,您可向其添加自定義的函數。
我們開始創建 exception 類:
<?php class customException extends Exception { public function errorMessage() { //error message $errorMsg = ‘Error on line ‘.$this->getLine().‘ in ‘.$this->getFile() .‘: <b>‘.$this->getMessage().‘</b> is not a valid E-Mail address‘; return $errorMsg; } } $email = "[email protected]"; try { //check if if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE) { //throw exception if email is not valid throw new customException($email); } } catch (customException $e) { //display custom message echo $e->errorMessage(); } ?>
這個新的類是舊的 exception 類的副本,外加 errorMessage() 函數。正因為它是舊類的副本,因此它從舊類繼承了屬性和方法,我們可以使用 exception 類的方法,比如 getLine() 、 getFile() 以及 getMessage()。
例子解釋:
上面的代碼拋出了一個異常,並通過一個自定義的 exception 類來捕獲它:
- customException() 類是作為舊的 exception 類的一個擴展來創建的。這樣它就繼承了舊類的所有屬性和方法。
- 創建 errorMessage() 函數。如果 e-mail 地址不合法,則該函數返回一條錯誤消息
- 把 $email 變量設置為不合法的 e-mail 地址字符串
- 執行 "try" 代碼塊,由於 e-mail 地址不合法,因此拋出一個異常
- "catch" 代碼塊捕獲異常,並顯示錯誤消息
多個異常
可以為一段腳本使用多個異常,來檢測多種情況。
可以使用多個 if..else 代碼塊,或一個 switch 代碼塊,或者嵌套多個異常。這些異常能夠使用不同的 exception 類,並返回不同的錯誤消息:
<?php class customException extends Exception { public function errorMessage() { //error message $errorMsg = ‘Error on line ‘.$this->getLine().‘ in ‘.$this->getFile() .‘: <b>‘.$this->getMessage().‘</b> is not a valid E-Mail address‘; return $errorMsg; } } $email = "[email protected]"; try { //check if if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE) { //throw exception if email is not valid throw new customException($email); } //check for "example" in mail address if(strpos($email, "example") !== FALSE) { throw new Exception("$email is an example e-mail"); } } catch (customException $e) { echo $e->errorMessage(); } catch(Exception $e) { echo $e->getMessage(); } ?>
例子解釋:
上面的代碼測試了兩種條件,如何任何條件不成立,則拋出一個異常:
- customException() 類是作為舊的 exception 類的一個擴展來創建的。這樣它就繼承了舊類的所有屬性和方法。
- 創建 errorMessage() 函數。如果 e-mail 地址不合法,則該函數返回一個錯誤消息。
- 執行 "try" 代碼塊,在第一個條件下,不會拋出異常。
- 由於 e-mail 含有字符串 "example",第二個條件會觸發異常。
- "catch" 代碼塊會捕獲異常,並顯示恰當的錯誤消息
如果沒有捕獲 customException,緊緊捕獲了 base exception,則在那裏處理異常。
2.3、重新拋出異常
有時,當異常被拋出時,您也許希望以不同於標準的方式對它進行處理。可以在一個 "catch" 代碼塊中再次拋出異常。
腳本應該對用戶隱藏系統錯誤。對程序員來說,系統錯誤也許很重要,但是用戶對它們並不感興趣。為了讓用戶更容易使用,您可以再次拋出帶有對用戶比較友好的消息的異常:
<?php class customException extends Exception { public function errorMessage() { //error message $errorMsg = $this->getMessage().‘ is not a valid E-Mail address.‘; return $errorMsg; } } $email = "[email protected]"; try { try { //check for "example" in mail address if(strpos($email, "example") !== FALSE) { //throw exception if email is not valid throw new Exception($email); } } catch(Exception $e) { //re-throw exception throw new customException($email); } } catch (customException $e) { //display custom message echo $e->errorMessage(); } ?>
例子解釋:
上面的代碼檢測在郵件地址中是否含有字符串 "example"。如果有,則再次拋出異常:
- customException() 類是作為舊的 exception 類的一個擴展來創建的。這樣它就繼承了舊類的所有屬性和方法。
- 創建 errorMessage() 函數。如果 e-mail 地址不合法,則該函數返回一個錯誤消息。
- 把 $email 變量設置為一個有效的郵件地址,但含有字符串 "example"。
- "try" 代碼塊包含另一個 "try" 代碼塊,這樣就可以再次拋出異常。
- 由於 e-mail 包含字符串 "example",因此觸發異常。
- "catch" 捕獲到該異常,並重新拋出 "customException"。
- 捕獲到 "customException",並顯示一條錯誤消息。
如果在其目前的 "try" 代碼塊中異常沒有被捕獲,則它將在更高層級上查找 catch 代碼塊。
2.4、設置頂層異常處理器 (Top Level Exception Handler)
set_exception_handler() 函數可設置處理所有未捕獲異常的用戶定義函數。
<?php function myException($exception) { echo "<b>Exception:</b> " , $exception->getMessage(); } set_exception_handler(‘myException‘); throw new Exception(‘Uncaught Exception occurred‘); ?>
以上代碼的輸出應該類似這樣:
Exception: Uncaught Exception occurred
在上面的代碼中,不存在 "catch" 代碼塊,而是觸發頂層的異常處理程序。應該使用此函數來捕獲所有未被捕獲的異常。
異常的規則
- 需要進行異常處理的代碼應該放入 try 代碼塊內,以便捕獲潛在的異常。
- 每個 try 或 throw 代碼塊必須至少擁有一個對應的 catch 代碼塊。
- 使用多個 catch 代碼塊可以捕獲不同種類的異常。
- 可以在 try 代碼塊內的 catch 代碼塊中再次拋出(re-thrown)異常。
簡而言之:如果拋出了異常,就必須捕獲它。
【PHP基礎】PHP教程(錯誤處理、異常處理)