PHP 例外處理
異常用於在指定的錯誤發生時改變腳本的正常流程。
異常是什麼
PHP 5 提供了一個新的物件導向的錯誤處理方法。
異常處理用於在指定的錯誤(異常)情況發生時改變腳本的正常流程。這種情況稱為異常。
當異常被觸發時,通常會發生:
• 當前程式碼狀態被儲存
• 程式碼執行被切換到預先定義(自訂)的例外處理器函數
• 根據情況,處理器也許會從已儲存的程式碼狀態重新開始執行程式碼,終止腳本執行,或從程式碼中另外的位置繼續執行腳本
我們將展示不同的錯誤處理方法:
• 異常的基本使用
• 建立自訂的例外處理器
• 多個例外
• 重新拋出例外
• 設定頂層異常處理器
註解:異常應該只在錯誤情況下使用,而不應該用於在一個指定的點跳到程式碼的另一個位置。
異常的基本使用
當異常被拋出時,其後的程式碼不會繼續執行,PHP 會嘗試尋找匹配的"catch" 程式碼區塊。
如果異常沒有被捕獲,而且又沒用使用set_exception_handler() 作相應的處理的話, 那麼將發生一個嚴重的錯誤(致命錯誤),並且輸出"Uncaught Exception" (未捕獲異常)的錯誤訊息。
讓我們試著拋出一個異常,同時不去捕獲它:
<?php // 创建一个有异常处理的函数 function checkNum($number) { if($number>1) { throw new Exception("Value must be 1 or below"); } return true; } // 触发异常 checkNum(2); ?>
上面的程式碼會得到類似這樣的一個錯誤:
Fatal error: Uncaught exception 'Exception' with message 'Value must be 1 or below'
in /www/php/test/test.php:7 Stack trace: #0 /www/php/test/test.php( 13): checkNum(2) #1 {main} thrown
in /www/php/test/test.php on line 7
Try、throw 和catch
要避免上面實例中出現的錯誤,我們需要建立適當的程式碼來處理例外狀況。
適當的處理例外程式碼應該包括:
1. Try - 使用例外的函數應該位於 "try" 程式碼區塊內。如果沒有觸發異常,則程式碼將照常繼續執行。但是如果異常被觸發,會拋出一個異常。
2. Throw - 裡規定如何觸發異常。每一個 "throw" 必須對應至少一個 "catch"。
3. Catch - "catch" 程式碼區塊會捕捉異常,並建立一個包含異常資訊的物件。
讓我們觸發一個例外:
<?php // 创建一个有异常处理的函数 function checkNum($number) { if($number>1) { throw new Exception("变量值必须小于等于 1"); } return true; } // 在 try 块 触发异常 try { checkNum(2); // 如果抛出异常,以下文本不会输出 echo '如果输出该内容,说明 $number 变量'; } // 捕获异常 catch(Exception $e) { echo 'Message: ' .$e->getMessage(); } ?>
上面程式碼將會得到類似這樣一個錯誤:
Message: 變數值必須小於等於1
實例解釋:
上面的程式碼拋出了一個異常,並捕獲了它:
建立 checkNum() 函數。它檢測數字是否大於 1。如果是,則拋出一個異常。
在 "try" 程式碼區塊中呼叫 checkNum() 函數。
checkNum() 函數中的例外被拋出。
"catch" 程式碼區塊接收到該異常,並建立一個包含異常訊息的物件 ($e)。
透過從這個 exception 物件呼叫 $e->getMessage(),輸出來自該異常的錯誤訊息。
然而,為了遵循 "每個 throw 必須對應一個 catch" 的原則,可以設定一個頂層的異常處理器來處理漏掉的錯誤。
建立一個自訂的 Exception 類別
#建立自訂的例外處理程序非常簡單。 我們簡單地創建了一個專門的類,當 PHP 中發生異常時,可呼叫其函數。 該類別必須是 exception 類別的一個擴充。
這個自訂的 exception 類別繼承了 PHP 的 exception 類別的所有屬性,您可以將自訂的函數新增至其。
我們開始建立 exception 類別:
<?php class customException extends Exception { public function errorMessage() { // 错误信息 $errorMsg = '错误行号 '.$this->getLine().' in '.$this->getFile() .': <b>'.$this->getMessage().'</b> 不是一个合法的 E-Mail 地址'; return $errorMsg; } } $email = "someone@example...com"; try { // 检测邮箱 if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE) { // 如果是个不合法的邮箱地址,抛出异常 throw new customException($email); } } catch (customException $e) { //display custom message echo $e->errorMessage(); } ?>
這個新的類別是舊的 exception 類別的副本,外加 errorMessage() 函式。 正因為它是舊類別的副本,因此它從舊類別繼承了屬性和方法,我們可以使用 exception 類別的方法, 例如 getLine()、getFile() 和 getMessage()。
實例解釋:
上面的程式碼拋出了一個異常,並透過一個自訂的exception 類別來捕獲它:
1. customException() 類別是作為舊的exception 類別的一個擴充來建立的。這樣它就繼承了舊的 exception 類別的所有屬性和方法。
2. 建立 errorMessage() 函數。如果 e-mail 位址不合法,則函數傳回錯誤訊息。
3. $email 變數設定為不合法的 e-mail 位址字串。
4. 執行 "try" 程式碼區塊,由於 e-mail 位址不合法,因此拋出一個例外。
5. "catch" 程式碼區塊擷取異常,並顯示錯誤訊息。
多個異常
可以為一段腳本使用多個異常,來偵測多種情況。
可以使用多個 if..else 程式碼區塊,或一個 switch 程式碼區塊,或嵌套多個例外。 這些異常能夠使用不同的exception 類,並傳回不同的錯誤訊息:
<?php class customException extends Exception { public function errorMessage() { // 错误信息 $errorMsg = '错误行号 '.$this->getLine().' in '.$this->getFile() .': <b>'.$this->getMessage().'</b> 不是一个合法的 E-Mail 地址'; return $errorMsg; } } $email = "someone@example.com"; try { // 检测邮箱 if(filter_var($email, FILTER_VALIDATE_EMAIL) === FALSE) { // 如果是个不合法的邮箱地址,抛出异常 throw new customException($email); } // 检测 "example" 是否在邮箱地址中 if(strpos($email, "example") !== FALSE) { throw new Exception("$email 是 example 邮箱"); } } catch (customException $e) { echo $e->errorMessage(); } catch(Exception $e) { echo $e->getMessage(); } ?>
#實例解釋:
上面的程式碼測試了兩種條件,如果其中任何一個條件不成立,則拋出一個例外:
1. customException() 類別是作為舊的exception 類別的一個擴充來建立的。這樣它就繼承了舊的 exception 類別的所有屬性和方法。
2. 建立 errorMessage() 函數。如果 e-mail 位址不合法,則函數傳回錯誤訊息。
3. 把 $email 變數設定為字串,字串是有效的 e-mail 位址,但包含字串 "example"。
4. 執行 "try" 程式碼區塊,在第一個條件下,不會拋出例外。
5. 由於 e-mail 含有字串 "example",第二個條件會觸發例外。
6. "catch" 程式碼區塊會捕捉異常,並顯示適當的錯誤訊息。
如果 customException 類別拋出了異常,但沒有捕獲 customException,僅捕獲了 base exception,則在那裡處理異常。
重新拋出例外
有時,當例外被拋出時,您也許希望以不同於標準的方式對它進行處理。可以在一個 "catch" 程式碼區塊中再次拋出異常。
腳本應該對使用者隱藏系統錯誤。對程式設計師來說,系統錯誤也許很重要,但是使用者對它們並不感興趣。 為了讓使用者更容易使用,您可以再次拋出帶有對使用者比較友善的訊息的例外:
<?php class customException extends Exception { public function errorMessage() { // 错误信息 $errorMsg = $this->getMessage().' 不是一个合法的 E-Mail 地址。'; return $errorMsg; } } $email = "someone@example.com"; try { try { // 检测 "example" 是否在邮箱地址中 if(strpos($email, "example") !== FALSE) { // 如果是个不合法的邮箱地址,抛出异常 throw new Exception($email); } } catch(Exception $e) { // 重新抛出异常 throw new customException($email); } } catch (customException $e) { // 显示自定义信息 echo $e->errorMessage(); } ?>
實例解釋:
##上面的程式碼偵測在郵件地址是否含有字串"example"。如果有,則再次拋出例外:1. customException() 類別是作為舊的 exception 類別的擴充功能來建立的。這樣它就繼承了舊的 exception 類別的所有屬性和方法。 2. 建立 errorMessage() 函數。如果 e-mail 位址不合法,則函數傳回錯誤訊息。 3. 把 $email 變數設定為字串,字串是有效的 e-mail 位址,但包含字串 "example"。 4. "try" 程式碼區塊包含另一個 "try" 程式碼區塊,這樣就可以再次拋出例外。 5. 由於 e-mail 包含字串 "example",因此觸發例外。 6. "catch" 程式碼區塊捕獲到該異常,並重新拋出 "customException"。 7. 捕獲到 "customException",並顯示錯誤訊息。 如果在目前的 "try" 程式碼區塊中異常沒有被捕獲,則它將在更高層級上尋找 catch 程式碼區塊。設定頂層例外處理器
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" 程式碼塊,而是觸發頂層的異常處理程序。應該使用此函數來捕獲所有未被捕獲的異常。異常的規則
1. 需要異常處理的程式碼應該放入try 程式碼區塊內,以便捕捉潛在的異常。 2. 每個 try 或 throw 程式碼區塊必須至少擁有一個對應的 catch 程式碼區塊。 3. 使用多個 catch 程式碼區塊可以捕捉不同種類的例外。 4. 可以在 try 程式碼區塊內的 catch 程式碼區塊中拋出(再次拋出)例外。 簡而言之:如果拋出了異常,就必須捕獲它。