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/itread01/test/test.php:7 Stack trace: #0 /www/itread01/test/test.php(13): checkNum(2) #1 {main} thrown in /www/itread01/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

例項解釋：

上面的程式碼丟擲了一個異常，並捕獲了它：

  1. 建立 checkNum() 函式。它檢測數字是否大於 1。如果是，則丟擲一個異常。
  2. 在 "try" 程式碼塊中呼叫 checkNum() 函式。
  3. checkNum() 函式中的異常被丟擲。
  4. "catch" 程式碼塊接收到該異常，並建立一個包含異常資訊的物件 ($e)。
  5. 通過從這個 exception 物件呼叫 $e->getMessage()，輸出來自該異常的錯誤訊息。

然而，為了遵循 "每個 throw 必須對應一個 catch" 的原則，可以設定一個頂層的異常處理器來處理漏掉的錯誤。

建立一個自定義的 Exception 類

建立自定義的異常處理程式非常簡單。我們簡單地建立了一個專門的類，當 PHP 中發生異常時，可呼叫其函式。該類必須是 exception 類的一個擴充套件。

這個自定義的 customException 類繼承了 PHP 的 exception 類的所有屬性，您可向其新增自定義的函式。

我們開始建立 customException 類：

<?php class customException extends Exception { public function errorMessage() { // 錯誤資訊 $errorMsg = '錯誤行號 '.$this->getLine().' in '.$this->getFile() .': <b>'.$this->getMessage().'</b> 不是一個合法的 E-Mail 地址'; return $errorMsg; } } $email = "[email protected]"; 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 = "[email protected]"; 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 = "[email protected]"; 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" 程式碼塊，而是觸發頂層的異常處理程式。應該使用此函式來捕獲所有未被捕獲的異常。

異常的規則

  • 需要進行異常處理的程式碼應該放入 try 程式碼塊內，以便捕獲潛在的異常。
  • 每個 try 或 throw 程式碼塊必須至少擁有一個對應的 catch 程式碼塊。
  • 使用多個 catch 程式碼塊可以捕獲不同種類的異常。
  • 可以在 try 程式碼塊內的 catch 程式碼塊中丟擲（再次丟擲）異常。

簡而言之：如果丟擲了異常，就必須捕獲它。