PHP教學-異常處理

PHP 異常處理

異常用於在指定的錯誤發生時改變scripts的正常流程。
異常是什麼

PHP 5 提供了一種新的物件導向的錯誤處理方法。

異常處理用於在指定的錯誤（異常）情況發生時改變scripts的正常流程。這種情況稱為異常。

當異常被觸發時，通常會發生：

    當前程式碼狀態被存檔
    程式碼執行被切換到預定義（自定義）的異常處理器函數
    根據情況，處理器也許會從存檔的程式碼狀態重新開始執行程式碼，終止scripts執行，或從程式碼中另外的位置繼續執行scripts

我們將展示不同的錯誤處理方法：

    異常的基本使用
    新增自定義的異常處理器
    多個異常
    重新拋出異常
    設置頂層異常處理器

註釋：異常應該僅僅在錯誤情況下使用，而不應該用於在一個指定的點跳轉到程式碼的另一個位置。
異常的基本使用

當異常被拋出時，其後的程式碼不會繼續執行，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:webfoldertest.php:6
Stack trace: #0 C:webfoldertest.php(12):
checkNum(28) #1 {main} thrown in C:webfoldertest.php on line 6
Try、throw 和 catch

要避免上面範例中出現的錯誤，我們需要新增適當的程式碼來處理異常。

適當的處理異常程式碼應該包括：

    Try - 使用異常的函數應該位於 "try" 程式碼塊內。如果沒有觸發異常，則程式碼將照常繼續執行。但是如果異常被觸發，會拋出一個異常。
    Throw - 裡規定如何觸發異常。每一個 "throw" 必須對應至少一個 "catch"。
    Catch - "catch" 程式碼塊會捕獲異常，並新增一個包含異常訊息的物件。

讓我們觸發一個異常：
<?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 in a "try" block
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
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" 的原則，可以設置一個頂層的異常處理器來處理漏掉的錯誤。
新增一個自定義的 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 = "someone@example...com";

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 類的一個擴展來新增的。這樣它就繼承了舊的 exception 類的所有屬性和方法。
    新增 errorMessage() 函數。如果 e-mail 地址不合法，則該函數返回一條錯誤消息。
    把 $email 變數設置為不合法的 e-mail 地址字串。
    執行 "try" 程式碼塊，由於 e-mail 地址不合法，因此拋出一個異常。
    "catch" 程式碼塊捕獲異常，並顯示錯誤消息。

多個異常

可以為一段scripts使用多個異常，來檢測多種情況。

可以使用多個 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 = "someone@example.com";

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 類的一個擴展來新增的。這樣它就繼承了舊的 exception 類的所有屬性和方法。
    新增 errorMessage() 函數。如果 e-mail 地址不合法，則該函數返回一個錯誤消息。
    把 $email 變數設置為一個字串，該字串是一個有效的 e-mail 地址，但包含字串 "example"。
    執行 "try" 程式碼塊，在第一個條件下，不會拋出異常。
    由於 e-mail 含有字串 "example"，第二個條件會觸發異常。
    "catch" 程式碼塊會捕獲異常，並顯示恰當的錯誤消息。

如果 customException 類拋出了異常，但沒有捕獲 customException，僅僅捕獲了 base exception，則在那裡處理異常。
重新拋出異常

有時，當異常被拋出時，您也許希望以不同於標準的方式對它進行處理。可以在一個 "catch" 程式碼塊中再次拋出異常。

scripts應該對用戶隱藏系統錯誤。對程式員來說，系統錯誤也許很重要，但是用戶對它們並不感興趣。為了讓用戶更容易使用，您可以再次拋出帶有對用戶比較友好的消息的異常：
<?php
class customException extends Exception
{
public function errorMessage()
{
//error message
$errorMsg = $this->getMessage().' is not a valid E-Mail address.';
return $errorMsg;
}
}

$email = "someone@example.com";

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 類的一個擴展來新增的。這樣它就繼承了舊的 exception 類的所有屬性和方法。
    新增 errorMessage() 函數。如果 e-mail 地址不合法，則該函數返回一個錯誤消息。
    把 $email 變數設置為一個字串，該字串是一個有效的 e-mail 地址，但包含字串 "example"。
    "try" 程式碼塊包含另一個 "try" 程式碼塊，這樣就可以再次拋出異常。
    由於 e-mail 包含字串 "example"，因此觸發異常。
    "catch" 程式碼塊捕獲到該異常，並重新拋出 "customException"。
    捕獲到 "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 程式碼塊中拋出（再次拋出）異常。

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